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 // Hide compatibility functions from Doxygen
31 * Compatibility functions
33 * We support PHP 5.3.3 and up.
34 * Re-implementations of newer functions or functions in non-standard
35 * PHP extensions may be included here.
38 if ( !function_exists( 'mb_substr' ) ) {
41 * @see Fallback::mb_substr
44 function mb_substr( $str, $start, $count = 'end' ) {
45 return Fallback
::mb_substr( $str, $start, $count );
50 * @see Fallback::mb_substr_split_unicode
53 function mb_substr_split_unicode( $str, $splitPos ) {
54 return Fallback
::mb_substr_split_unicode( $str, $splitPos );
58 if ( !function_exists( 'mb_strlen' ) ) {
61 * @see Fallback::mb_strlen
64 function mb_strlen( $str, $enc = '' ) {
65 return Fallback
::mb_strlen( $str, $enc );
69 if ( !function_exists( 'mb_strpos' ) ) {
72 * @see Fallback::mb_strpos
75 function mb_strpos( $haystack, $needle, $offset = 0, $encoding = '' ) {
76 return Fallback
::mb_strpos( $haystack, $needle, $offset, $encoding );
80 if ( !function_exists( 'mb_strrpos' ) ) {
83 * @see Fallback::mb_strrpos
86 function mb_strrpos( $haystack, $needle, $offset = 0, $encoding = '' ) {
87 return Fallback
::mb_strrpos( $haystack, $needle, $offset, $encoding );
91 // gzdecode function only exists in PHP >= 5.4.0
92 // http://php.net/gzdecode
93 if ( !function_exists( 'gzdecode' ) ) {
99 function gzdecode( $data ) {
100 return gzinflate( substr( $data, 10, -8 ) );
104 // hash_equals function only exists in PHP >= 5.6.0
105 // http://php.net/hash_equals
106 if ( !function_exists( 'hash_equals' ) ) {
108 * Check whether a user-provided string is equal to a fixed-length secret string
109 * without revealing bytes of the secret string through timing differences.
111 * The usual way to compare strings (PHP's === operator or the underlying memcmp()
112 * function in C) is to compare corresponding bytes and stop at the first difference,
113 * which would take longer for a partial match than for a complete mismatch. This
114 * is not secure when one of the strings (e.g. an HMAC or token) must remain secret
115 * and the other may come from an attacker. Statistical analysis of timing measurements
116 * over many requests may allow the attacker to guess the string's bytes one at a time
117 * (and check his guesses) even if the timing differences are extremely small.
119 * When making such a security-sensitive comparison, it is essential that the sequence
120 * in which instructions are executed and memory locations are accessed not depend on
121 * the secret string's value. HOWEVER, for simplicity, we do not attempt to minimize
122 * the inevitable leakage of the string's length. That is generally known anyway as
123 * a chararacteristic of the hash function used to compute the secret value.
125 * Longer explanation: http://www.emerose.com/timing-attacks-explained
127 * @codeCoverageIgnore
128 * @param string $known_string Fixed-length secret string to compare against
129 * @param string $user_string User-provided string
130 * @return bool True if the strings are the same, false otherwise
132 function hash_equals( $known_string, $user_string ) {
133 // Strict type checking as in PHP's native implementation
134 if ( !is_string( $known_string ) ) {
135 trigger_error( 'hash_equals(): Expected known_string to be a string, ' .
136 gettype( $known_string ) . ' given', E_USER_WARNING
);
141 if ( !is_string( $user_string ) ) {
142 trigger_error( 'hash_equals(): Expected user_string to be a string, ' .
143 gettype( $user_string ) . ' given', E_USER_WARNING
);
148 $known_string_len = strlen( $known_string );
149 if ( $known_string_len !== strlen( $user_string ) ) {
154 for ( $i = 0; $i < $known_string_len; $i++
) {
155 $result |
= ord( $known_string[$i] ) ^
ord( $user_string[$i] );
158 return ( $result === 0 );
164 * Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
169 function wfArrayDiff2( $a, $b ) {
170 return array_udiff( $a, $b, 'wfArrayDiff2_cmp' );
174 * @param array|string $a
175 * @param array|string $b
178 function wfArrayDiff2_cmp( $a, $b ) {
179 if ( is_string( $a ) && is_string( $b ) ) {
180 return strcmp( $a, $b );
181 } elseif ( count( $a ) !== count( $b ) ) {
182 return count( $a ) < count( $b ) ?
-1 : 1;
186 while ( ( list( , $valueA ) = each( $a ) ) && ( list( , $valueB ) = each( $b ) ) ) {
187 $cmp = strcmp( $valueA, $valueB );
197 * Appends to second array if $value differs from that in $default
199 * @param string|int $key
200 * @param mixed $value
201 * @param mixed $default
202 * @param array $changed Array to alter
203 * @throws MWException
205 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
206 if ( is_null( $changed ) ) {
207 throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' );
209 if ( $default[$key] !== $value ) {
210 $changed[$key] = $value;
215 * Merge arrays in the style of getUserPermissionsErrors, with duplicate removal
217 * wfMergeErrorArrays(
218 * array( array( 'x' ) ),
219 * array( array( 'x', '2' ) ),
220 * array( array( 'x' ) ),
221 * array( array( 'y' ) )
230 * @param array $array1,...
233 function wfMergeErrorArrays( /*...*/ ) {
234 $args = func_get_args();
236 foreach ( $args as $errors ) {
237 foreach ( $errors as $params ) {
238 # @todo FIXME: Sometimes get nested arrays for $params,
239 # which leads to E_NOTICEs
240 $spec = implode( "\t", $params );
241 $out[$spec] = $params;
244 return array_values( $out );
248 * Insert array into another array after the specified *KEY*
250 * @param array $array The array.
251 * @param array $insert The array to insert.
252 * @param mixed $after The key to insert after
255 function wfArrayInsertAfter( array $array, array $insert, $after ) {
256 // Find the offset of the element to insert after.
257 $keys = array_keys( $array );
258 $offsetByKey = array_flip( $keys );
260 $offset = $offsetByKey[$after];
262 // Insert at the specified offset
263 $before = array_slice( $array, 0, $offset +
1, true );
264 $after = array_slice( $array, $offset +
1, count( $array ) - $offset, true );
266 $output = $before +
$insert +
$after;
272 * Recursively converts the parameter (an object) to an array with the same data
274 * @param object|array $objOrArray
275 * @param bool $recursive
278 function wfObjectToArray( $objOrArray, $recursive = true ) {
280 if ( is_object( $objOrArray ) ) {
281 $objOrArray = get_object_vars( $objOrArray );
283 foreach ( $objOrArray as $key => $value ) {
284 if ( $recursive && ( is_object( $value ) ||
is_array( $value ) ) ) {
285 $value = wfObjectToArray( $value );
288 $array[$key] = $value;
295 * Get a random decimal value between 0 and 1, in a way
296 * not likely to give duplicate values for any realistic
297 * number of articles.
301 function wfRandom() {
302 # The maximum random value is "only" 2^31-1, so get two random
303 # values to reduce the chance of dupes
304 $max = mt_getrandmax() +
1;
305 $rand = number_format( ( mt_rand() * $max +
mt_rand() ) / $max / $max, 12, '.', '' );
311 * Get a random string containing a number of pseudo-random hex
313 * @note This is not secure, if you are trying to generate some sort
314 * of token please use MWCryptRand instead.
316 * @param int $length The length of the string to generate
320 function wfRandomString( $length = 32 ) {
322 for ( $n = 0; $n < $length; $n +
= 7 ) {
323 $str .= sprintf( '%07x', mt_rand() & 0xfffffff );
325 return substr( $str, 0, $length );
329 * We want some things to be included as literal characters in our title URLs
330 * for prettiness, which urlencode encodes by default. According to RFC 1738,
331 * all of the following should be safe:
335 * But + is not safe because it's used to indicate a space; &= are only safe in
336 * paths and not in queries (and we don't distinguish here); ' seems kind of
337 * scary; and urlencode() doesn't touch -_. to begin with. Plus, although /
338 * is reserved, we don't care. So the list we unescape is:
342 * However, IIS7 redirects fail when the url contains a colon (Bug 22709),
343 * so no fancy : for IIS7.
345 * %2F in the page titles seems to fatally break for some reason.
350 function wfUrlencode( $s ) {
353 if ( is_null( $s ) ) {
358 if ( is_null( $needle ) ) {
359 $needle = array( '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F' );
360 if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) ||
361 ( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false )
367 $s = urlencode( $s );
370 array( ';', '@', '$', '!', '*', '(', ')', ',', '/', ':' ),
378 * This function takes two arrays as input, and returns a CGI-style string, e.g.
379 * "days=7&limit=100". Options in the first array override options in the second.
380 * Options set to null or false will not be output.
382 * @param array $array1 ( String|Array )
383 * @param array $array2 ( String|Array )
384 * @param string $prefix
387 function wfArrayToCgi( $array1, $array2 = null, $prefix = '' ) {
388 if ( !is_null( $array2 ) ) {
389 $array1 = $array1 +
$array2;
393 foreach ( $array1 as $key => $value ) {
394 if ( !is_null( $value ) && $value !== false ) {
398 if ( $prefix !== '' ) {
399 $key = $prefix . "[$key]";
401 if ( is_array( $value ) ) {
403 foreach ( $value as $k => $v ) {
404 $cgi .= $firstTime ?
'' : '&';
405 if ( is_array( $v ) ) {
406 $cgi .= wfArrayToCgi( $v, null, $key . "[$k]" );
408 $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v );
413 if ( is_object( $value ) ) {
414 $value = $value->__toString();
416 $cgi .= urlencode( $key ) . '=' . urlencode( $value );
424 * This is the logical opposite of wfArrayToCgi(): it accepts a query string as
425 * its argument and returns the same string in array form. This allows compatibility
426 * with legacy functions that accept raw query strings instead of nice
427 * arrays. Of course, keys and values are urldecode()d.
429 * @param string $query Query string
430 * @return string[] Array version of input
432 function wfCgiToArray( $query ) {
433 if ( isset( $query[0] ) && $query[0] == '?' ) {
434 $query = substr( $query, 1 );
436 $bits = explode( '&', $query );
438 foreach ( $bits as $bit ) {
442 if ( strpos( $bit, '=' ) === false ) {
443 // Pieces like &qwerty become 'qwerty' => '' (at least this is what php does)
447 list( $key, $value ) = explode( '=', $bit );
449 $key = urldecode( $key );
450 $value = urldecode( $value );
451 if ( strpos( $key, '[' ) !== false ) {
452 $keys = array_reverse( explode( '[', $key ) );
453 $key = array_pop( $keys );
455 foreach ( $keys as $k ) {
456 $k = substr( $k, 0, -1 );
457 $temp = array( $k => $temp );
459 if ( isset( $ret[$key] ) ) {
460 $ret[$key] = array_merge( $ret[$key], $temp );
472 * Append a query string to an existing URL, which may or may not already
473 * have query string parameters already. If so, they will be combined.
476 * @param string|string[] $query String or associative array
479 function wfAppendQuery( $url, $query ) {
480 if ( is_array( $query ) ) {
481 $query = wfArrayToCgi( $query );
483 if ( $query != '' ) {
484 if ( false === strpos( $url, '?' ) ) {
495 * Expand a potentially local URL to a fully-qualified URL. Assumes $wgServer
498 * The meaning of the PROTO_* constants is as follows:
499 * PROTO_HTTP: Output a URL starting with http://
500 * PROTO_HTTPS: Output a URL starting with https://
501 * PROTO_RELATIVE: Output a URL starting with // (protocol-relative URL)
502 * PROTO_CURRENT: Output a URL starting with either http:// or https:// , depending
503 * on which protocol was used for the current incoming request
504 * PROTO_CANONICAL: For URLs without a domain, like /w/index.php , use $wgCanonicalServer.
505 * For protocol-relative URLs, use the protocol of $wgCanonicalServer
506 * PROTO_INTERNAL: Like PROTO_CANONICAL, but uses $wgInternalServer instead of $wgCanonicalServer
508 * @todo this won't work with current-path-relative URLs
509 * like "subdir/foo.html", etc.
511 * @param string $url Either fully-qualified or a local path + query
512 * @param string $defaultProto One of the PROTO_* constants. Determines the
513 * protocol to use if $url or $wgServer is protocol-relative
514 * @return string Fully-qualified URL, current-path-relative URL or false if
515 * no valid URL can be constructed
517 function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT
) {
518 global $wgServer, $wgCanonicalServer, $wgInternalServer, $wgRequest,
520 if ( $defaultProto === PROTO_CANONICAL
) {
521 $serverUrl = $wgCanonicalServer;
522 } elseif ( $defaultProto === PROTO_INTERNAL
&& $wgInternalServer !== false ) {
523 // Make $wgInternalServer fall back to $wgServer if not set
524 $serverUrl = $wgInternalServer;
526 $serverUrl = $wgServer;
527 if ( $defaultProto === PROTO_CURRENT
) {
528 $defaultProto = $wgRequest->getProtocol() . '://';
532 // Analyze $serverUrl to obtain its protocol
533 $bits = wfParseUrl( $serverUrl );
534 $serverHasProto = $bits && $bits['scheme'] != '';
536 if ( $defaultProto === PROTO_CANONICAL ||
$defaultProto === PROTO_INTERNAL
) {
537 if ( $serverHasProto ) {
538 $defaultProto = $bits['scheme'] . '://';
540 // $wgCanonicalServer or $wgInternalServer doesn't have a protocol.
541 // This really isn't supposed to happen. Fall back to HTTP in this
543 $defaultProto = PROTO_HTTP
;
547 $defaultProtoWithoutSlashes = substr( $defaultProto, 0, -2 );
549 if ( substr( $url, 0, 2 ) == '//' ) {
550 $url = $defaultProtoWithoutSlashes . $url;
551 } elseif ( substr( $url, 0, 1 ) == '/' ) {
552 // If $serverUrl is protocol-relative, prepend $defaultProtoWithoutSlashes,
553 // otherwise leave it alone.
554 $url = ( $serverHasProto ?
'' : $defaultProtoWithoutSlashes ) . $serverUrl . $url;
557 $bits = wfParseUrl( $url );
559 // ensure proper port for HTTPS arrives in URL
560 // https://bugzilla.wikimedia.org/show_bug.cgi?id=65184
561 if ( $defaultProto === PROTO_HTTPS
&& $wgHttpsPort != 443 ) {
562 $bits['port'] = $wgHttpsPort;
565 if ( $bits && isset( $bits['path'] ) ) {
566 $bits['path'] = wfRemoveDotSegments( $bits['path'] );
567 return wfAssembleUrl( $bits );
571 } elseif ( substr( $url, 0, 1 ) != '/' ) {
572 # URL is a relative path
573 return wfRemoveDotSegments( $url );
576 # Expanded URL is not valid.
581 * This function will reassemble a URL parsed with wfParseURL. This is useful
582 * if you need to edit part of a URL and put it back together.
584 * This is the basic structure used (brackets contain keys for $urlParts):
585 * [scheme][delimiter][user]:[pass]@[host]:[port][path]?[query]#[fragment]
587 * @todo Need to integrate this into wfExpandUrl (bug 32168)
590 * @param array $urlParts URL parts, as output from wfParseUrl
591 * @return string URL assembled from its component parts
593 function wfAssembleUrl( $urlParts ) {
596 if ( isset( $urlParts['delimiter'] ) ) {
597 if ( isset( $urlParts['scheme'] ) ) {
598 $result .= $urlParts['scheme'];
601 $result .= $urlParts['delimiter'];
604 if ( isset( $urlParts['host'] ) ) {
605 if ( isset( $urlParts['user'] ) ) {
606 $result .= $urlParts['user'];
607 if ( isset( $urlParts['pass'] ) ) {
608 $result .= ':' . $urlParts['pass'];
613 $result .= $urlParts['host'];
615 if ( isset( $urlParts['port'] ) ) {
616 $result .= ':' . $urlParts['port'];
620 if ( isset( $urlParts['path'] ) ) {
621 $result .= $urlParts['path'];
624 if ( isset( $urlParts['query'] ) ) {
625 $result .= '?' . $urlParts['query'];
628 if ( isset( $urlParts['fragment'] ) ) {
629 $result .= '#' . $urlParts['fragment'];
636 * Remove all dot-segments in the provided URL path. For example,
637 * '/a/./b/../c/' becomes '/a/c/'. For details on the algorithm, please see
638 * RFC3986 section 5.2.4.
640 * @todo Need to integrate this into wfExpandUrl (bug 32168)
642 * @param string $urlPath URL path, potentially containing dot-segments
643 * @return string URL path with all dot-segments removed
645 function wfRemoveDotSegments( $urlPath ) {
648 $inputLength = strlen( $urlPath );
650 while ( $inputOffset < $inputLength ) {
651 $prefixLengthOne = substr( $urlPath, $inputOffset, 1 );
652 $prefixLengthTwo = substr( $urlPath, $inputOffset, 2 );
653 $prefixLengthThree = substr( $urlPath, $inputOffset, 3 );
654 $prefixLengthFour = substr( $urlPath, $inputOffset, 4 );
657 if ( $prefixLengthTwo == './' ) {
658 # Step A, remove leading "./"
660 } elseif ( $prefixLengthThree == '../' ) {
661 # Step A, remove leading "../"
663 } elseif ( ( $prefixLengthTwo == '/.' ) && ( $inputOffset +
2 == $inputLength ) ) {
664 # Step B, replace leading "/.$" with "/"
666 $urlPath[$inputOffset] = '/';
667 } elseif ( $prefixLengthThree == '/./' ) {
668 # Step B, replace leading "/./" with "/"
670 } elseif ( $prefixLengthThree == '/..' && ( $inputOffset +
3 == $inputLength ) ) {
671 # Step C, replace leading "/..$" with "/" and
672 # remove last path component in output
674 $urlPath[$inputOffset] = '/';
676 } elseif ( $prefixLengthFour == '/../' ) {
677 # Step C, replace leading "/../" with "/" and
678 # remove last path component in output
681 } elseif ( ( $prefixLengthOne == '.' ) && ( $inputOffset +
1 == $inputLength ) ) {
682 # Step D, remove "^.$"
684 } elseif ( ( $prefixLengthTwo == '..' ) && ( $inputOffset +
2 == $inputLength ) ) {
685 # Step D, remove "^..$"
688 # Step E, move leading path segment to output
689 if ( $prefixLengthOne == '/' ) {
690 $slashPos = strpos( $urlPath, '/', $inputOffset +
1 );
692 $slashPos = strpos( $urlPath, '/', $inputOffset );
694 if ( $slashPos === false ) {
695 $output .= substr( $urlPath, $inputOffset );
696 $inputOffset = $inputLength;
698 $output .= substr( $urlPath, $inputOffset, $slashPos - $inputOffset );
699 $inputOffset +
= $slashPos - $inputOffset;
704 $slashPos = strrpos( $output, '/' );
705 if ( $slashPos === false ) {
708 $output = substr( $output, 0, $slashPos );
717 * Returns a regular expression of url protocols
719 * @param bool $includeProtocolRelative If false, remove '//' from the returned protocol list.
720 * DO NOT USE this directly, use wfUrlProtocolsWithoutProtRel() instead
723 function wfUrlProtocols( $includeProtocolRelative = true ) {
724 global $wgUrlProtocols;
726 // Cache return values separately based on $includeProtocolRelative
727 static $withProtRel = null, $withoutProtRel = null;
728 $cachedValue = $includeProtocolRelative ?
$withProtRel : $withoutProtRel;
729 if ( !is_null( $cachedValue ) ) {
733 // Support old-style $wgUrlProtocols strings, for backwards compatibility
734 // with LocalSettings files from 1.5
735 if ( is_array( $wgUrlProtocols ) ) {
736 $protocols = array();
737 foreach ( $wgUrlProtocols as $protocol ) {
738 // Filter out '//' if !$includeProtocolRelative
739 if ( $includeProtocolRelative ||
$protocol !== '//' ) {
740 $protocols[] = preg_quote( $protocol, '/' );
744 $retval = implode( '|', $protocols );
746 // Ignore $includeProtocolRelative in this case
747 // This case exists for pre-1.6 compatibility, and we can safely assume
748 // that '//' won't appear in a pre-1.6 config because protocol-relative
749 // URLs weren't supported until 1.18
750 $retval = $wgUrlProtocols;
753 // Cache return value
754 if ( $includeProtocolRelative ) {
755 $withProtRel = $retval;
757 $withoutProtRel = $retval;
763 * Like wfUrlProtocols(), but excludes '//' from the protocol list. Use this if
764 * you need a regex that matches all URL protocols but does not match protocol-
768 function wfUrlProtocolsWithoutProtRel() {
769 return wfUrlProtocols( false );
773 * parse_url() work-alike, but non-broken. Differences:
775 * 1) Does not raise warnings on bad URLs (just returns false).
776 * 2) Handles protocols that don't use :// (e.g., mailto: and news:, as well as
777 * protocol-relative URLs) correctly.
778 * 3) Adds a "delimiter" element to the array, either '://', ':' or '//' (see (2)).
780 * @param string $url A URL to parse
781 * @return string[] Bits of the URL in an associative array, per PHP docs
783 function wfParseUrl( $url ) {
784 global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
786 // Protocol-relative URLs are handled really badly by parse_url(). It's so
787 // bad that the easiest way to handle them is to just prepend 'http:' and
788 // strip the protocol out later.
789 $wasRelative = substr( $url, 0, 2 ) == '//';
790 if ( $wasRelative ) {
793 wfSuppressWarnings();
794 $bits = parse_url( $url );
796 // parse_url() returns an array without scheme for some invalid URLs, e.g.
797 // parse_url("%0Ahttp://example.com") == array( 'host' => '%0Ahttp', 'path' => 'example.com' )
798 if ( !$bits ||
!isset( $bits['scheme'] ) ) {
802 // parse_url() incorrectly handles schemes case-sensitively. Convert it to lowercase.
803 $bits['scheme'] = strtolower( $bits['scheme'] );
805 // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
806 if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
807 $bits['delimiter'] = '://';
808 } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
809 $bits['delimiter'] = ':';
810 // parse_url detects for news: and mailto: the host part of an url as path
811 // We have to correct this wrong detection
812 if ( isset( $bits['path'] ) ) {
813 $bits['host'] = $bits['path'];
820 /* Provide an empty host for eg. file:/// urls (see bug 28627) */
821 if ( !isset( $bits['host'] ) ) {
825 if ( isset( $bits['path'] ) ) {
826 /* parse_url loses the third / for file:///c:/ urls (but not on variants) */
827 if ( substr( $bits['path'], 0, 1 ) !== '/' ) {
828 $bits['path'] = '/' . $bits['path'];
835 // If the URL was protocol-relative, fix scheme and delimiter
836 if ( $wasRelative ) {
837 $bits['scheme'] = '';
838 $bits['delimiter'] = '//';
844 * Take a URL, make sure it's expanded to fully qualified, and replace any
845 * encoded non-ASCII Unicode characters with their UTF-8 original forms
846 * for more compact display and legibility for local audiences.
848 * @todo handle punycode domains too
853 function wfExpandIRI( $url ) {
854 return preg_replace_callback(
855 '/((?:%[89A-F][0-9A-F])+)/i',
856 'wfExpandIRI_callback',
862 * Private callback for wfExpandIRI
863 * @param array $matches
866 function wfExpandIRI_callback( $matches ) {
867 return urldecode( $matches[1] );
871 * Make URL indexes, appropriate for the el_index field of externallinks.
876 function wfMakeUrlIndexes( $url ) {
877 $bits = wfParseUrl( $url );
879 // Reverse the labels in the hostname, convert to lower case
880 // For emails reverse domainpart only
881 if ( $bits['scheme'] == 'mailto' ) {
882 $mailparts = explode( '@', $bits['host'], 2 );
883 if ( count( $mailparts ) === 2 ) {
884 $domainpart = strtolower( implode( '.', array_reverse( explode( '.', $mailparts[1] ) ) ) );
886 // No domain specified, don't mangle it
889 $reversedHost = $domainpart . '@' . $mailparts[0];
891 $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) );
893 // Add an extra dot to the end
894 // Why? Is it in wrong place in mailto links?
895 if ( substr( $reversedHost, -1, 1 ) !== '.' ) {
896 $reversedHost .= '.';
898 // Reconstruct the pseudo-URL
899 $prot = $bits['scheme'];
900 $index = $prot . $bits['delimiter'] . $reversedHost;
901 // Leave out user and password. Add the port, path, query and fragment
902 if ( isset( $bits['port'] ) ) {
903 $index .= ':' . $bits['port'];
905 if ( isset( $bits['path'] ) ) {
906 $index .= $bits['path'];
910 if ( isset( $bits['query'] ) ) {
911 $index .= '?' . $bits['query'];
913 if ( isset( $bits['fragment'] ) ) {
914 $index .= '#' . $bits['fragment'];
918 return array( "http:$index", "https:$index" );
920 return array( $index );
925 * Check whether a given URL has a domain that occurs in a given set of domains
926 * @param string $url URL
927 * @param array $domains Array of domains (strings)
928 * @return bool True if the host part of $url ends in one of the strings in $domains
930 function wfMatchesDomainList( $url, $domains ) {
931 $bits = wfParseUrl( $url );
932 if ( is_array( $bits ) && isset( $bits['host'] ) ) {
933 $host = '.' . $bits['host'];
934 foreach ( (array)$domains as $domain ) {
935 $domain = '.' . $domain;
936 if ( substr( $host, -strlen( $domain ) ) === $domain ) {
945 * Sends a line to the debug log if enabled or, optionally, to a comment in output.
946 * In normal operation this is a NOP.
948 * Controlling globals:
949 * $wgDebugLogFile - points to the log file
950 * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
951 * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
953 * @since 1.25 support for additional context data
955 * @param string $text
956 * @param string|bool $dest Destination of the message:
957 * - 'all': both to the log and HTML (debug toolbar or HTML comments)
958 * - 'log': only to the log and not in HTML
959 * For backward compatibility, it can also take a boolean:
960 * - true: same as 'all'
961 * - false: same as 'log'
962 * @param array $context Additional logging context data
964 function wfDebug( $text, $dest = 'all', array $context = array() ) {
965 global $wgDebugRawPage, $wgDebugLogPrefix;
966 global $wgDebugTimestamps, $wgRequestTime;
968 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
972 // Turn $dest into a string if it's a boolean (for b/c)
973 if ( $dest === true ) {
975 } elseif ( $dest === false ) {
979 $text = trim( $text );
981 // Inline logic from deprecated wfDebugTimer()
982 if ( $wgDebugTimestamps ) {
983 $context['seconds_elapsed'] = sprintf(
985 microtime( true ) - $wgRequestTime
987 $context['memory_used'] = sprintf(
989 ( memory_get_usage( true ) / ( 1024 * 1024 ) )
993 if ( $dest === 'all' ) {
995 if ( $wgDebugTimestamps ) {
996 // Prepend elapsed request time and real memory usage with two
998 $prefix = "{$context['seconds_elapsed']} {$context['memory_used']} ";
1000 MWDebug
::debugMsg( "{$prefix}{$text}" );
1003 if ( $wgDebugLogPrefix !== '' ) {
1004 $context['prefix'] = $wgDebugLogPrefix;
1007 $logger = MWLogger
::getInstance( 'wfDebug' );
1008 $logger->debug( $text, $context );
1012 * Returns true if debug logging should be suppressed if $wgDebugRawPage = false
1015 function wfIsDebugRawPage() {
1017 if ( $cache !== null ) {
1020 # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
1021 if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
1023 isset( $_SERVER['SCRIPT_NAME'] )
1024 && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
1035 * Get microsecond timestamps for debug logs
1037 * @deprecated since 1.25
1040 function wfDebugTimer() {
1041 global $wgDebugTimestamps, $wgRequestTime;
1043 wfDeprecated( __METHOD__
, '1.25' );
1045 if ( !$wgDebugTimestamps ) {
1049 $prefix = sprintf( "%6.4f", microtime( true ) - $wgRequestTime );
1050 $mem = sprintf( "%5.1fM", ( memory_get_usage( true ) / ( 1024 * 1024 ) ) );
1051 return "$prefix $mem ";
1055 * Send a line giving PHP memory usage.
1057 * @param bool $exact Print exact byte values instead of kibibytes (default: false)
1059 function wfDebugMem( $exact = false ) {
1060 $mem = memory_get_usage();
1062 $mem = floor( $mem / 1024 ) . ' KiB';
1066 wfDebug( "Memory usage: $mem\n" );
1070 * Send a line to a supplementary debug log file, if configured, or main debug
1073 * To configure a supplementary log file, set $wgDebugLogGroups[$logGroup] to
1074 * a string filename or an associative array mapping 'destination' to the
1075 * desired filename. The associative array may also contain a 'sample' key
1076 * with an integer value, specifying a sampling factor. Sampled log events
1077 * will be emitted with a 1 in N random chance.
1079 * @since 1.23 support for sampling log messages via $wgDebugLogGroups.
1080 * @since 1.25 support for additional context data
1081 * @since 1.25 sample behavior dependent on configured $wgMWLoggerDefaultSpi
1083 * @param string $logGroup
1084 * @param string $text
1085 * @param string|bool $dest Destination of the message:
1086 * - 'all': both to the log and HTML (debug toolbar or HTML comments)
1087 * - 'log': only to the log and not in HTML
1088 * - 'private': only to the specific log if set in $wgDebugLogGroups and
1089 * discarded otherwise
1090 * For backward compatibility, it can also take a boolean:
1091 * - true: same as 'all'
1092 * - false: same as 'private'
1093 * @param array $context Additional logging context data
1095 function wfDebugLog(
1096 $logGroup, $text, $dest = 'all', array $context = array()
1098 // Turn $dest into a string if it's a boolean (for b/c)
1099 if ( $dest === true ) {
1101 } elseif ( $dest === false ) {
1105 $text = trim( $text );
1107 if ( $dest === 'all' ) {
1108 MWDebug
::debugMsg( "[{$logGroup}] {$text}\n" );
1111 $logger = MWLogger
::getInstance( $logGroup );
1112 $context['private'] = ( $dest === 'private' );
1113 $logger->info( $text, $context );
1117 * Log for database errors
1119 * @since 1.25 support for additional context data
1121 * @param string $text Database error message.
1122 * @param array $context Additional logging context data
1124 function wfLogDBError( $text, array $context = array() ) {
1125 $logger = MWLogger
::getInstance( 'wfLogDBError' );
1126 $logger->error( trim( $text ), $context );
1130 * Throws a warning that $function is deprecated
1132 * @param string $function
1133 * @param string|bool $version Version of MediaWiki that the function
1134 * was deprecated in (Added in 1.19).
1135 * @param string|bool $component Added in 1.19.
1136 * @param int $callerOffset How far up the call stack is the original
1137 * caller. 2 = function that called the function that called
1138 * wfDeprecated (Added in 1.20)
1142 function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) {
1143 MWDebug
::deprecated( $function, $version, $component, $callerOffset +
1 );
1147 * Send a warning either to the debug log or in a PHP error depending on
1148 * $wgDevelopmentWarnings. To log warnings in production, use wfLogWarning() instead.
1150 * @param string $msg Message to send
1151 * @param int $callerOffset Number of items to go back in the backtrace to
1152 * find the correct caller (1 = function calling wfWarn, ...)
1153 * @param int $level PHP error level; defaults to E_USER_NOTICE;
1154 * only used when $wgDevelopmentWarnings is true
1156 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE
) {
1157 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'auto' );
1161 * Send a warning as a PHP error and the debug log. This is intended for logging
1162 * warnings in production. For logging development warnings, use WfWarn instead.
1164 * @param string $msg Message to send
1165 * @param int $callerOffset Number of items to go back in the backtrace to
1166 * find the correct caller (1 = function calling wfLogWarning, ...)
1167 * @param int $level PHP error level; defaults to E_USER_WARNING
1169 function wfLogWarning( $msg, $callerOffset = 1, $level = E_USER_WARNING
) {
1170 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'production' );
1174 * Log to a file without getting "file size exceeded" signals.
1176 * Can also log to TCP or UDP with the syntax udp://host:port/prefix. This will
1177 * send lines to the specified port, prefixed by the specified prefix and a space.
1178 * @since 1.25 support for additional context data
1180 * @param string $text
1181 * @param string $file Filename
1182 * @param array $context Additional logging context data
1183 * @throws MWException
1184 * @deprecated since 1.25 Use MWLoggerLegacyLogger::emit or UDPTransport
1186 function wfErrorLog( $text, $file, array $context = array() ) {
1187 wfDeprecated( __METHOD__
, '1.25' );
1188 $logger = MWLogger
::getInstance( 'wfErrorLog' );
1189 $context['destination'] = $file;
1190 $logger->info( trim( $text ), $context );
1196 function wfLogProfilingData() {
1197 global $wgRequestTime, $wgDebugLogGroups, $wgDebugRawPage;
1198 global $wgProfileLimit, $wgUser, $wgRequest;
1200 StatCounter
::singleton()->flush();
1202 $profiler = Profiler
::instance();
1204 # Profiling must actually be enabled...
1205 if ( $profiler instanceof ProfilerStub
) {
1209 // Get total page request time and only show pages that longer than
1210 // $wgProfileLimit time (default is 0)
1211 $elapsed = microtime( true ) - $wgRequestTime;
1212 if ( $elapsed <= $wgProfileLimit ) {
1216 $profiler->logData();
1218 if ( isset( $wgDebugLogGroups['profileoutput'] )
1219 && $wgDebugLogGroups['profileoutput'] === false
1221 // Explicitly disabled
1224 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1228 $ctx = array( 'elapsed' => $elapsed );
1229 if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1230 $ctx['forwarded_for'] = $_SERVER['HTTP_X_FORWARDED_FOR'];
1232 if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1233 $ctx['client_ip'] = $_SERVER['HTTP_CLIENT_IP'];
1235 if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1236 $ctx['from'] = $_SERVER['HTTP_FROM'];
1238 if ( isset( $ctx['forwarded_for'] ) ||
1239 isset( $ctx['client_ip'] ) ||
1240 isset( $ctx['from'] ) ) {
1241 $ctx['proxy'] = $_SERVER['REMOTE_ADDR'];
1244 // Don't load $wgUser at this late stage just for statistics purposes
1245 // @todo FIXME: We can detect some anons even if it is not loaded.
1246 // See User::getId()
1247 if ( $wgUser->isItemLoaded( 'id' ) && $wgUser->isAnon() ) {
1248 $ctx['anon'] = true;
1250 $ctx['anon'] = false;
1253 // Command line script uses a FauxRequest object which does not have
1254 // any knowledge about an URL and throw an exception instead.
1256 $ctx['url'] = urldecode( $wgRequest->getRequestURL() );
1257 } catch ( MWException
$ignored ) {
1261 $ctx['output'] = $profiler->getOutput();
1263 $log = MWLogger
::getInstance( 'profileoutput' );
1264 $log->info( "Elapsed: {elapsed}; URL: <{url}>\n{output}", $ctx );
1268 * Increment a statistics counter
1270 * @param string $key
1274 function wfIncrStats( $key, $count = 1 ) {
1275 StatCounter
::singleton()->incr( $key, $count );
1279 * Check whether the wiki is in read-only mode.
1283 function wfReadOnly() {
1284 return wfReadOnlyReason() !== false;
1288 * Get the value of $wgReadOnly or the contents of $wgReadOnlyFile.
1290 * @return string|bool String when in read-only mode; false otherwise
1292 function wfReadOnlyReason() {
1293 global $wgReadOnly, $wgReadOnlyFile;
1295 if ( $wgReadOnly === null ) {
1296 // Set $wgReadOnly for faster access next time
1297 if ( is_file( $wgReadOnlyFile ) && filesize( $wgReadOnlyFile ) > 0 ) {
1298 $wgReadOnly = file_get_contents( $wgReadOnlyFile );
1300 $wgReadOnly = false;
1308 * Return a Language object from $langcode
1310 * @param Language|string|bool $langcode Either:
1311 * - a Language object
1312 * - code of the language to get the message for, if it is
1313 * a valid code create a language for that language, if
1314 * it is a string but not a valid code then make a basic
1316 * - a boolean: if it's false then use the global object for
1317 * the current user's language (as a fallback for the old parameter
1318 * functionality), or if it is true then use global object
1319 * for the wiki's content language.
1322 function wfGetLangObj( $langcode = false ) {
1323 # Identify which language to get or create a language object for.
1324 # Using is_object here due to Stub objects.
1325 if ( is_object( $langcode ) ) {
1326 # Great, we already have the object (hopefully)!
1330 global $wgContLang, $wgLanguageCode;
1331 if ( $langcode === true ||
$langcode === $wgLanguageCode ) {
1332 # $langcode is the language code of the wikis content language object.
1333 # or it is a boolean and value is true
1338 if ( $langcode === false ||
$langcode === $wgLang->getCode() ) {
1339 # $langcode is the language code of user language object.
1340 # or it was a boolean and value is false
1344 $validCodes = array_keys( Language
::fetchLanguageNames() );
1345 if ( in_array( $langcode, $validCodes ) ) {
1346 # $langcode corresponds to a valid language.
1347 return Language
::factory( $langcode );
1350 # $langcode is a string, but not a valid language code; use content language.
1351 wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1356 * This is the function for getting translated interface messages.
1358 * @see Message class for documentation how to use them.
1359 * @see https://www.mediawiki.org/wiki/Manual:Messages_API
1361 * This function replaces all old wfMsg* functions.
1363 * @param string|string[] $key Message key, or array of keys
1364 * @param mixed $params,... Normal message parameters
1369 * @see Message::__construct
1371 function wfMessage( $key /*...*/ ) {
1372 $params = func_get_args();
1373 array_shift( $params );
1374 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
1375 $params = $params[0];
1377 return new Message( $key, $params );
1381 * This function accepts multiple message keys and returns a message instance
1382 * for the first message which is non-empty. If all messages are empty then an
1383 * instance of the first message key is returned.
1385 * @param string|string[] $keys,... Message keys
1390 * @see Message::newFallbackSequence
1392 function wfMessageFallback( /*...*/ ) {
1393 $args = func_get_args();
1394 return call_user_func_array( 'Message::newFallbackSequence', $args );
1398 * Get a message from anywhere, for the current user language.
1400 * Use wfMsgForContent() instead if the message should NOT
1401 * change depending on the user preferences.
1403 * @deprecated since 1.18
1405 * @param string $key Lookup key for the message, usually
1406 * defined in languages/Language.php
1408 * Parameters to the message, which can be used to insert variable text into
1409 * it, can be passed to this function in the following formats:
1410 * - One per argument, starting at the second parameter
1411 * - As an array in the second parameter
1412 * These are not shown in the function definition.
1416 function wfMsg( $key ) {
1417 wfDeprecated( __METHOD__
, '1.21' );
1419 $args = func_get_args();
1420 array_shift( $args );
1421 return wfMsgReal( $key, $args );
1425 * Same as above except doesn't transform the message
1427 * @deprecated since 1.18
1429 * @param string $key
1432 function wfMsgNoTrans( $key ) {
1433 wfDeprecated( __METHOD__
, '1.21' );
1435 $args = func_get_args();
1436 array_shift( $args );
1437 return wfMsgReal( $key, $args, true, false, false );
1441 * Get a message from anywhere, for the current global language
1442 * set with $wgLanguageCode.
1444 * Use this if the message should NOT change dependent on the
1445 * language set in the user's preferences. This is the case for
1446 * most text written into logs, as well as link targets (such as
1447 * the name of the copyright policy page). Link titles, on the
1448 * other hand, should be shown in the UI language.
1450 * Note that MediaWiki allows users to change the user interface
1451 * language in their preferences, but a single installation
1452 * typically only contains content in one language.
1454 * Be wary of this distinction: If you use wfMsg() where you should
1455 * use wfMsgForContent(), a user of the software may have to
1456 * customize potentially hundreds of messages in
1457 * order to, e.g., fix a link in every possible language.
1459 * @deprecated since 1.18
1461 * @param string $key Lookup key for the message, usually
1462 * defined in languages/Language.php
1465 function wfMsgForContent( $key ) {
1466 wfDeprecated( __METHOD__
, '1.21' );
1468 global $wgForceUIMsgAsContentMsg;
1469 $args = func_get_args();
1470 array_shift( $args );
1472 if ( is_array( $wgForceUIMsgAsContentMsg )
1473 && in_array( $key, $wgForceUIMsgAsContentMsg )
1475 $forcontent = false;
1477 return wfMsgReal( $key, $args, true, $forcontent );
1481 * Same as above except doesn't transform the message
1483 * @deprecated since 1.18
1485 * @param string $key
1488 function wfMsgForContentNoTrans( $key ) {
1489 wfDeprecated( __METHOD__
, '1.21' );
1491 global $wgForceUIMsgAsContentMsg;
1492 $args = func_get_args();
1493 array_shift( $args );
1495 if ( is_array( $wgForceUIMsgAsContentMsg )
1496 && in_array( $key, $wgForceUIMsgAsContentMsg )
1498 $forcontent = false;
1500 return wfMsgReal( $key, $args, true, $forcontent, false );
1504 * Really get a message
1506 * @deprecated since 1.18
1508 * @param string $key Key to get.
1509 * @param array $args
1510 * @param bool $useDB
1511 * @param string|bool $forContent Language code, or false for user lang, true for content lang.
1512 * @param bool $transform Whether or not to transform the message.
1513 * @return string The requested message.
1515 function wfMsgReal( $key, $args, $useDB = true, $forContent = false, $transform = true ) {
1516 wfDeprecated( __METHOD__
, '1.21' );
1518 $message = wfMsgGetKey( $key, $useDB, $forContent, $transform );
1519 $message = wfMsgReplaceArgs( $message, $args );
1524 * Fetch a message string value, but don't replace any keys yet.
1526 * @deprecated since 1.18
1528 * @param string $key
1529 * @param bool $useDB
1530 * @param string|bool $langCode Code of the language to get the message for, or
1531 * behaves as a content language switch if it is a boolean.
1532 * @param bool $transform Whether to parse magic words, etc.
1535 function wfMsgGetKey( $key, $useDB = true, $langCode = false, $transform = true ) {
1536 wfDeprecated( __METHOD__
, '1.21' );
1538 Hooks
::run( 'NormalizeMessageKey', array( &$key, &$useDB, &$langCode, &$transform ) );
1540 $cache = MessageCache
::singleton();
1541 $message = $cache->get( $key, $useDB, $langCode );
1542 if ( $message === false ) {
1543 $message = '<' . htmlspecialchars( $key ) . '>';
1544 } elseif ( $transform ) {
1545 $message = $cache->transform( $message );
1551 * Replace message parameter keys on the given formatted output.
1553 * @param string $message
1554 * @param array $args
1558 function wfMsgReplaceArgs( $message, $args ) {
1559 # Fix windows line-endings
1560 # Some messages are split with explode("\n", $msg)
1561 $message = str_replace( "\r", '', $message );
1563 // Replace arguments
1564 if ( count( $args ) ) {
1565 if ( is_array( $args[0] ) ) {
1566 $args = array_values( $args[0] );
1568 $replacementKeys = array();
1569 foreach ( $args as $n => $param ) {
1570 $replacementKeys['$' . ( $n +
1 )] = $param;
1572 $message = strtr( $message, $replacementKeys );
1579 * Return an HTML-escaped version of a message.
1580 * Parameter replacements, if any, are done *after* the HTML-escaping,
1581 * so parameters may contain HTML (eg links or form controls). Be sure
1582 * to pre-escape them if you really do want plaintext, or just wrap
1583 * the whole thing in htmlspecialchars().
1585 * @deprecated since 1.18
1587 * @param string $key
1588 * @param string $args,... Parameters
1591 function wfMsgHtml( $key ) {
1592 wfDeprecated( __METHOD__
, '1.21' );
1594 $args = func_get_args();
1595 array_shift( $args );
1596 return wfMsgReplaceArgs( htmlspecialchars( wfMsgGetKey( $key ) ), $args );
1600 * Return an HTML version of message
1601 * Parameter replacements, if any, are done *after* parsing the wiki-text message,
1602 * so parameters may contain HTML (eg links or form controls). Be sure
1603 * to pre-escape them if you really do want plaintext, or just wrap
1604 * the whole thing in htmlspecialchars().
1606 * @deprecated since 1.18
1608 * @param string $key
1609 * @param string $args,... Parameters
1612 function wfMsgWikiHtml( $key ) {
1613 wfDeprecated( __METHOD__
, '1.21' );
1615 $args = func_get_args();
1616 array_shift( $args );
1617 return wfMsgReplaceArgs(
1618 MessageCache
::singleton()->parse( wfMsgGetKey( $key ), null,
1619 /* can't be set to false */ true, /* interface */ true )->getText(),
1624 * Returns message in the requested format
1626 * @deprecated since 1.18
1628 * @param string $key Key of the message
1629 * @param array $options Processing rules.
1630 * Can take the following options:
1631 * parse: parses wikitext to HTML
1632 * parseinline: parses wikitext to HTML and removes the surrounding
1633 * p's added by parser or tidy
1634 * escape: filters message through htmlspecialchars
1635 * escapenoentities: same, but allows entity references like   through
1636 * replaceafter: parameters are substituted after parsing or escaping
1637 * parsemag: transform the message using magic phrases
1638 * content: fetch message for content language instead of interface
1639 * Also can accept a single associative argument, of the form 'language' => 'xx':
1640 * language: Language object or language code to fetch message for
1641 * (overridden by content).
1642 * Behavior for conflicting options (e.g., parse+parseinline) is undefined.
1646 function wfMsgExt( $key, $options ) {
1647 wfDeprecated( __METHOD__
, '1.21' );
1649 $args = func_get_args();
1650 array_shift( $args );
1651 array_shift( $args );
1652 $options = (array)$options;
1653 $validOptions = array( 'parse', 'parseinline', 'escape', 'escapenoentities', 'replaceafter',
1654 'parsemag', 'content' );
1656 foreach ( $options as $arrayKey => $option ) {
1657 if ( !preg_match( '/^[0-9]+|language$/', $arrayKey ) ) {
1658 // An unknown index, neither numeric nor "language"
1659 wfWarn( "wfMsgExt called with incorrect parameter key $arrayKey", 1, E_USER_WARNING
);
1660 } elseif ( preg_match( '/^[0-9]+$/', $arrayKey ) && !in_array( $option, $validOptions ) ) {
1661 // A numeric index with unknown value
1662 wfWarn( "wfMsgExt called with incorrect parameter $option", 1, E_USER_WARNING
);
1666 if ( in_array( 'content', $options, true ) ) {
1669 $langCodeObj = null;
1670 } elseif ( array_key_exists( 'language', $options ) ) {
1671 $forContent = false;
1672 $langCode = wfGetLangObj( $options['language'] );
1673 $langCodeObj = $langCode;
1675 $forContent = false;
1677 $langCodeObj = null;
1680 $string = wfMsgGetKey( $key, /*DB*/true, $langCode, /*Transform*/false );
1682 if ( !in_array( 'replaceafter', $options, true ) ) {
1683 $string = wfMsgReplaceArgs( $string, $args );
1686 $messageCache = MessageCache
::singleton();
1687 $parseInline = in_array( 'parseinline', $options, true );
1688 if ( in_array( 'parse', $options, true ) ||
$parseInline ) {
1689 $string = $messageCache->parse( $string, null, true, !$forContent, $langCodeObj );
1690 if ( $string instanceof ParserOutput
) {
1691 $string = $string->getText();
1694 if ( $parseInline ) {
1695 $string = Parser
::stripOuterParagraph( $string );
1697 } elseif ( in_array( 'parsemag', $options, true ) ) {
1698 $string = $messageCache->transform( $string,
1699 !$forContent, $langCodeObj );
1702 if ( in_array( 'escape', $options, true ) ) {
1703 $string = htmlspecialchars ( $string );
1704 } elseif ( in_array( 'escapenoentities', $options, true ) ) {
1705 $string = Sanitizer
::escapeHtmlAllowEntities( $string );
1708 if ( in_array( 'replaceafter', $options, true ) ) {
1709 $string = wfMsgReplaceArgs( $string, $args );
1716 * Since wfMsg() and co suck, they don't return false if the message key they
1717 * looked up didn't exist but instead the key wrapped in <>'s, this function checks for the
1718 * nonexistence of messages by checking the MessageCache::get() result directly.
1720 * @deprecated since 1.18. Use Message::isDisabled().
1722 * @param string $key The message key looked up
1723 * @return bool True if the message *doesn't* exist.
1725 function wfEmptyMsg( $key ) {
1726 wfDeprecated( __METHOD__
, '1.21' );
1728 return MessageCache
::singleton()->get( $key, /*useDB*/true, /*content*/false ) === false;
1732 * Fetch server name for use in error reporting etc.
1733 * Use real server name if available, so we know which machine
1734 * in a server farm generated the current page.
1738 function wfHostname() {
1740 if ( is_null( $host ) ) {
1742 # Hostname overriding
1743 global $wgOverrideHostname;
1744 if ( $wgOverrideHostname !== false ) {
1745 # Set static and skip any detection
1746 $host = $wgOverrideHostname;
1750 if ( function_exists( 'posix_uname' ) ) {
1751 // This function not present on Windows
1752 $uname = posix_uname();
1756 if ( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1757 $host = $uname['nodename'];
1758 } elseif ( getenv( 'COMPUTERNAME' ) ) {
1759 # Windows computer name
1760 $host = getenv( 'COMPUTERNAME' );
1762 # This may be a virtual server.
1763 $host = $_SERVER['SERVER_NAME'];
1770 * Returns a script tag that stores the amount of time it took MediaWiki to
1771 * handle the request in milliseconds as 'wgBackendResponseTime'.
1773 * If $wgShowHostnames is true, the script will also set 'wgHostname' to the
1774 * hostname of the server handling the request.
1778 function wfReportTime() {
1779 global $wgRequestTime, $wgShowHostnames;
1781 $responseTime = round( ( microtime( true ) - $wgRequestTime ) * 1000 );
1782 $reportVars = array( 'wgBackendResponseTime' => $responseTime );
1783 if ( $wgShowHostnames ) {
1784 $reportVars['wgHostname'] = wfHostname();
1786 return Skin
::makeVariablesScript( $reportVars );
1790 * Safety wrapper for debug_backtrace().
1792 * Will return an empty array if debug_backtrace is disabled, otherwise
1793 * the output from debug_backtrace() (trimmed).
1795 * @param int $limit This parameter can be used to limit the number of stack frames returned
1797 * @return array Array of backtrace information
1799 function wfDebugBacktrace( $limit = 0 ) {
1800 static $disabled = null;
1802 if ( is_null( $disabled ) ) {
1803 $disabled = !function_exists( 'debug_backtrace' );
1805 wfDebug( "debug_backtrace() is disabled\n" );
1812 if ( $limit && version_compare( PHP_VERSION
, '5.4.0', '>=' ) ) {
1813 return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT
, $limit +
1 ), 1 );
1815 return array_slice( debug_backtrace(), 1 );
1820 * Get a debug backtrace as a string
1822 * @param bool|null $raw If true, the return value is plain text. If false, HTML.
1823 * Defaults to $wgCommandLineMode if unset.
1825 * @since 1.25 Supports $raw parameter.
1827 function wfBacktrace( $raw = null ) {
1828 global $wgCommandLineMode;
1830 if ( $raw === null ) {
1831 $raw = $wgCommandLineMode;
1835 $frameFormat = "%s line %s calls %s()\n";
1836 $traceFormat = "%s";
1838 $frameFormat = "<li>%s line %s calls %s()</li>\n";
1839 $traceFormat = "<ul>\n%s</ul>\n";
1842 $frames = array_map( function ( $frame ) use ( $frameFormat ) {
1843 $file = !empty( $frame['file'] ) ?
basename( $frame['file'] ) : '-';
1844 $line = isset( $frame['line'] ) ?
$frame['line'] : '-';
1845 $call = $frame['function'];
1846 if ( !empty( $frame['class'] ) ) {
1847 $call = $frame['class'] . $frame['type'] . $call;
1849 return sprintf( $frameFormat, $file, $line, $call );
1850 }, wfDebugBacktrace() );
1852 return sprintf( $traceFormat, implode( '', $frames ) );
1856 * Get the name of the function which called this function
1857 * wfGetCaller( 1 ) is the function with the wfGetCaller() call (ie. __FUNCTION__)
1858 * wfGetCaller( 2 ) [default] is the caller of the function running wfGetCaller()
1859 * wfGetCaller( 3 ) is the parent of that.
1864 function wfGetCaller( $level = 2 ) {
1865 $backtrace = wfDebugBacktrace( $level +
1 );
1866 if ( isset( $backtrace[$level] ) ) {
1867 return wfFormatStackFrame( $backtrace[$level] );
1874 * Return a string consisting of callers in the stack. Useful sometimes
1875 * for profiling specific points.
1877 * @param int $limit The maximum depth of the stack frame to return, or false for the entire stack.
1880 function wfGetAllCallers( $limit = 3 ) {
1881 $trace = array_reverse( wfDebugBacktrace() );
1882 if ( !$limit ||
$limit > count( $trace ) - 1 ) {
1883 $limit = count( $trace ) - 1;
1885 $trace = array_slice( $trace, -$limit - 1, $limit );
1886 return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1890 * Return a string representation of frame
1892 * @param array $frame
1895 function wfFormatStackFrame( $frame ) {
1896 return isset( $frame['class'] ) ?
1897 $frame['class'] . '::' . $frame['function'] :
1901 /* Some generic result counters, pulled out of SearchEngine */
1906 * @param int $offset
1910 function wfShowingResults( $offset, $limit ) {
1911 return wfMessage( 'showingresults' )->numParams( $limit, $offset +
1 )->parse();
1916 * @todo FIXME: We may want to blacklist some broken browsers
1918 * @param bool $force
1919 * @return bool Whereas client accept gzip compression
1921 function wfClientAcceptsGzip( $force = false ) {
1922 static $result = null;
1923 if ( $result === null ||
$force ) {
1925 if ( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
1926 # @todo FIXME: We may want to blacklist some broken browsers
1929 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
1930 $_SERVER['HTTP_ACCEPT_ENCODING'],
1934 if ( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
1938 wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
1947 * Obtain the offset and limit values from the request string;
1948 * used in special pages
1950 * @param int $deflimit Default limit if none supplied
1951 * @param string $optionname Name of a user preference to check against
1953 * @deprecated since 1.24, just call WebRequest::getLimitOffset() directly
1955 function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
1957 wfDeprecated( __METHOD__
, '1.24' );
1958 return $wgRequest->getLimitOffset( $deflimit, $optionname );
1962 * Escapes the given text so that it may be output using addWikiText()
1963 * without any linking, formatting, etc. making its way through. This
1964 * is achieved by substituting certain characters with HTML entities.
1965 * As required by the callers, "<nowiki>" is not used.
1967 * @param string $text Text to be escaped
1970 function wfEscapeWikiText( $text ) {
1971 static $repl = null, $repl2 = null;
1972 if ( $repl === null ) {
1974 '"' => '"', '&' => '&', "'" => ''', '<' => '<',
1975 '=' => '=', '>' => '>', '[' => '[', ']' => ']',
1976 '{' => '{', '|' => '|', '}' => '}', ';' => ';',
1977 "\n#" => "\n#", "\r#" => "\r#",
1978 "\n*" => "\n*", "\r*" => "\r*",
1979 "\n:" => "\n:", "\r:" => "\r:",
1980 "\n " => "\n ", "\r " => "\r ",
1981 "\n\n" => "\n ", "\r\n" => " \n",
1982 "\n\r" => "\n ", "\r\r" => "\r ",
1983 "\n\t" => "\n	", "\r\t" => "\r	", // "\n\t\n" is treated like "\n\n"
1984 "\n----" => "\n----", "\r----" => "\r----",
1985 '__' => '__', '://' => '://',
1988 // We have to catch everything "\s" matches in PCRE
1989 foreach ( array( 'ISBN', 'RFC', 'PMID' ) as $magic ) {
1990 $repl["$magic "] = "$magic ";
1991 $repl["$magic\t"] = "$magic	";
1992 $repl["$magic\r"] = "$magic ";
1993 $repl["$magic\n"] = "$magic ";
1994 $repl["$magic\f"] = "$magic";
1997 // And handle protocols that don't use "://"
1998 global $wgUrlProtocols;
2000 foreach ( $wgUrlProtocols as $prot ) {
2001 if ( substr( $prot, -1 ) === ':' ) {
2002 $repl2[] = preg_quote( substr( $prot, 0, -1 ), '/' );
2005 $repl2 = $repl2 ?
'/\b(' . join( '|', $repl2 ) . '):/i' : '/^(?!)/';
2007 $text = substr( strtr( "\n$text", $repl ), 1 );
2008 $text = preg_replace( $repl2, '$1:', $text );
2013 * Sets dest to source and returns the original value of dest
2014 * If source is NULL, it just returns the value, it doesn't set the variable
2015 * If force is true, it will set the value even if source is NULL
2017 * @param mixed $dest
2018 * @param mixed $source
2019 * @param bool $force
2022 function wfSetVar( &$dest, $source, $force = false ) {
2024 if ( !is_null( $source ) ||
$force ) {
2031 * As for wfSetVar except setting a bit
2035 * @param bool $state
2039 function wfSetBit( &$dest, $bit, $state = true ) {
2040 $temp = (bool)( $dest & $bit );
2041 if ( !is_null( $state ) ) {
2052 * A wrapper around the PHP function var_export().
2053 * Either print it or add it to the regular output ($wgOut).
2055 * @param mixed $var A PHP variable to dump.
2057 function wfVarDump( $var ) {
2059 $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
2060 if ( headers_sent() ||
!isset( $wgOut ) ||
!is_object( $wgOut ) ) {
2063 $wgOut->addHTML( $s );
2068 * Provide a simple HTTP error.
2070 * @param int|string $code
2071 * @param string $label
2072 * @param string $desc
2074 function wfHttpError( $code, $label, $desc ) {
2077 header( "HTTP/1.0 $code $label" );
2078 header( "Status: $code $label" );
2079 $wgOut->sendCacheControl();
2081 header( 'Content-type: text/html; charset=utf-8' );
2082 print "<!doctype html>" .
2083 '<html><head><title>' .
2084 htmlspecialchars( $label ) .
2085 '</title></head><body><h1>' .
2086 htmlspecialchars( $label ) .
2088 nl2br( htmlspecialchars( $desc ) ) .
2089 "</p></body></html>\n";
2093 * Clear away any user-level output buffers, discarding contents.
2095 * Suitable for 'starting afresh', for instance when streaming
2096 * relatively large amounts of data without buffering, or wanting to
2097 * output image files without ob_gzhandler's compression.
2099 * The optional $resetGzipEncoding parameter controls suppression of
2100 * the Content-Encoding header sent by ob_gzhandler; by default it
2101 * is left. See comments for wfClearOutputBuffers() for why it would
2104 * Note that some PHP configuration options may add output buffer
2105 * layers which cannot be removed; these are left in place.
2107 * @param bool $resetGzipEncoding
2109 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
2110 if ( $resetGzipEncoding ) {
2111 // Suppress Content-Encoding and Content-Length
2112 // headers from 1.10+s wfOutputHandler
2113 global $wgDisableOutputCompression;
2114 $wgDisableOutputCompression = true;
2116 while ( $status = ob_get_status() ) {
2117 if ( $status['type'] == 0 /* PHP_OUTPUT_HANDLER_INTERNAL */ ) {
2118 // Probably from zlib.output_compression or other
2119 // PHP-internal setting which can't be removed.
2121 // Give up, and hope the result doesn't break
2125 if ( !ob_end_clean() ) {
2126 // Could not remove output buffer handler; abort now
2127 // to avoid getting in some kind of infinite loop.
2130 if ( $resetGzipEncoding ) {
2131 if ( $status['name'] == 'ob_gzhandler' ) {
2132 // Reset the 'Content-Encoding' field set by this handler
2133 // so we can start fresh.
2134 header_remove( 'Content-Encoding' );
2142 * More legible than passing a 'false' parameter to wfResetOutputBuffers():
2144 * Clear away output buffers, but keep the Content-Encoding header
2145 * produced by ob_gzhandler, if any.
2147 * This should be used for HTTP 304 responses, where you need to
2148 * preserve the Content-Encoding header of the real result, but
2149 * also need to suppress the output of ob_gzhandler to keep to spec
2150 * and avoid breaking Firefox in rare cases where the headers and
2151 * body are broken over two packets.
2153 function wfClearOutputBuffers() {
2154 wfResetOutputBuffers( false );
2158 * Converts an Accept-* header into an array mapping string values to quality
2161 * @param string $accept
2162 * @param string $def Default
2163 * @return float[] Associative array of string => float pairs
2165 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
2166 # No arg means accept anything (per HTTP spec)
2168 return array( $def => 1.0 );
2173 $parts = explode( ',', $accept );
2175 foreach ( $parts as $part ) {
2176 # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
2177 $values = explode( ';', trim( $part ) );
2179 if ( count( $values ) == 1 ) {
2180 $prefs[$values[0]] = 1.0;
2181 } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
2182 $prefs[$values[0]] = floatval( $match[1] );
2190 * Checks if a given MIME type matches any of the keys in the given
2191 * array. Basic wildcards are accepted in the array keys.
2193 * Returns the matching MIME type (or wildcard) if a match, otherwise
2196 * @param string $type
2197 * @param array $avail
2201 function mimeTypeMatch( $type, $avail ) {
2202 if ( array_key_exists( $type, $avail ) ) {
2205 $parts = explode( '/', $type );
2206 if ( array_key_exists( $parts[0] . '/*', $avail ) ) {
2207 return $parts[0] . '/*';
2208 } elseif ( array_key_exists( '*/*', $avail ) ) {
2217 * Returns the 'best' match between a client's requested internet media types
2218 * and the server's list of available types. Each list should be an associative
2219 * array of type to preference (preference is a float between 0.0 and 1.0).
2220 * Wildcards in the types are acceptable.
2222 * @param array $cprefs Client's acceptable type list
2223 * @param array $sprefs Server's offered types
2226 * @todo FIXME: Doesn't handle params like 'text/plain; charset=UTF-8'
2227 * XXX: generalize to negotiate other stuff
2229 function wfNegotiateType( $cprefs, $sprefs ) {
2232 foreach ( array_keys( $sprefs ) as $type ) {
2233 $parts = explode( '/', $type );
2234 if ( $parts[1] != '*' ) {
2235 $ckey = mimeTypeMatch( $type, $cprefs );
2237 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
2242 foreach ( array_keys( $cprefs ) as $type ) {
2243 $parts = explode( '/', $type );
2244 if ( $parts[1] != '*' && !array_key_exists( $type, $sprefs ) ) {
2245 $skey = mimeTypeMatch( $type, $sprefs );
2247 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
2255 foreach ( array_keys( $combine ) as $type ) {
2256 if ( $combine[$type] > $bestq ) {
2258 $bestq = $combine[$type];
2266 * Reference-counted warning suppression
2270 function wfSuppressWarnings( $end = false ) {
2271 static $suppressCount = 0;
2272 static $originalLevel = false;
2275 if ( $suppressCount ) {
2277 if ( !$suppressCount ) {
2278 error_reporting( $originalLevel );
2282 if ( !$suppressCount ) {
2283 $originalLevel = error_reporting( E_ALL
& ~
(
2298 * Restore error level to previous value
2300 function wfRestoreWarnings() {
2301 wfSuppressWarnings( true );
2304 # Autodetect, convert and provide timestamps of various types
2307 * Unix time - the number of seconds since 1970-01-01 00:00:00 UTC
2309 define( 'TS_UNIX', 0 );
2312 * MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
2314 define( 'TS_MW', 1 );
2317 * MySQL DATETIME (YYYY-MM-DD HH:MM:SS)
2319 define( 'TS_DB', 2 );
2322 * RFC 2822 format, for E-mail and HTTP headers
2324 define( 'TS_RFC2822', 3 );
2327 * ISO 8601 format with no timezone: 1986-02-09T20:00:00Z
2329 * This is used by Special:Export
2331 define( 'TS_ISO_8601', 4 );
2334 * An Exif timestamp (YYYY:MM:DD HH:MM:SS)
2336 * @see http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the
2337 * DateTime tag and page 36 for the DateTimeOriginal and
2338 * DateTimeDigitized tags.
2340 define( 'TS_EXIF', 5 );
2343 * Oracle format time.
2345 define( 'TS_ORACLE', 6 );
2348 * Postgres format time.
2350 define( 'TS_POSTGRES', 7 );
2353 * ISO 8601 basic format with no timezone: 19860209T200000Z. This is used by ResourceLoader
2355 define( 'TS_ISO_8601_BASIC', 9 );
2358 * Get a timestamp string in one of various formats
2360 * @param mixed $outputtype A timestamp in one of the supported formats, the
2361 * function will autodetect which format is supplied and act accordingly.
2362 * @param mixed $ts Optional timestamp to convert, default 0 for the current time
2363 * @return string|bool String / false The same date in the format specified in $outputtype or false
2365 function wfTimestamp( $outputtype = TS_UNIX
, $ts = 0 ) {
2367 $timestamp = new MWTimestamp( $ts );
2368 return $timestamp->getTimestamp( $outputtype );
2369 } catch ( TimestampException
$e ) {
2370 wfDebug( "wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n" );
2376 * Return a formatted timestamp, or null if input is null.
2377 * For dealing with nullable timestamp columns in the database.
2379 * @param int $outputtype
2383 function wfTimestampOrNull( $outputtype = TS_UNIX
, $ts = null ) {
2384 if ( is_null( $ts ) ) {
2387 return wfTimestamp( $outputtype, $ts );
2392 * Convenience function; returns MediaWiki timestamp for the present time.
2396 function wfTimestampNow() {
2398 return wfTimestamp( TS_MW
, time() );
2402 * Check if the operating system is Windows
2404 * @return bool True if it's Windows, false otherwise.
2406 function wfIsWindows() {
2407 static $isWindows = null;
2408 if ( $isWindows === null ) {
2409 $isWindows = substr( php_uname(), 0, 7 ) == 'Windows';
2415 * Check if we are running under HHVM
2419 function wfIsHHVM() {
2420 return defined( 'HHVM_VERSION' );
2424 * Swap two variables
2426 * @deprecated since 1.24
2430 function swap( &$x, &$y ) {
2431 wfDeprecated( __FUNCTION__
, '1.24' );
2438 * Tries to get the system directory for temporary files. First
2439 * $wgTmpDirectory is checked, and then the TMPDIR, TMP, and TEMP
2440 * environment variables are then checked in sequence, and if none are
2441 * set try sys_get_temp_dir().
2443 * NOTE: When possible, use instead the tmpfile() function to create
2444 * temporary files to avoid race conditions on file creation, etc.
2448 function wfTempDir() {
2449 global $wgTmpDirectory;
2451 if ( $wgTmpDirectory !== false ) {
2452 return $wgTmpDirectory;
2455 $tmpDir = array_map( "getenv", array( 'TMPDIR', 'TMP', 'TEMP' ) );
2457 foreach ( $tmpDir as $tmp ) {
2458 if ( $tmp && file_exists( $tmp ) && is_dir( $tmp ) && is_writable( $tmp ) ) {
2462 return sys_get_temp_dir();
2466 * Make directory, and make all parent directories if they don't exist
2468 * @param string $dir Full path to directory to create
2469 * @param int $mode Chmod value to use, default is $wgDirectoryMode
2470 * @param string $caller Optional caller param for debugging.
2471 * @throws MWException
2474 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2475 global $wgDirectoryMode;
2477 if ( FileBackend
::isStoragePath( $dir ) ) { // sanity
2478 throw new MWException( __FUNCTION__
. " given storage path '$dir'." );
2481 if ( !is_null( $caller ) ) {
2482 wfDebug( "$caller: called wfMkdirParents($dir)\n" );
2485 if ( strval( $dir ) === '' ||
( file_exists( $dir ) && is_dir( $dir ) ) ) {
2489 $dir = str_replace( array( '\\', '/' ), DIRECTORY_SEPARATOR
, $dir );
2491 if ( is_null( $mode ) ) {
2492 $mode = $wgDirectoryMode;
2495 // Turn off the normal warning, we're doing our own below
2496 wfSuppressWarnings();
2497 $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2498 wfRestoreWarnings();
2501 //directory may have been created on another request since we last checked
2502 if ( is_dir( $dir ) ) {
2506 // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2507 wfLogWarning( sprintf( "failed to mkdir \"%s\" mode 0%o", $dir, $mode ) );
2513 * Remove a directory and all its content.
2514 * Does not hide error.
2515 * @param string $dir
2517 function wfRecursiveRemoveDir( $dir ) {
2518 wfDebug( __FUNCTION__
. "( $dir )\n" );
2519 // taken from http://de3.php.net/manual/en/function.rmdir.php#98622
2520 if ( is_dir( $dir ) ) {
2521 $objects = scandir( $dir );
2522 foreach ( $objects as $object ) {
2523 if ( $object != "." && $object != ".." ) {
2524 if ( filetype( $dir . '/' . $object ) == "dir" ) {
2525 wfRecursiveRemoveDir( $dir . '/' . $object );
2527 unlink( $dir . '/' . $object );
2537 * @param int $nr The number to format
2538 * @param int $acc The number of digits after the decimal point, default 2
2539 * @param bool $round Whether or not to round the value, default true
2542 function wfPercent( $nr, $acc = 2, $round = true ) {
2543 $ret = sprintf( "%.${acc}f", $nr );
2544 return $round ?
round( $ret, $acc ) . '%' : "$ret%";
2548 * Safety wrapper around ini_get() for boolean settings.
2549 * The values returned from ini_get() are pre-normalized for settings
2550 * set via php.ini or php_flag/php_admin_flag... but *not*
2551 * for those set via php_value/php_admin_value.
2553 * It's fairly common for people to use php_value instead of php_flag,
2554 * which can leave you with an 'off' setting giving a false positive
2555 * for code that just takes the ini_get() return value as a boolean.
2557 * To make things extra interesting, setting via php_value accepts
2558 * "true" and "yes" as true, but php.ini and php_flag consider them false. :)
2559 * Unrecognized values go false... again opposite PHP's own coercion
2560 * from string to bool.
2562 * Luckily, 'properly' set settings will always come back as '0' or '1',
2563 * so we only have to worry about them and the 'improper' settings.
2565 * I frickin' hate PHP... :P
2567 * @param string $setting
2570 function wfIniGetBool( $setting ) {
2571 $val = strtolower( ini_get( $setting ) );
2572 // 'on' and 'true' can't have whitespace around them, but '1' can.
2576 ||
preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2580 * Windows-compatible version of escapeshellarg()
2581 * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
2582 * function puts single quotes in regardless of OS.
2584 * Also fixes the locale problems on Linux in PHP 5.2.6+ (bug backported to
2585 * earlier distro releases of PHP)
2587 * @param string $args,...
2590 function wfEscapeShellArg( /*...*/ ) {
2591 wfInitShellLocale();
2593 $args = func_get_args();
2596 foreach ( $args as $arg ) {
2603 if ( wfIsWindows() ) {
2604 // Escaping for an MSVC-style command line parser and CMD.EXE
2605 // @codingStandardsIgnoreStart For long URLs
2607 // * http://web.archive.org/web/20020708081031/http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
2608 // * http://technet.microsoft.com/en-us/library/cc723564.aspx
2611 // Double the backslashes before any double quotes. Escape the double quotes.
2612 // @codingStandardsIgnoreEnd
2613 $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE
);
2616 foreach ( $tokens as $token ) {
2617 if ( $iteration %
2 == 1 ) {
2618 // Delimiter, a double quote preceded by zero or more slashes
2619 $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
2620 } elseif ( $iteration %
4 == 2 ) {
2621 // ^ in $token will be outside quotes, need to be escaped
2622 $arg .= str_replace( '^', '^^', $token );
2623 } else { // $iteration % 4 == 0
2624 // ^ in $token will appear inside double quotes, so leave as is
2629 // Double the backslashes before the end of the string, because
2630 // we will soon add a quote
2632 if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
2633 $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
2636 // Add surrounding quotes
2637 $retVal .= '"' . $arg . '"';
2639 $retVal .= escapeshellarg( $arg );
2646 * Check if wfShellExec() is effectively disabled via php.ini config
2648 * @return bool|string False or one of (safemode,disabled)
2651 function wfShellExecDisabled() {
2652 static $disabled = null;
2653 if ( is_null( $disabled ) ) {
2654 if ( wfIniGetBool( 'safe_mode' ) ) {
2655 wfDebug( "wfShellExec can't run in safe_mode, PHP's exec functions are too broken.\n" );
2656 $disabled = 'safemode';
2657 } elseif ( !function_exists( 'proc_open' ) ) {
2658 wfDebug( "proc_open() is disabled\n" );
2659 $disabled = 'disabled';
2668 * Execute a shell command, with time and memory limits mirrored from the PHP
2669 * configuration if supported.
2671 * @param string|string[] $cmd If string, a properly shell-escaped command line,
2672 * or an array of unescaped arguments, in which case each value will be escaped
2673 * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
2674 * @param null|mixed &$retval Optional, will receive the program's exit code.
2675 * (non-zero is usually failure). If there is an error from
2676 * read, select, or proc_open(), this will be set to -1.
2677 * @param array $environ Optional environment variables which should be
2678 * added to the executed command environment.
2679 * @param array $limits Optional array with limits(filesize, memory, time, walltime)
2680 * this overwrites the global wgMaxShell* limits.
2681 * @param array $options Array of options:
2682 * - duplicateStderr: Set this to true to duplicate stderr to stdout,
2683 * including errors from limit.sh
2685 * @return string Collected stdout as a string
2687 function wfShellExec( $cmd, &$retval = null, $environ = array(),
2688 $limits = array(), $options = array()
2690 global $IP, $wgMaxShellMemory, $wgMaxShellFileSize, $wgMaxShellTime,
2691 $wgMaxShellWallClockTime, $wgShellCgroup;
2693 $disabled = wfShellExecDisabled();
2696 return $disabled == 'safemode' ?
2697 'Unable to run external programs in safe mode.' :
2698 'Unable to run external programs, proc_open() is disabled.';
2701 $includeStderr = isset( $options['duplicateStderr'] ) && $options['duplicateStderr'];
2703 wfInitShellLocale();
2706 foreach ( $environ as $k => $v ) {
2707 if ( wfIsWindows() ) {
2708 /* Surrounding a set in quotes (method used by wfEscapeShellArg) makes the quotes themselves
2709 * appear in the environment variable, so we must use carat escaping as documented in
2710 * http://technet.microsoft.com/en-us/library/cc723564.aspx
2711 * Note however that the quote isn't listed there, but is needed, and the parentheses
2712 * are listed there but doesn't appear to need it.
2714 $envcmd .= "set $k=" . preg_replace( '/([&|()<>^"])/', '^\\1', $v ) . '&& ';
2716 /* Assume this is a POSIX shell, thus required to accept variable assignments before the command
2717 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_09_01
2719 $envcmd .= "$k=" . escapeshellarg( $v ) . ' ';
2722 if ( is_array( $cmd ) ) {
2723 // Command line may be given as an array, escape each value and glue them together with a space
2725 foreach ( $cmd as $val ) {
2726 $cmdVals[] = wfEscapeShellArg( $val );
2728 $cmd = implode( ' ', $cmdVals );
2731 $cmd = $envcmd . $cmd;
2733 $useLogPipe = false;
2734 if ( is_executable( '/bin/bash' ) ) {
2735 $time = intval ( isset( $limits['time'] ) ?
$limits['time'] : $wgMaxShellTime );
2736 if ( isset( $limits['walltime'] ) ) {
2737 $wallTime = intval( $limits['walltime'] );
2738 } elseif ( isset( $limits['time'] ) ) {
2741 $wallTime = intval( $wgMaxShellWallClockTime );
2743 $mem = intval ( isset( $limits['memory'] ) ?
$limits['memory'] : $wgMaxShellMemory );
2744 $filesize = intval ( isset( $limits['filesize'] ) ?
$limits['filesize'] : $wgMaxShellFileSize );
2746 if ( $time > 0 ||
$mem > 0 ||
$filesize > 0 ||
$wallTime > 0 ) {
2747 $cmd = '/bin/bash ' . escapeshellarg( "$IP/includes/limit.sh" ) . ' ' .
2748 escapeshellarg( $cmd ) . ' ' .
2750 "MW_INCLUDE_STDERR=" . ( $includeStderr ?
'1' : '' ) . ';' .
2751 "MW_CPU_LIMIT=$time; " .
2752 'MW_CGROUP=' . escapeshellarg( $wgShellCgroup ) . '; ' .
2753 "MW_MEM_LIMIT=$mem; " .
2754 "MW_FILE_SIZE_LIMIT=$filesize; " .
2755 "MW_WALL_CLOCK_LIMIT=$wallTime; " .
2756 "MW_USE_LOG_PIPE=yes"
2759 } elseif ( $includeStderr ) {
2762 } elseif ( $includeStderr ) {
2765 wfDebug( "wfShellExec: $cmd\n" );
2768 0 => array( 'file', 'php://stdin', 'r' ),
2769 1 => array( 'pipe', 'w' ),
2770 2 => array( 'file', 'php://stderr', 'w' ) );
2771 if ( $useLogPipe ) {
2772 $desc[3] = array( 'pipe', 'w' );
2775 $proc = proc_open( $cmd, $desc, $pipes );
2777 wfDebugLog( 'exec', "proc_open() failed: $cmd" );
2781 $outBuffer = $logBuffer = '';
2782 $emptyArray = array();
2786 // According to the documentation, it is possible for stream_select()
2787 // to fail due to EINTR. I haven't managed to induce this in testing
2788 // despite sending various signals. If it did happen, the error
2789 // message would take the form:
2791 // stream_select(): unable to select [4]: Interrupted system call (max_fd=5)
2793 // where [4] is the value of the macro EINTR and "Interrupted system
2794 // call" is string which according to the Linux manual is "possibly"
2795 // localised according to LC_MESSAGES.
2796 $eintr = defined( 'SOCKET_EINTR' ) ? SOCKET_EINTR
: 4;
2797 $eintrMessage = "stream_select(): unable to select [$eintr]";
2799 // Build a table mapping resource IDs to pipe FDs to work around a
2800 // PHP 5.3 issue in which stream_select() does not preserve array keys
2801 // <https://bugs.php.net/bug.php?id=53427>.
2803 foreach ( $pipes as $fd => $pipe ) {
2804 $fds[(int)$pipe] = $fd;
2811 while ( $running === true ||
$numReadyPipes !== 0 ) {
2813 $status = proc_get_status( $proc );
2814 // If the process has terminated, switch to nonblocking selects
2815 // for getting any data still waiting to be read.
2816 if ( !$status['running'] ) {
2822 $readyPipes = $pipes;
2825 // @codingStandardsIgnoreStart Generic.PHP.NoSilencedErrors.Discouraged
2826 @trigger_error
( '' );
2827 $numReadyPipes = @stream_select
( $readyPipes, $emptyArray, $emptyArray, $timeout );
2828 if ( $numReadyPipes === false ) {
2829 // @codingStandardsIgnoreEnd
2830 $error = error_get_last();
2831 if ( strncmp( $error['message'], $eintrMessage, strlen( $eintrMessage ) ) == 0 ) {
2834 trigger_error( $error['message'], E_USER_WARNING
);
2835 $logMsg = $error['message'];
2839 foreach ( $readyPipes as $pipe ) {
2840 $block = fread( $pipe, 65536 );
2841 $fd = $fds[(int)$pipe];
2842 if ( $block === '' ) {
2844 fclose( $pipes[$fd] );
2845 unset( $pipes[$fd] );
2849 } elseif ( $block === false ) {
2851 $logMsg = "Error reading from pipe";
2853 } elseif ( $fd == 1 ) {
2855 $outBuffer .= $block;
2856 } elseif ( $fd == 3 ) {
2858 $logBuffer .= $block;
2859 if ( strpos( $block, "\n" ) !== false ) {
2860 $lines = explode( "\n", $logBuffer );
2861 $logBuffer = array_pop( $lines );
2862 foreach ( $lines as $line ) {
2863 wfDebugLog( 'exec', $line );
2870 foreach ( $pipes as $pipe ) {
2874 // Use the status previously collected if possible, since proc_get_status()
2875 // just calls waitpid() which will not return anything useful the second time.
2877 $status = proc_get_status( $proc );
2880 if ( $logMsg !== false ) {
2881 // Read/select error
2883 proc_close( $proc );
2884 } elseif ( $status['signaled'] ) {
2885 $logMsg = "Exited with signal {$status['termsig']}";
2886 $retval = 128 +
$status['termsig'];
2887 proc_close( $proc );
2889 if ( $status['running'] ) {
2890 $retval = proc_close( $proc );
2892 $retval = $status['exitcode'];
2893 proc_close( $proc );
2895 if ( $retval == 127 ) {
2896 $logMsg = "Possibly missing executable file";
2897 } elseif ( $retval >= 129 && $retval <= 192 ) {
2898 $logMsg = "Probably exited with signal " . ( $retval - 128 );
2902 if ( $logMsg !== false ) {
2903 wfDebugLog( 'exec', "$logMsg: $cmd" );
2910 * Execute a shell command, returning both stdout and stderr. Convenience
2911 * function, as all the arguments to wfShellExec can become unwieldy.
2913 * @note This also includes errors from limit.sh, e.g. if $wgMaxShellFileSize is exceeded.
2914 * @param string|string[] $cmd If string, a properly shell-escaped command line,
2915 * or an array of unescaped arguments, in which case each value will be escaped
2916 * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
2917 * @param null|mixed &$retval Optional, will receive the program's exit code.
2918 * (non-zero is usually failure)
2919 * @param array $environ Optional environment variables which should be
2920 * added to the executed command environment.
2921 * @param array $limits Optional array with limits(filesize, memory, time, walltime)
2922 * this overwrites the global wgMaxShell* limits.
2923 * @return string Collected stdout and stderr as a string
2925 function wfShellExecWithStderr( $cmd, &$retval = null, $environ = array(), $limits = array() ) {
2926 return wfShellExec( $cmd, $retval, $environ, $limits, array( 'duplicateStderr' => true ) );
2930 * Workaround for http://bugs.php.net/bug.php?id=45132
2931 * escapeshellarg() destroys non-ASCII characters if LANG is not a UTF-8 locale
2933 function wfInitShellLocale() {
2934 static $done = false;
2939 global $wgShellLocale;
2940 if ( !wfIniGetBool( 'safe_mode' ) ) {
2941 putenv( "LC_CTYPE=$wgShellLocale" );
2942 setlocale( LC_CTYPE
, $wgShellLocale );
2947 * Alias to wfShellWikiCmd()
2949 * @see wfShellWikiCmd()
2951 function wfShellMaintenanceCmd( $script, array $parameters = array(), array $options = array() ) {
2952 return wfShellWikiCmd( $script, $parameters, $options );
2956 * Generate a shell-escaped command line string to run a MediaWiki cli script.
2957 * Note that $parameters should be a flat array and an option with an argument
2958 * should consist of two consecutive items in the array (do not use "--option value").
2960 * @param string $script MediaWiki cli script path
2961 * @param array $parameters Arguments and options to the script
2962 * @param array $options Associative array of options:
2963 * 'php': The path to the php executable
2964 * 'wrapper': Path to a PHP wrapper to handle the maintenance script
2967 function wfShellWikiCmd( $script, array $parameters = array(), array $options = array() ) {
2969 // Give site config file a chance to run the script in a wrapper.
2970 // The caller may likely want to call wfBasename() on $script.
2971 Hooks
::run( 'wfShellWikiCmd', array( &$script, &$parameters, &$options ) );
2972 $cmd = isset( $options['php'] ) ?
array( $options['php'] ) : array( $wgPhpCli );
2973 if ( isset( $options['wrapper'] ) ) {
2974 $cmd[] = $options['wrapper'];
2977 // Escape each parameter for shell
2978 return implode( " ", array_map( 'wfEscapeShellArg', array_merge( $cmd, $parameters ) ) );
2982 * wfMerge attempts to merge differences between three texts.
2983 * Returns true for a clean merge and false for failure or a conflict.
2985 * @param string $old
2986 * @param string $mine
2987 * @param string $yours
2988 * @param string $result
2991 function wfMerge( $old, $mine, $yours, &$result ) {
2994 # This check may also protect against code injection in
2995 # case of broken installations.
2996 wfSuppressWarnings();
2997 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
2998 wfRestoreWarnings();
3000 if ( !$haveDiff3 ) {
3001 wfDebug( "diff3 not found\n" );
3005 # Make temporary files
3007 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
3008 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
3009 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
3011 # NOTE: diff3 issues a warning to stderr if any of the files does not end with
3012 # a newline character. To avoid this, we normalize the trailing whitespace before
3013 # creating the diff.
3015 fwrite( $oldtextFile, rtrim( $old ) . "\n" );
3016 fclose( $oldtextFile );
3017 fwrite( $mytextFile, rtrim( $mine ) . "\n" );
3018 fclose( $mytextFile );
3019 fwrite( $yourtextFile, rtrim( $yours ) . "\n" );
3020 fclose( $yourtextFile );
3022 # Check for a conflict
3023 $cmd = wfEscapeShellArg( $wgDiff3 ) . ' -a --overlap-only ' .
3024 wfEscapeShellArg( $mytextName ) . ' ' .
3025 wfEscapeShellArg( $oldtextName ) . ' ' .
3026 wfEscapeShellArg( $yourtextName );
3027 $handle = popen( $cmd, 'r' );
3029 if ( fgets( $handle, 1024 ) ) {
3037 $cmd = wfEscapeShellArg( $wgDiff3 ) . ' -a -e --merge ' .
3038 wfEscapeShellArg( $mytextName, $oldtextName, $yourtextName );
3039 $handle = popen( $cmd, 'r' );
3042 $data = fread( $handle, 8192 );
3043 if ( strlen( $data ) == 0 ) {
3049 unlink( $mytextName );
3050 unlink( $oldtextName );
3051 unlink( $yourtextName );
3053 if ( $result === '' && $old !== '' && !$conflict ) {
3054 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
3061 * Returns unified plain-text diff of two texts.
3062 * Useful for machine processing of diffs.
3064 * @param string $before The text before the changes.
3065 * @param string $after The text after the changes.
3066 * @param string $params Command-line options for the diff command.
3067 * @return string Unified diff of $before and $after
3069 function wfDiff( $before, $after, $params = '-u' ) {
3070 if ( $before == $after ) {
3075 wfSuppressWarnings();
3076 $haveDiff = $wgDiff && file_exists( $wgDiff );
3077 wfRestoreWarnings();
3079 # This check may also protect against code injection in
3080 # case of broken installations.
3082 wfDebug( "diff executable not found\n" );
3083 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
3084 $format = new UnifiedDiffFormatter();
3085 return $format->format( $diffs );
3088 # Make temporary files
3090 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
3091 $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
3093 fwrite( $oldtextFile, $before );
3094 fclose( $oldtextFile );
3095 fwrite( $newtextFile, $after );
3096 fclose( $newtextFile );
3098 // Get the diff of the two files
3099 $cmd = "$wgDiff " . $params . ' ' . wfEscapeShellArg( $oldtextName, $newtextName );
3101 $h = popen( $cmd, 'r' );
3106 $data = fread( $h, 8192 );
3107 if ( strlen( $data ) == 0 ) {
3115 unlink( $oldtextName );
3116 unlink( $newtextName );
3118 // Kill the --- and +++ lines. They're not useful.
3119 $diff_lines = explode( "\n", $diff );
3120 if ( isset( $diff_lines[0] ) && strpos( $diff_lines[0], '---' ) === 0 ) {
3121 unset( $diff_lines[0] );
3123 if ( isset( $diff_lines[1] ) && strpos( $diff_lines[1], '+++' ) === 0 ) {
3124 unset( $diff_lines[1] );
3127 $diff = implode( "\n", $diff_lines );
3133 * This function works like "use VERSION" in Perl, the program will die with a
3134 * backtrace if the current version of PHP is less than the version provided
3136 * This is useful for extensions which due to their nature are not kept in sync
3137 * with releases, and might depend on other versions of PHP than the main code
3139 * Note: PHP might die due to parsing errors in some cases before it ever
3140 * manages to call this function, such is life
3142 * @see perldoc -f use
3144 * @param string|int|float $req_ver The version to check, can be a string, an integer, or a float
3145 * @throws MWException
3147 function wfUsePHP( $req_ver ) {
3148 $php_ver = PHP_VERSION
;
3150 if ( version_compare( $php_ver, (string)$req_ver, '<' ) ) {
3151 throw new MWException( "PHP $req_ver required--this is only $php_ver" );
3156 * This function works like "use VERSION" in Perl except it checks the version
3157 * of MediaWiki, the program will die with a backtrace if the current version
3158 * of MediaWiki is less than the version provided.
3160 * This is useful for extensions which due to their nature are not kept in sync
3163 * Note: Due to the behavior of PHP's version_compare() which is used in this
3164 * function, if you want to allow the 'wmf' development versions add a 'c' (or
3165 * any single letter other than 'a', 'b' or 'p') as a post-fix to your
3166 * targeted version number. For example if you wanted to allow any variation
3167 * of 1.22 use `wfUseMW( '1.22c' )`. Using an 'a' or 'b' instead of 'c' will
3168 * not result in the same comparison due to the internal logic of
3169 * version_compare().
3171 * @see perldoc -f use
3173 * @param string|int|float $req_ver The version to check, can be a string, an integer, or a float
3174 * @throws MWException
3176 function wfUseMW( $req_ver ) {
3179 if ( version_compare( $wgVersion, (string)$req_ver, '<' ) ) {
3180 throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
3185 * Return the final portion of a pathname.
3186 * Reimplemented because PHP5's "basename()" is buggy with multibyte text.
3187 * http://bugs.php.net/bug.php?id=33898
3189 * PHP's basename() only considers '\' a pathchar on Windows and Netware.
3190 * We'll consider it so always, as we don't want '\s' in our Unix paths either.
3192 * @param string $path
3193 * @param string $suffix String to remove if present
3196 function wfBaseName( $path, $suffix = '' ) {
3197 if ( $suffix == '' ) {
3200 $encSuffix = '(?:' . preg_quote( $suffix, '#' ) . ')?';
3204 if ( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
3212 * Generate a relative path name to the given file.
3213 * May explode on non-matching case-insensitive paths,
3214 * funky symlinks, etc.
3216 * @param string $path Absolute destination path including target filename
3217 * @param string $from Absolute source path, directory only
3220 function wfRelativePath( $path, $from ) {
3221 // Normalize mixed input on Windows...
3222 $path = str_replace( '/', DIRECTORY_SEPARATOR
, $path );
3223 $from = str_replace( '/', DIRECTORY_SEPARATOR
, $from );
3225 // Trim trailing slashes -- fix for drive root
3226 $path = rtrim( $path, DIRECTORY_SEPARATOR
);
3227 $from = rtrim( $from, DIRECTORY_SEPARATOR
);
3229 $pieces = explode( DIRECTORY_SEPARATOR
, dirname( $path ) );
3230 $against = explode( DIRECTORY_SEPARATOR
, $from );
3232 if ( $pieces[0] !== $against[0] ) {
3233 // Non-matching Windows drive letters?
3234 // Return a full path.
3238 // Trim off common prefix
3239 while ( count( $pieces ) && count( $against )
3240 && $pieces[0] == $against[0] ) {
3241 array_shift( $pieces );
3242 array_shift( $against );
3245 // relative dots to bump us to the parent
3246 while ( count( $against ) ) {
3247 array_unshift( $pieces, '..' );
3248 array_shift( $against );
3251 array_push( $pieces, wfBaseName( $path ) );
3253 return implode( DIRECTORY_SEPARATOR
, $pieces );
3257 * Convert an arbitrarily-long digit string from one numeric base
3258 * to another, optionally zero-padding to a minimum column width.
3260 * Supports base 2 through 36; digit values 10-36 are represented
3261 * as lowercase letters a-z. Input is case-insensitive.
3263 * @param string $input Input number
3264 * @param int $sourceBase Base of the input number
3265 * @param int $destBase Desired base of the output
3266 * @param int $pad Minimum number of digits in the output (pad with zeroes)
3267 * @param bool $lowercase Whether to output in lowercase or uppercase
3268 * @param string $engine Either "gmp", "bcmath", or "php"
3269 * @return string|bool The output number as a string, or false on error
3271 function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1,
3272 $lowercase = true, $engine = 'auto'
3274 $input = (string)$input;
3280 $sourceBase != (int)$sourceBase ||
3281 $destBase != (int)$destBase ||
3282 $pad != (int)$pad ||
3284 "/^[" . substr( '0123456789abcdefghijklmnopqrstuvwxyz', 0, $sourceBase ) . "]+$/i",
3291 static $baseChars = array(
3292 10 => 'a', 11 => 'b', 12 => 'c', 13 => 'd', 14 => 'e', 15 => 'f',
3293 16 => 'g', 17 => 'h', 18 => 'i', 19 => 'j', 20 => 'k', 21 => 'l',
3294 22 => 'm', 23 => 'n', 24 => 'o', 25 => 'p', 26 => 'q', 27 => 'r',
3295 28 => 's', 29 => 't', 30 => 'u', 31 => 'v', 32 => 'w', 33 => 'x',
3296 34 => 'y', 35 => 'z',
3298 '0' => 0, '1' => 1, '2' => 2, '3' => 3, '4' => 4, '5' => 5,
3299 '6' => 6, '7' => 7, '8' => 8, '9' => 9, 'a' => 10, 'b' => 11,
3300 'c' => 12, 'd' => 13, 'e' => 14, 'f' => 15, 'g' => 16, 'h' => 17,
3301 'i' => 18, 'j' => 19, 'k' => 20, 'l' => 21, 'm' => 22, 'n' => 23,
3302 'o' => 24, 'p' => 25, 'q' => 26, 'r' => 27, 's' => 28, 't' => 29,
3303 'u' => 30, 'v' => 31, 'w' => 32, 'x' => 33, 'y' => 34, 'z' => 35
3306 if ( extension_loaded( 'gmp' ) && ( $engine == 'auto' ||
$engine == 'gmp' ) ) {
3307 // Removing leading zeros works around broken base detection code in
3308 // some PHP versions (see <https://bugs.php.net/bug.php?id=50175> and
3309 // <https://bugs.php.net/bug.php?id=55398>).
3310 $result = gmp_strval( gmp_init( ltrim( $input, '0' ), $sourceBase ), $destBase );
3311 } elseif ( extension_loaded( 'bcmath' ) && ( $engine == 'auto' ||
$engine == 'bcmath' ) ) {
3313 foreach ( str_split( strtolower( $input ) ) as $char ) {
3314 $decimal = bcmul( $decimal, $sourceBase );
3315 $decimal = bcadd( $decimal, $baseChars[$char] );
3318 // @codingStandardsIgnoreStart Generic.CodeAnalysis.ForLoopWithTestFunctionCall.NotAllowed
3319 for ( $result = ''; bccomp( $decimal, 0 ); $decimal = bcdiv( $decimal, $destBase, 0 ) ) {
3320 $result .= $baseChars[bcmod( $decimal, $destBase )];
3322 // @codingStandardsIgnoreEnd
3324 $result = strrev( $result );
3326 $inDigits = array();
3327 foreach ( str_split( strtolower( $input ) ) as $char ) {
3328 $inDigits[] = $baseChars[$char];
3331 // Iterate over the input, modulo-ing out an output digit
3332 // at a time until input is gone.
3334 while ( $inDigits ) {
3336 $workDigits = array();
3339 foreach ( $inDigits as $digit ) {
3340 $work *= $sourceBase;
3343 if ( $workDigits ||
$work >= $destBase ) {
3344 $workDigits[] = (int)( $work / $destBase );
3349 // All that division leaves us with a remainder,
3350 // which is conveniently our next output digit.
3351 $result .= $baseChars[$work];
3354 $inDigits = $workDigits;
3357 $result = strrev( $result );
3360 if ( !$lowercase ) {
3361 $result = strtoupper( $result );
3364 return str_pad( $result, $pad, '0', STR_PAD_LEFT
);
3368 * Check if there is sufficient entropy in php's built-in session generation
3370 * @return bool True = there is sufficient entropy
3372 function wfCheckEntropy() {
3374 ( wfIsWindows() && version_compare( PHP_VERSION
, '5.3.3', '>=' ) )
3375 ||
ini_get( 'session.entropy_file' )
3377 && intval( ini_get( 'session.entropy_length' ) ) >= 32;
3381 * Override session_id before session startup if php's built-in
3382 * session generation code is not secure.
3384 function wfFixSessionID() {
3385 // If the cookie or session id is already set we already have a session and should abort
3386 if ( isset( $_COOKIE[session_name()] ) ||
session_id() ) {
3390 // PHP's built-in session entropy is enabled if:
3391 // - entropy_file is set or you're on Windows with php 5.3.3+
3392 // - AND entropy_length is > 0
3393 // We treat it as disabled if it doesn't have an entropy length of at least 32
3394 $entropyEnabled = wfCheckEntropy();
3396 // If built-in entropy is not enabled or not sufficient override PHP's
3397 // built in session id generation code
3398 if ( !$entropyEnabled ) {
3399 wfDebug( __METHOD__
. ": PHP's built in entropy is disabled or not sufficient, " .
3400 "overriding session id generation using our cryptrand source.\n" );
3401 session_id( MWCryptRand
::generateHex( 32 ) );
3406 * Reset the session_id
3410 function wfResetSessionID() {
3411 global $wgCookieSecure;
3412 $oldSessionId = session_id();
3413 $cookieParams = session_get_cookie_params();
3414 if ( wfCheckEntropy() && $wgCookieSecure == $cookieParams['secure'] ) {
3415 session_regenerate_id( false );
3419 wfSetupSession( MWCryptRand
::generateHex( 32 ) );
3422 $newSessionId = session_id();
3423 Hooks
::run( 'ResetSessionID', array( $oldSessionId, $newSessionId ) );
3427 * Initialise php session
3429 * @param bool $sessionId
3431 function wfSetupSession( $sessionId = false ) {
3432 global $wgSessionsInMemcached, $wgSessionsInObjectCache, $wgCookiePath, $wgCookieDomain,
3433 $wgCookieSecure, $wgCookieHttpOnly, $wgSessionHandler;
3434 if ( $wgSessionsInObjectCache ||
$wgSessionsInMemcached ) {
3435 ObjectCacheSessionHandler
::install();
3436 } elseif ( $wgSessionHandler && $wgSessionHandler != ini_get( 'session.save_handler' ) ) {
3437 # Only set this if $wgSessionHandler isn't null and session.save_handler
3438 # hasn't already been set to the desired value (that causes errors)
3439 ini_set( 'session.save_handler', $wgSessionHandler );
3441 session_set_cookie_params(
3442 0, $wgCookiePath, $wgCookieDomain, $wgCookieSecure, $wgCookieHttpOnly );
3443 session_cache_limiter( 'private, must-revalidate' );
3445 session_id( $sessionId );
3449 wfSuppressWarnings();
3451 wfRestoreWarnings();
3455 * Get an object from the precompiled serialized directory
3457 * @param string $name
3458 * @return mixed The variable on success, false on failure
3460 function wfGetPrecompiledData( $name ) {
3463 $file = "$IP/serialized/$name";
3464 if ( file_exists( $file ) ) {
3465 $blob = file_get_contents( $file );
3467 return unserialize( $blob );
3476 * @param string $args,...
3479 function wfMemcKey( /*...*/ ) {
3480 global $wgCachePrefix;
3481 $prefix = $wgCachePrefix === false ?
wfWikiID() : $wgCachePrefix;
3482 $args = func_get_args();
3483 $key = $prefix . ':' . implode( ':', $args );
3484 $key = str_replace( ' ', '_', $key );
3489 * Get a cache key for a foreign DB
3492 * @param string $prefix
3493 * @param string $args,...
3496 function wfForeignMemcKey( $db, $prefix /*...*/ ) {
3497 $args = array_slice( func_get_args(), 2 );
3499 $key = "$db-$prefix:" . implode( ':', $args );
3501 $key = $db . ':' . implode( ':', $args );
3503 return str_replace( ' ', '_', $key );
3507 * Get an ASCII string identifying this wiki
3508 * This is used as a prefix in memcached keys
3512 function wfWikiID() {
3513 global $wgDBprefix, $wgDBname;
3514 if ( $wgDBprefix ) {
3515 return "$wgDBname-$wgDBprefix";
3522 * Split a wiki ID into DB name and table prefix
3524 * @param string $wiki
3528 function wfSplitWikiID( $wiki ) {
3529 $bits = explode( '-', $wiki, 2 );
3530 if ( count( $bits ) < 2 ) {
3537 * Get a Database object.
3539 * @param int $db Index of the connection to get. May be DB_MASTER for the
3540 * master (for write queries), DB_SLAVE for potentially lagged read
3541 * queries, or an integer >= 0 for a particular server.
3543 * @param string|string[] $groups Query groups. An array of group names that this query
3544 * belongs to. May contain a single string if the query is only
3547 * @param string|bool $wiki The wiki ID, or false for the current wiki
3549 * Note: multiple calls to wfGetDB(DB_SLAVE) during the course of one request
3550 * will always return the same object, unless the underlying connection or load
3551 * balancer is manually destroyed.
3553 * Note 2: use $this->getDB() in maintenance scripts that may be invoked by
3554 * updater to ensure that a proper database is being updated.
3556 * @return DatabaseBase
3558 function wfGetDB( $db, $groups = array(), $wiki = false ) {
3559 return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
3563 * Get a load balancer object.
3565 * @param string|bool $wiki Wiki ID, or false for the current wiki
3566 * @return LoadBalancer
3568 function wfGetLB( $wiki = false ) {
3569 return wfGetLBFactory()->getMainLB( $wiki );
3573 * Get the load balancer factory object
3577 function wfGetLBFactory() {
3578 return LBFactory
::singleton();
3583 * Shortcut for RepoGroup::singleton()->findFile()
3585 * @param string $title String or Title object
3586 * @param array $options Associative array of options:
3587 * time: requested time for an archived image, or false for the
3588 * current version. An image object will be returned which was
3589 * created at the specified time.
3591 * ignoreRedirect: If true, do not follow file redirects
3593 * private: If true, return restricted (deleted) files if the current
3594 * user is allowed to view them. Otherwise, such files will not
3597 * bypassCache: If true, do not use the process-local cache of File objects
3599 * @return File|bool File, or false if the file does not exist
3601 function wfFindFile( $title, $options = array() ) {
3602 return RepoGroup
::singleton()->findFile( $title, $options );
3606 * Get an object referring to a locally registered file.
3607 * Returns a valid placeholder object if the file does not exist.
3609 * @param Title|string $title
3610 * @return LocalFile|null A File, or null if passed an invalid Title
3612 function wfLocalFile( $title ) {
3613 return RepoGroup
::singleton()->getLocalRepo()->newFile( $title );
3617 * Should low-performance queries be disabled?
3620 * @codeCoverageIgnore
3622 function wfQueriesMustScale() {
3623 global $wgMiserMode;
3625 ||
( SiteStats
::pages() > 100000
3626 && SiteStats
::edits() > 1000000
3627 && SiteStats
::users() > 10000 );
3631 * Get the path to a specified script file, respecting file
3632 * extensions; this is a wrapper around $wgScriptExtension etc.
3633 * except for 'index' and 'load' which use $wgScript/$wgLoadScript
3635 * @param string $script Script filename, sans extension
3638 function wfScript( $script = 'index' ) {
3639 global $wgScriptPath, $wgScriptExtension, $wgScript, $wgLoadScript;
3640 if ( $script === 'index' ) {
3642 } elseif ( $script === 'load' ) {
3643 return $wgLoadScript;
3645 return "{$wgScriptPath}/{$script}{$wgScriptExtension}";
3650 * Get the script URL.
3652 * @return string Script URL
3654 function wfGetScriptUrl() {
3655 if ( isset( $_SERVER['SCRIPT_NAME'] ) ) {
3657 # as it was called, minus the query string.
3659 # Some sites use Apache rewrite rules to handle subdomains,
3660 # and have PHP set up in a weird way that causes PHP_SELF
3661 # to contain the rewritten URL instead of the one that the
3662 # outside world sees.
3664 # If in this mode, use SCRIPT_URL instead, which mod_rewrite
3665 # provides containing the "before" URL.
3666 return $_SERVER['SCRIPT_NAME'];
3668 return $_SERVER['URL'];
3673 * Convenience function converts boolean values into "true"
3674 * or "false" (string) values
3676 * @param bool $value
3679 function wfBoolToStr( $value ) {
3680 return $value ?
'true' : 'false';
3684 * Get a platform-independent path to the null file, e.g. /dev/null
3688 function wfGetNull() {
3689 return wfIsWindows() ?
'NUL' : '/dev/null';
3693 * Waits for the slaves to catch up to the master position
3695 * Use this when updating very large numbers of rows, as in maintenance scripts,
3696 * to avoid causing too much lag. Of course, this is a no-op if there are no slaves.
3698 * By default this waits on the main DB cluster of the current wiki.
3699 * If $cluster is set to "*" it will wait on all DB clusters, including
3700 * external ones. If the lag being waiting on is caused by the code that
3701 * does this check, it makes since to use $ifWritesSince, particularly if
3702 * cluster is "*", to avoid excess overhead.
3704 * Never call this function after a big DB write that is still in a transaction.
3705 * This only makes sense after the possible lag inducing changes were committed.
3707 * @param float|null $ifWritesSince Only wait if writes were done since this UNIX timestamp
3708 * @param string|bool $wiki Wiki identifier accepted by wfGetLB
3709 * @param string|bool $cluster Cluster name accepted by LBFactory. Default: false.
3710 * @param int|null $timeout Max wait time. Default: 1 day (cli), ~10 seconds (web)
3711 * @return bool Success (able to connect and no timeouts reached)
3713 function wfWaitForSlaves(
3714 $ifWritesSince = null, $wiki = false, $cluster = false, $timeout = null
3716 // B/C: first argument used to be "max seconds of lag"; ignore such values
3717 $ifWritesSince = ( $ifWritesSince > 1e9
) ?
$ifWritesSince : null;
3719 if ( $timeout === null ) {
3720 $timeout = ( PHP_SAPI
=== 'cli' ) ?
86400 : 10;
3723 // Figure out which clusters need to be checked
3725 if ( $cluster === '*' ) {
3726 wfGetLBFactory()->forEachLB( function ( LoadBalancer
$lb ) use ( &$lbs ) {
3729 } elseif ( $cluster !== false ) {
3730 $lbs[] = wfGetLBFactory()->getExternalLB( $cluster );
3732 $lbs[] = wfGetLB( $wiki );
3735 // Get all the master positions of applicable DBs right now.
3736 // This can be faster since waiting on one cluster reduces the
3737 // time needed to wait on the next clusters.
3738 $masterPositions = array_fill( 0, count( $lbs ), false );
3739 foreach ( $lbs as $i => $lb ) {
3740 // bug 27975 - Don't try to wait for slaves if there are none
3741 // Prevents permission error when getting master position
3742 if ( $lb->getServerCount() > 1 ) {
3743 if ( $ifWritesSince && !$lb->hasMasterConnection() ) {
3744 continue; // assume no writes done
3746 // Use the empty string to not trigger selectDB() since the connection
3747 // may have been to a server that does not have a DB for the current wiki.
3748 $dbw = $lb->getConnection( DB_MASTER
, array(), '' );
3749 if ( $ifWritesSince && $dbw->lastDoneWrites() < $ifWritesSince ) {
3750 continue; // no writes since the last wait
3752 $masterPositions[$i] = $dbw->getMasterPos();
3757 foreach ( $lbs as $i => $lb ) {
3758 if ( $masterPositions[$i] ) {
3759 // The DBMS may not support getMasterPos() or the whole
3760 // load balancer might be fake (e.g. $wgAllDBsAreLocalhost).
3761 $ok = $lb->waitForAll( $masterPositions[$i], $timeout ) && $ok;
3769 * Count down from $seconds to zero on the terminal, with a one-second pause
3770 * between showing each number. For use in command-line scripts.
3772 * @codeCoverageIgnore
3773 * @param int $seconds
3775 function wfCountDown( $seconds ) {
3776 for ( $i = $seconds; $i >= 0; $i-- ) {
3777 if ( $i != $seconds ) {
3778 echo str_repeat( "\x08", strlen( $i +
1 ) );
3790 * Replace all invalid characters with -
3791 * Additional characters can be defined in $wgIllegalFileChars (see bug 20489)
3792 * By default, $wgIllegalFileChars = ':'
3794 * @param string $name Filename to process
3797 function wfStripIllegalFilenameChars( $name ) {
3798 global $wgIllegalFileChars;
3799 $illegalFileChars = $wgIllegalFileChars ?
"|[" . $wgIllegalFileChars . "]" : '';
3800 $name = wfBaseName( $name );
3801 $name = preg_replace(
3802 "/[^" . Title
::legalChars() . "]" . $illegalFileChars . "/",
3810 * Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit;
3812 * @return int Value the memory limit was set to.
3814 function wfMemoryLimit() {
3815 global $wgMemoryLimit;
3816 $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
3817 if ( $memlimit != -1 ) {
3818 $conflimit = wfShorthandToInteger( $wgMemoryLimit );
3819 if ( $conflimit == -1 ) {
3820 wfDebug( "Removing PHP's memory limit\n" );
3821 wfSuppressWarnings();
3822 ini_set( 'memory_limit', $conflimit );
3823 wfRestoreWarnings();
3825 } elseif ( $conflimit > $memlimit ) {
3826 wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
3827 wfSuppressWarnings();
3828 ini_set( 'memory_limit', $conflimit );
3829 wfRestoreWarnings();
3837 * Converts shorthand byte notation to integer form
3839 * @param string $string
3842 function wfShorthandToInteger( $string = '' ) {
3843 $string = trim( $string );
3844 if ( $string === '' ) {
3847 $last = $string[strlen( $string ) - 1];
3848 $val = intval( $string );
3853 // break intentionally missing
3857 // break intentionally missing
3867 * Get the normalised IETF language tag
3868 * See unit test for examples.
3870 * @param string $code The language code.
3871 * @return string The language code which complying with BCP 47 standards.
3873 function wfBCP47( $code ) {
3874 $codeSegment = explode( '-', $code );
3876 foreach ( $codeSegment as $segNo => $seg ) {
3877 // when previous segment is x, it is a private segment and should be lc
3878 if ( $segNo > 0 && strtolower( $codeSegment[( $segNo - 1 )] ) == 'x' ) {
3879 $codeBCP[$segNo] = strtolower( $seg );
3880 // ISO 3166 country code
3881 } elseif ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) {
3882 $codeBCP[$segNo] = strtoupper( $seg );
3883 // ISO 15924 script code
3884 } elseif ( ( strlen( $seg ) == 4 ) && ( $segNo > 0 ) ) {
3885 $codeBCP[$segNo] = ucfirst( strtolower( $seg ) );
3886 // Use lowercase for other cases
3888 $codeBCP[$segNo] = strtolower( $seg );
3891 $langCode = implode( '-', $codeBCP );
3896 * Get a cache object.
3898 * @param int $inputType Cache type, one of the CACHE_* constants.
3901 function wfGetCache( $inputType ) {
3902 return ObjectCache
::getInstance( $inputType );
3906 * Get the main cache object
3910 function wfGetMainCache() {
3911 global $wgMainCacheType;
3912 return ObjectCache
::getInstance( $wgMainCacheType );
3916 * Get the cache object used by the message cache
3920 function wfGetMessageCacheStorage() {
3921 global $wgMessageCacheType;
3922 return ObjectCache
::getInstance( $wgMessageCacheType );
3926 * Get the cache object used by the parser cache
3930 function wfGetParserCacheStorage() {
3931 global $wgParserCacheType;
3932 return ObjectCache
::getInstance( $wgParserCacheType );
3936 * Get the cache object used by the language converter
3940 function wfGetLangConverterCacheStorage() {
3941 global $wgLanguageConverterCacheType;
3942 return ObjectCache
::getInstance( $wgLanguageConverterCacheType );
3946 * Call hook functions defined in $wgHooks
3948 * @param string $event Event name
3949 * @param array $args Parameters passed to hook functions
3950 * @param string|null $deprecatedVersion Optionally mark hook as deprecated with version number
3952 * @return bool True if no handler aborted the hook
3955 function wfRunHooks( $event, array $args = array(), $deprecatedVersion = null ) {
3956 return Hooks
::run( $event, $args, $deprecatedVersion );
3960 * Wrapper around php's unpack.
3962 * @param string $format The format string (See php's docs)
3963 * @param string $data A binary string of binary data
3964 * @param int|bool $length The minimum length of $data or false. This is to
3965 * prevent reading beyond the end of $data. false to disable the check.
3967 * Also be careful when using this function to read unsigned 32 bit integer
3968 * because php might make it negative.
3970 * @throws MWException If $data not long enough, or if unpack fails
3971 * @return array Associative array of the extracted data
3973 function wfUnpack( $format, $data, $length = false ) {
3974 if ( $length !== false ) {
3975 $realLen = strlen( $data );
3976 if ( $realLen < $length ) {
3977 throw new MWException( "Tried to use wfUnpack on a "
3978 . "string of length $realLen, but needed one "
3979 . "of at least length $length."
3984 wfSuppressWarnings();
3985 $result = unpack( $format, $data );
3986 wfRestoreWarnings();
3988 if ( $result === false ) {
3989 // If it cannot extract the packed data.
3990 throw new MWException( "unpack could not unpack binary data" );
3996 * Determine if an image exists on the 'bad image list'.
3998 * The format of MediaWiki:Bad_image_list is as follows:
3999 * * Only list items (lines starting with "*") are considered
4000 * * The first link on a line must be a link to a bad image
4001 * * Any subsequent links on the same line are considered to be exceptions,
4002 * i.e. articles where the image may occur inline.
4004 * @param string $name The image name to check
4005 * @param Title|bool $contextTitle The page on which the image occurs, if known
4006 * @param string $blacklist Wikitext of a file blacklist
4009 function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
4010 static $badImageCache = null; // based on bad_image_list msg
4013 $redirectTitle = RepoGroup
::singleton()->checkRedirect( Title
::makeTitle( NS_FILE
, $name ) );
4014 if ( $redirectTitle ) {
4015 $name = $redirectTitle->getDBkey();
4018 # Run the extension hook
4020 if ( !Hooks
::run( 'BadImage', array( $name, &$bad ) ) ) {
4024 $cacheable = ( $blacklist === null );
4025 if ( $cacheable && $badImageCache !== null ) {
4026 $badImages = $badImageCache;
4027 } else { // cache miss
4028 if ( $blacklist === null ) {
4029 $blacklist = wfMessage( 'bad_image_list' )->inContentLanguage()->plain(); // site list
4031 # Build the list now
4032 $badImages = array();
4033 $lines = explode( "\n", $blacklist );
4034 foreach ( $lines as $line ) {
4036 if ( substr( $line, 0, 1 ) !== '*' ) {
4042 if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
4046 $exceptions = array();
4047 $imageDBkey = false;
4048 foreach ( $m[1] as $i => $titleText ) {
4049 $title = Title
::newFromText( $titleText );
4050 if ( !is_null( $title ) ) {
4052 $imageDBkey = $title->getDBkey();
4054 $exceptions[$title->getPrefixedDBkey()] = true;
4059 if ( $imageDBkey !== false ) {
4060 $badImages[$imageDBkey] = $exceptions;
4064 $badImageCache = $badImages;
4068 $contextKey = $contextTitle ?
$contextTitle->getPrefixedDBkey() : false;
4069 $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
4074 * Determine whether the client at a given source IP is likely to be able to
4075 * access the wiki via HTTPS.
4077 * @param string $ip The IPv4/6 address in the normal human-readable form
4080 function wfCanIPUseHTTPS( $ip ) {
4082 Hooks
::run( 'CanIPUseHTTPS', array( $ip, &$canDo ) );
4087 * Work out the IP address based on various globals
4088 * For trusted proxies, use the XFF client IP (first of the chain)
4090 * @deprecated since 1.19; call $wgRequest->getIP() directly.
4093 function wfGetIP() {
4094 wfDeprecated( __METHOD__
, '1.19' );
4096 return $wgRequest->getIP();
4100 * Checks if an IP is a trusted proxy provider.
4101 * Useful to tell if X-Forwarded-For data is possibly bogus.
4102 * Squid cache servers for the site are whitelisted.
4103 * @deprecated Since 1.24, use IP::isTrustedProxy()
4108 function wfIsTrustedProxy( $ip ) {
4109 wfDeprecated( __METHOD__
, '1.24' );
4110 return IP
::isTrustedProxy( $ip );
4114 * Checks if an IP matches a proxy we've configured.
4115 * @deprecated Since 1.24, use IP::isConfiguredProxy()
4119 * @since 1.23 Supports CIDR ranges in $wgSquidServersNoPurge
4121 function wfIsConfiguredProxy( $ip ) {
4122 wfDeprecated( __METHOD__
, '1.24' );
4123 return IP
::isConfiguredProxy( $ip );