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.2 and up.
34 * Re-implementations of newer functions or functions in non-standard
35 * PHP extensions may be included here.
38 if ( !function_exists( 'iconv' ) ) {
43 function iconv( $from, $to, $string ) {
44 return Fallback
::iconv( $from, $to, $string );
48 if ( !function_exists( 'mb_substr' ) ) {
53 function mb_substr( $str, $start, $count = 'end' ) {
54 return Fallback
::mb_substr( $str, $start, $count );
61 function mb_substr_split_unicode( $str, $splitPos ) {
62 return Fallback
::mb_substr_split_unicode( $str, $splitPos );
66 if ( !function_exists( 'mb_strlen' ) ) {
71 function mb_strlen( $str, $enc = '' ) {
72 return Fallback
::mb_strlen( $str, $enc );
76 if ( !function_exists( 'mb_strpos' ) ) {
81 function mb_strpos( $haystack, $needle, $offset = 0, $encoding = '' ) {
82 return Fallback
::mb_strpos( $haystack, $needle, $offset, $encoding );
86 if ( !function_exists( 'mb_strrpos' ) ) {
91 function mb_strrpos( $haystack, $needle, $offset = 0, $encoding = '' ) {
92 return Fallback
::mb_strrpos( $haystack, $needle, $offset, $encoding );
96 // gzdecode function only exists in PHP >= 5.4.0
97 // http://php.net/gzdecode
98 if ( !function_exists( 'gzdecode' ) ) {
100 * @codeCoverageIgnore
103 function gzdecode( $data ) {
104 return gzinflate( substr( $data, 10, -8 ) );
108 // hash_equals function only exists in PHP >= 5.6.0
109 if ( !function_exists( 'hash_equals' ) ) {
111 * Check whether a user-provided string is equal to a fixed-length secret without
112 * revealing bytes of the secret through timing differences.
114 * This timing guarantee -- that a partial match takes the same time as a complete
115 * mismatch -- is why this function is used in some security-sensitive parts of the code.
116 * For example, it shouldn't be possible to guess an HMAC signature one byte at a time.
118 * Longer explanation: http://www.emerose.com/timing-attacks-explained
120 * @codeCoverageIgnore
121 * @param string $known_string Fixed-length secret to compare against
122 * @param string $user_string User-provided string
123 * @return bool True if the strings are the same, false otherwise
125 function hash_equals( $known_string, $user_string ) {
126 // Strict type checking as in PHP's native implementation
127 if ( !is_string( $known_string ) ) {
128 trigger_error( 'hash_equals(): Expected known_string to be a string, ' .
129 gettype( $known_string ) . ' given', E_USER_WARNING
);
134 if ( !is_string( $user_string ) ) {
135 trigger_error( 'hash_equals(): Expected user_string to be a string, ' .
136 gettype( $user_string ) . ' given', E_USER_WARNING
);
141 // Note that we do one thing PHP doesn't: try to avoid leaking information about
142 // relative lengths of $known_string and $user_string, and of multiple $known_strings.
143 // However, lengths may still inevitably leak through, for example, CPU cache misses.
144 $known_string_len = strlen( $known_string );
145 $user_string_len = strlen( $user_string );
146 $result = $known_string_len ^
$user_string_len;
147 for ( $i = 0; $i < $user_string_len; $i++
) {
148 $result |
= ord( $known_string[$i %
$known_string_len] ) ^
ord( $user_string[$i] );
151 return ( $result === 0 );
157 * Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
162 function wfArrayDiff2( $a, $b ) {
163 return array_udiff( $a, $b, 'wfArrayDiff2_cmp' );
167 * @param array|string $a
168 * @param array|string $b
171 function wfArrayDiff2_cmp( $a, $b ) {
172 if ( is_string( $a ) && is_string( $b ) ) {
173 return strcmp( $a, $b );
174 } elseif ( count( $a ) !== count( $b ) ) {
175 return count( $a ) < count( $b ) ?
-1 : 1;
179 while ( ( list( , $valueA ) = each( $a ) ) && ( list( , $valueB ) = each( $b ) ) ) {
180 $cmp = strcmp( $valueA, $valueB );
191 * Returns an array where the values in array $b are replaced by the
192 * values in array $a with the corresponding keys
194 * @deprecated since 1.22; use array_intersect_key()
199 function wfArrayLookup( $a, $b ) {
200 wfDeprecated( __FUNCTION__
, '1.22' );
201 return array_flip( array_intersect( array_flip( $a ), array_keys( $b ) ) );
205 * Appends to second array if $value differs from that in $default
207 * @param string|int $key
208 * @param mixed $value
209 * @param mixed $default
210 * @param array $changed Array to alter
211 * @throws MWException
213 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
214 if ( is_null( $changed ) ) {
215 throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' );
217 if ( $default[$key] !== $value ) {
218 $changed[$key] = $value;
223 * Backwards array plus for people who haven't bothered to read the PHP manual
224 * XXX: will not darn your socks for you.
226 * @deprecated since 1.22; use array_replace()
228 * @param array $array1 Initial array to merge.
229 * @param array [$array2,...] Variable list of arrays to merge.
232 function wfArrayMerge( $array1 /*...*/ ) {
233 wfDeprecated( __FUNCTION__
, '1.22' );
234 $args = func_get_args();
235 $args = array_reverse( $args, true );
237 foreach ( $args as $arg ) {
244 * Merge arrays in the style of getUserPermissionsErrors, with duplicate removal
246 * wfMergeErrorArrays(
247 * array( array( 'x' ) ),
248 * array( array( 'x', '2' ) ),
249 * array( array( 'x' ) ),
250 * array( array( 'y' ) )
259 * @param array [$array1,...]
262 function wfMergeErrorArrays( /*...*/ ) {
263 $args = func_get_args();
265 foreach ( $args as $errors ) {
266 foreach ( $errors as $params ) {
267 # @todo FIXME: Sometimes get nested arrays for $params,
268 # which leads to E_NOTICEs
269 $spec = implode( "\t", $params );
270 $out[$spec] = $params;
273 return array_values( $out );
277 * Insert array into another array after the specified *KEY*
279 * @param array $array The array.
280 * @param array $insert The array to insert.
281 * @param mixed $after The key to insert after
284 function wfArrayInsertAfter( array $array, array $insert, $after ) {
285 // Find the offset of the element to insert after.
286 $keys = array_keys( $array );
287 $offsetByKey = array_flip( $keys );
289 $offset = $offsetByKey[$after];
291 // Insert at the specified offset
292 $before = array_slice( $array, 0, $offset +
1, true );
293 $after = array_slice( $array, $offset +
1, count( $array ) - $offset, true );
295 $output = $before +
$insert +
$after;
301 * Recursively converts the parameter (an object) to an array with the same data
303 * @param object|array $objOrArray
304 * @param bool $recursive
307 function wfObjectToArray( $objOrArray, $recursive = true ) {
309 if ( is_object( $objOrArray ) ) {
310 $objOrArray = get_object_vars( $objOrArray );
312 foreach ( $objOrArray as $key => $value ) {
313 if ( $recursive && ( is_object( $value ) ||
is_array( $value ) ) ) {
314 $value = wfObjectToArray( $value );
317 $array[$key] = $value;
324 * Get a random decimal value between 0 and 1, in a way
325 * not likely to give duplicate values for any realistic
326 * number of articles.
330 function wfRandom() {
331 # The maximum random value is "only" 2^31-1, so get two random
332 # values to reduce the chance of dupes
333 $max = mt_getrandmax() +
1;
334 $rand = number_format( ( mt_rand() * $max +
mt_rand() ) / $max / $max, 12, '.', '' );
340 * Get a random string containing a number of pseudo-random hex
342 * @note This is not secure, if you are trying to generate some sort
343 * of token please use MWCryptRand instead.
345 * @param int $length The length of the string to generate
349 function wfRandomString( $length = 32 ) {
351 for ( $n = 0; $n < $length; $n +
= 7 ) {
352 $str .= sprintf( '%07x', mt_rand() & 0xfffffff );
354 return substr( $str, 0, $length );
358 * We want some things to be included as literal characters in our title URLs
359 * for prettiness, which urlencode encodes by default. According to RFC 1738,
360 * all of the following should be safe:
364 * But + is not safe because it's used to indicate a space; &= are only safe in
365 * paths and not in queries (and we don't distinguish here); ' seems kind of
366 * scary; and urlencode() doesn't touch -_. to begin with. Plus, although /
367 * is reserved, we don't care. So the list we unescape is:
371 * However, IIS7 redirects fail when the url contains a colon (Bug 22709),
372 * so no fancy : for IIS7.
374 * %2F in the page titles seems to fatally break for some reason.
379 function wfUrlencode( $s ) {
382 if ( is_null( $s ) ) {
387 if ( is_null( $needle ) ) {
388 $needle = array( '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F' );
389 if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) ||
390 ( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false )
396 $s = urlencode( $s );
399 array( ';', '@', '$', '!', '*', '(', ')', ',', '/', ':' ),
407 * This function takes two arrays as input, and returns a CGI-style string, e.g.
408 * "days=7&limit=100". Options in the first array override options in the second.
409 * Options set to null or false will not be output.
411 * @param array $array1 ( String|Array )
412 * @param array $array2 ( String|Array )
413 * @param string $prefix
416 function wfArrayToCgi( $array1, $array2 = null, $prefix = '' ) {
417 if ( !is_null( $array2 ) ) {
418 $array1 = $array1 +
$array2;
422 foreach ( $array1 as $key => $value ) {
423 if ( !is_null( $value ) && $value !== false ) {
427 if ( $prefix !== '' ) {
428 $key = $prefix . "[$key]";
430 if ( is_array( $value ) ) {
432 foreach ( $value as $k => $v ) {
433 $cgi .= $firstTime ?
'' : '&';
434 if ( is_array( $v ) ) {
435 $cgi .= wfArrayToCgi( $v, null, $key . "[$k]" );
437 $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v );
442 if ( is_object( $value ) ) {
443 $value = $value->__toString();
445 $cgi .= urlencode( $key ) . '=' . urlencode( $value );
453 * This is the logical opposite of wfArrayToCgi(): it accepts a query string as
454 * its argument and returns the same string in array form. This allows compatibility
455 * with legacy functions that accept raw query strings instead of nice
456 * arrays. Of course, keys and values are urldecode()d.
458 * @param string $query Query string
459 * @return string[] Array version of input
461 function wfCgiToArray( $query ) {
462 if ( isset( $query[0] ) && $query[0] == '?' ) {
463 $query = substr( $query, 1 );
465 $bits = explode( '&', $query );
467 foreach ( $bits as $bit ) {
471 if ( strpos( $bit, '=' ) === false ) {
472 // Pieces like &qwerty become 'qwerty' => '' (at least this is what php does)
476 list( $key, $value ) = explode( '=', $bit );
478 $key = urldecode( $key );
479 $value = urldecode( $value );
480 if ( strpos( $key, '[' ) !== false ) {
481 $keys = array_reverse( explode( '[', $key ) );
482 $key = array_pop( $keys );
484 foreach ( $keys as $k ) {
485 $k = substr( $k, 0, -1 );
486 $temp = array( $k => $temp );
488 if ( isset( $ret[$key] ) ) {
489 $ret[$key] = array_merge( $ret[$key], $temp );
501 * Append a query string to an existing URL, which may or may not already
502 * have query string parameters already. If so, they will be combined.
505 * @param string|string[] $query String or associative array
508 function wfAppendQuery( $url, $query ) {
509 if ( is_array( $query ) ) {
510 $query = wfArrayToCgi( $query );
512 if ( $query != '' ) {
513 if ( false === strpos( $url, '?' ) ) {
524 * Expand a potentially local URL to a fully-qualified URL. Assumes $wgServer
527 * The meaning of the PROTO_* constants is as follows:
528 * PROTO_HTTP: Output a URL starting with http://
529 * PROTO_HTTPS: Output a URL starting with https://
530 * PROTO_RELATIVE: Output a URL starting with // (protocol-relative URL)
531 * PROTO_CURRENT: Output a URL starting with either http:// or https:// , depending
532 * on which protocol was used for the current incoming request
533 * PROTO_CANONICAL: For URLs without a domain, like /w/index.php , use $wgCanonicalServer.
534 * For protocol-relative URLs, use the protocol of $wgCanonicalServer
535 * PROTO_INTERNAL: Like PROTO_CANONICAL, but uses $wgInternalServer instead of $wgCanonicalServer
537 * @todo this won't work with current-path-relative URLs
538 * like "subdir/foo.html", etc.
540 * @param string $url Either fully-qualified or a local path + query
541 * @param string $defaultProto One of the PROTO_* constants. Determines the
542 * protocol to use if $url or $wgServer is protocol-relative
543 * @return string Fully-qualified URL, current-path-relative URL or false if
544 * no valid URL can be constructed
546 function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT
) {
547 global $wgServer, $wgCanonicalServer, $wgInternalServer, $wgRequest,
549 if ( $defaultProto === PROTO_CANONICAL
) {
550 $serverUrl = $wgCanonicalServer;
551 } elseif ( $defaultProto === PROTO_INTERNAL
&& $wgInternalServer !== false ) {
552 // Make $wgInternalServer fall back to $wgServer if not set
553 $serverUrl = $wgInternalServer;
555 $serverUrl = $wgServer;
556 if ( $defaultProto === PROTO_CURRENT
) {
557 $defaultProto = $wgRequest->getProtocol() . '://';
561 // Analyze $serverUrl to obtain its protocol
562 $bits = wfParseUrl( $serverUrl );
563 $serverHasProto = $bits && $bits['scheme'] != '';
565 if ( $defaultProto === PROTO_CANONICAL ||
$defaultProto === PROTO_INTERNAL
) {
566 if ( $serverHasProto ) {
567 $defaultProto = $bits['scheme'] . '://';
569 // $wgCanonicalServer or $wgInternalServer doesn't have a protocol.
570 // This really isn't supposed to happen. Fall back to HTTP in this
572 $defaultProto = PROTO_HTTP
;
576 $defaultProtoWithoutSlashes = substr( $defaultProto, 0, -2 );
578 if ( substr( $url, 0, 2 ) == '//' ) {
579 $url = $defaultProtoWithoutSlashes . $url;
580 } elseif ( substr( $url, 0, 1 ) == '/' ) {
581 // If $serverUrl is protocol-relative, prepend $defaultProtoWithoutSlashes,
582 // otherwise leave it alone.
583 $url = ( $serverHasProto ?
'' : $defaultProtoWithoutSlashes ) . $serverUrl . $url;
586 $bits = wfParseUrl( $url );
588 // ensure proper port for HTTPS arrives in URL
589 // https://bugzilla.wikimedia.org/show_bug.cgi?id=65184
590 if ( $defaultProto === PROTO_HTTPS
&& $wgHttpsPort != 443 ) {
591 $bits['port'] = $wgHttpsPort;
594 if ( $bits && isset( $bits['path'] ) ) {
595 $bits['path'] = wfRemoveDotSegments( $bits['path'] );
596 return wfAssembleUrl( $bits );
600 } elseif ( substr( $url, 0, 1 ) != '/' ) {
601 # URL is a relative path
602 return wfRemoveDotSegments( $url );
605 # Expanded URL is not valid.
610 * This function will reassemble a URL parsed with wfParseURL. This is useful
611 * if you need to edit part of a URL and put it back together.
613 * This is the basic structure used (brackets contain keys for $urlParts):
614 * [scheme][delimiter][user]:[pass]@[host]:[port][path]?[query]#[fragment]
616 * @todo Need to integrate this into wfExpandUrl (bug 32168)
619 * @param array $urlParts URL parts, as output from wfParseUrl
620 * @return string URL assembled from its component parts
622 function wfAssembleUrl( $urlParts ) {
625 if ( isset( $urlParts['delimiter'] ) ) {
626 if ( isset( $urlParts['scheme'] ) ) {
627 $result .= $urlParts['scheme'];
630 $result .= $urlParts['delimiter'];
633 if ( isset( $urlParts['host'] ) ) {
634 if ( isset( $urlParts['user'] ) ) {
635 $result .= $urlParts['user'];
636 if ( isset( $urlParts['pass'] ) ) {
637 $result .= ':' . $urlParts['pass'];
642 $result .= $urlParts['host'];
644 if ( isset( $urlParts['port'] ) ) {
645 $result .= ':' . $urlParts['port'];
649 if ( isset( $urlParts['path'] ) ) {
650 $result .= $urlParts['path'];
653 if ( isset( $urlParts['query'] ) ) {
654 $result .= '?' . $urlParts['query'];
657 if ( isset( $urlParts['fragment'] ) ) {
658 $result .= '#' . $urlParts['fragment'];
665 * Remove all dot-segments in the provided URL path. For example,
666 * '/a/./b/../c/' becomes '/a/c/'. For details on the algorithm, please see
667 * RFC3986 section 5.2.4.
669 * @todo Need to integrate this into wfExpandUrl (bug 32168)
671 * @param string $urlPath URL path, potentially containing dot-segments
672 * @return string URL path with all dot-segments removed
674 function wfRemoveDotSegments( $urlPath ) {
677 $inputLength = strlen( $urlPath );
679 while ( $inputOffset < $inputLength ) {
680 $prefixLengthOne = substr( $urlPath, $inputOffset, 1 );
681 $prefixLengthTwo = substr( $urlPath, $inputOffset, 2 );
682 $prefixLengthThree = substr( $urlPath, $inputOffset, 3 );
683 $prefixLengthFour = substr( $urlPath, $inputOffset, 4 );
686 if ( $prefixLengthTwo == './' ) {
687 # Step A, remove leading "./"
689 } elseif ( $prefixLengthThree == '../' ) {
690 # Step A, remove leading "../"
692 } elseif ( ( $prefixLengthTwo == '/.' ) && ( $inputOffset +
2 == $inputLength ) ) {
693 # Step B, replace leading "/.$" with "/"
695 $urlPath[$inputOffset] = '/';
696 } elseif ( $prefixLengthThree == '/./' ) {
697 # Step B, replace leading "/./" with "/"
699 } elseif ( $prefixLengthThree == '/..' && ( $inputOffset +
3 == $inputLength ) ) {
700 # Step C, replace leading "/..$" with "/" and
701 # remove last path component in output
703 $urlPath[$inputOffset] = '/';
705 } elseif ( $prefixLengthFour == '/../' ) {
706 # Step C, replace leading "/../" with "/" and
707 # remove last path component in output
710 } elseif ( ( $prefixLengthOne == '.' ) && ( $inputOffset +
1 == $inputLength ) ) {
711 # Step D, remove "^.$"
713 } elseif ( ( $prefixLengthTwo == '..' ) && ( $inputOffset +
2 == $inputLength ) ) {
714 # Step D, remove "^..$"
717 # Step E, move leading path segment to output
718 if ( $prefixLengthOne == '/' ) {
719 $slashPos = strpos( $urlPath, '/', $inputOffset +
1 );
721 $slashPos = strpos( $urlPath, '/', $inputOffset );
723 if ( $slashPos === false ) {
724 $output .= substr( $urlPath, $inputOffset );
725 $inputOffset = $inputLength;
727 $output .= substr( $urlPath, $inputOffset, $slashPos - $inputOffset );
728 $inputOffset +
= $slashPos - $inputOffset;
733 $slashPos = strrpos( $output, '/' );
734 if ( $slashPos === false ) {
737 $output = substr( $output, 0, $slashPos );
746 * Returns a regular expression of url protocols
748 * @param bool $includeProtocolRelative If false, remove '//' from the returned protocol list.
749 * DO NOT USE this directly, use wfUrlProtocolsWithoutProtRel() instead
752 function wfUrlProtocols( $includeProtocolRelative = true ) {
753 global $wgUrlProtocols;
755 // Cache return values separately based on $includeProtocolRelative
756 static $withProtRel = null, $withoutProtRel = null;
757 $cachedValue = $includeProtocolRelative ?
$withProtRel : $withoutProtRel;
758 if ( !is_null( $cachedValue ) ) {
762 // Support old-style $wgUrlProtocols strings, for backwards compatibility
763 // with LocalSettings files from 1.5
764 if ( is_array( $wgUrlProtocols ) ) {
765 $protocols = array();
766 foreach ( $wgUrlProtocols as $protocol ) {
767 // Filter out '//' if !$includeProtocolRelative
768 if ( $includeProtocolRelative ||
$protocol !== '//' ) {
769 $protocols[] = preg_quote( $protocol, '/' );
773 $retval = implode( '|', $protocols );
775 // Ignore $includeProtocolRelative in this case
776 // This case exists for pre-1.6 compatibility, and we can safely assume
777 // that '//' won't appear in a pre-1.6 config because protocol-relative
778 // URLs weren't supported until 1.18
779 $retval = $wgUrlProtocols;
782 // Cache return value
783 if ( $includeProtocolRelative ) {
784 $withProtRel = $retval;
786 $withoutProtRel = $retval;
792 * Like wfUrlProtocols(), but excludes '//' from the protocol list. Use this if
793 * you need a regex that matches all URL protocols but does not match protocol-
797 function wfUrlProtocolsWithoutProtRel() {
798 return wfUrlProtocols( false );
802 * parse_url() work-alike, but non-broken. Differences:
804 * 1) Does not raise warnings on bad URLs (just returns false).
805 * 2) Handles protocols that don't use :// (e.g., mailto: and news:, as well as
806 * protocol-relative URLs) correctly.
807 * 3) Adds a "delimiter" element to the array, either '://', ':' or '//' (see (2)).
809 * @param string $url A URL to parse
810 * @return string[] Bits of the URL in an associative array, per PHP docs
812 function wfParseUrl( $url ) {
813 global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
815 // Protocol-relative URLs are handled really badly by parse_url(). It's so
816 // bad that the easiest way to handle them is to just prepend 'http:' and
817 // strip the protocol out later.
818 $wasRelative = substr( $url, 0, 2 ) == '//';
819 if ( $wasRelative ) {
822 wfSuppressWarnings();
823 $bits = parse_url( $url );
825 // parse_url() returns an array without scheme for some invalid URLs, e.g.
826 // parse_url("%0Ahttp://example.com") == array( 'host' => '%0Ahttp', 'path' => 'example.com' )
827 if ( !$bits ||
!isset( $bits['scheme'] ) ) {
831 // parse_url() incorrectly handles schemes case-sensitively. Convert it to lowercase.
832 $bits['scheme'] = strtolower( $bits['scheme'] );
834 // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
835 if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
836 $bits['delimiter'] = '://';
837 } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
838 $bits['delimiter'] = ':';
839 // parse_url detects for news: and mailto: the host part of an url as path
840 // We have to correct this wrong detection
841 if ( isset( $bits['path'] ) ) {
842 $bits['host'] = $bits['path'];
849 /* Provide an empty host for eg. file:/// urls (see bug 28627) */
850 if ( !isset( $bits['host'] ) ) {
854 if ( isset( $bits['path'] ) ) {
855 /* parse_url loses the third / for file:///c:/ urls (but not on variants) */
856 if ( substr( $bits['path'], 0, 1 ) !== '/' ) {
857 $bits['path'] = '/' . $bits['path'];
864 // If the URL was protocol-relative, fix scheme and delimiter
865 if ( $wasRelative ) {
866 $bits['scheme'] = '';
867 $bits['delimiter'] = '//';
873 * Take a URL, make sure it's expanded to fully qualified, and replace any
874 * encoded non-ASCII Unicode characters with their UTF-8 original forms
875 * for more compact display and legibility for local audiences.
877 * @todo handle punycode domains too
882 function wfExpandIRI( $url ) {
883 return preg_replace_callback(
884 '/((?:%[89A-F][0-9A-F])+)/i',
885 'wfExpandIRI_callback',
891 * Private callback for wfExpandIRI
892 * @param array $matches
895 function wfExpandIRI_callback( $matches ) {
896 return urldecode( $matches[1] );
900 * Make URL indexes, appropriate for the el_index field of externallinks.
905 function wfMakeUrlIndexes( $url ) {
906 $bits = wfParseUrl( $url );
908 // Reverse the labels in the hostname, convert to lower case
909 // For emails reverse domainpart only
910 if ( $bits['scheme'] == 'mailto' ) {
911 $mailparts = explode( '@', $bits['host'], 2 );
912 if ( count( $mailparts ) === 2 ) {
913 $domainpart = strtolower( implode( '.', array_reverse( explode( '.', $mailparts[1] ) ) ) );
915 // No domain specified, don't mangle it
918 $reversedHost = $domainpart . '@' . $mailparts[0];
920 $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) );
922 // Add an extra dot to the end
923 // Why? Is it in wrong place in mailto links?
924 if ( substr( $reversedHost, -1, 1 ) !== '.' ) {
925 $reversedHost .= '.';
927 // Reconstruct the pseudo-URL
928 $prot = $bits['scheme'];
929 $index = $prot . $bits['delimiter'] . $reversedHost;
930 // Leave out user and password. Add the port, path, query and fragment
931 if ( isset( $bits['port'] ) ) {
932 $index .= ':' . $bits['port'];
934 if ( isset( $bits['path'] ) ) {
935 $index .= $bits['path'];
939 if ( isset( $bits['query'] ) ) {
940 $index .= '?' . $bits['query'];
942 if ( isset( $bits['fragment'] ) ) {
943 $index .= '#' . $bits['fragment'];
947 return array( "http:$index", "https:$index" );
949 return array( $index );
954 * Check whether a given URL has a domain that occurs in a given set of domains
955 * @param string $url URL
956 * @param array $domains Array of domains (strings)
957 * @return bool True if the host part of $url ends in one of the strings in $domains
959 function wfMatchesDomainList( $url, $domains ) {
960 $bits = wfParseUrl( $url );
961 if ( is_array( $bits ) && isset( $bits['host'] ) ) {
962 $host = '.' . $bits['host'];
963 foreach ( (array)$domains as $domain ) {
964 $domain = '.' . $domain;
965 if ( substr( $host, -strlen( $domain ) ) === $domain ) {
974 * Sends a line to the debug log if enabled or, optionally, to a comment in output.
975 * In normal operation this is a NOP.
977 * Controlling globals:
978 * $wgDebugLogFile - points to the log file
979 * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
980 * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
982 * @param string $text
983 * @param string|bool $dest Destination of the message:
984 * - 'all': both to the log and HTML (debug toolbar or HTML comments)
985 * - 'log': only to the log and not in HTML
986 * For backward compatibility, it can also take a boolean:
987 * - true: same as 'all'
988 * - false: same as 'log'
990 function wfDebug( $text, $dest = 'all' ) {
991 global $wgDebugLogFile, $wgDebugRawPage, $wgDebugLogPrefix;
993 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
997 // Turn $dest into a string if it's a boolean (for b/c)
998 if ( $dest === true ) {
1000 } elseif ( $dest === false ) {
1004 $timer = wfDebugTimer();
1005 if ( $timer !== '' ) {
1006 $text = preg_replace( '/[^\n]/', $timer . '\0', $text, 1 );
1009 if ( $dest === 'all' ) {
1010 MWDebug
::debugMsg( $text );
1013 if ( $wgDebugLogFile != '' ) {
1014 # Strip unprintables; they can switch terminal modes when binary data
1015 # gets dumped, which is pretty annoying.
1016 $text = preg_replace( '![\x00-\x08\x0b\x0c\x0e-\x1f]!', ' ', $text );
1017 $text = $wgDebugLogPrefix . $text;
1018 wfErrorLog( $text, $wgDebugLogFile );
1023 * Returns true if debug logging should be suppressed if $wgDebugRawPage = false
1026 function wfIsDebugRawPage() {
1028 if ( $cache !== null ) {
1031 # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
1032 if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
1034 isset( $_SERVER['SCRIPT_NAME'] )
1035 && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
1046 * Get microsecond timestamps for debug logs
1050 function wfDebugTimer() {
1051 global $wgDebugTimestamps, $wgRequestTime;
1053 if ( !$wgDebugTimestamps ) {
1057 $prefix = sprintf( "%6.4f", microtime( true ) - $wgRequestTime );
1058 $mem = sprintf( "%5.1fM", ( memory_get_usage( true ) / ( 1024 * 1024 ) ) );
1059 return "$prefix $mem ";
1063 * Send a line giving PHP memory usage.
1065 * @param bool $exact Print exact byte values instead of kibibytes (default: false)
1067 function wfDebugMem( $exact = false ) {
1068 $mem = memory_get_usage();
1070 $mem = floor( $mem / 1024 ) . ' KiB';
1074 wfDebug( "Memory usage: $mem\n" );
1078 * Send a line to a supplementary debug log file, if configured, or main debug log if not.
1079 * To configure a supplementary log file, set $wgDebugLogGroups[$logGroup] to a string
1080 * filename or an associative array mapping 'destination' to the desired filename. The
1081 * associative array may also contain a 'sample' key with an integer value, specifying
1082 * a sampling factor.
1084 * @since 1.23 support for sampling log messages via $wgDebugLogGroups.
1086 * @param string $logGroup
1087 * @param string $text
1088 * @param string|bool $dest Destination of the message:
1089 * - 'all': both to the log and HTML (debug toolbar or HTML comments)
1090 * - 'log': only to the log and not in HTML
1091 * - 'private': only to the specifc log if set in $wgDebugLogGroups and
1092 * discarded otherwise
1093 * For backward compatibility, it can also take a boolean:
1094 * - true: same as 'all'
1095 * - false: same as 'private'
1097 function wfDebugLog( $logGroup, $text, $dest = 'all' ) {
1098 global $wgDebugLogGroups;
1100 $text = trim( $text ) . "\n";
1102 // Turn $dest into a string if it's a boolean (for b/c)
1103 if ( $dest === true ) {
1105 } elseif ( $dest === false ) {
1109 if ( !isset( $wgDebugLogGroups[$logGroup] ) ) {
1110 if ( $dest !== 'private' ) {
1111 wfDebug( "[$logGroup] $text", $dest );
1116 if ( $dest === 'all' ) {
1117 MWDebug
::debugMsg( "[$logGroup] $text" );
1120 $logConfig = $wgDebugLogGroups[$logGroup];
1121 if ( $logConfig === false ) {
1124 if ( is_array( $logConfig ) ) {
1125 if ( isset( $logConfig['sample'] ) && mt_rand( 1, $logConfig['sample'] ) !== 1 ) {
1128 $destination = $logConfig['destination'];
1130 $destination = strval( $logConfig );
1133 $time = wfTimestamp( TS_DB
);
1135 $host = wfHostname();
1136 wfErrorLog( "$time $host $wiki: $text", $destination );
1140 * Log for database errors
1142 * @param string $text Database error message.
1144 function wfLogDBError( $text ) {
1145 global $wgDBerrorLog, $wgDBerrorLogTZ;
1146 static $logDBErrorTimeZoneObject = null;
1148 if ( $wgDBerrorLog ) {
1149 $host = wfHostname();
1152 if ( $wgDBerrorLogTZ && !$logDBErrorTimeZoneObject ) {
1153 $logDBErrorTimeZoneObject = new DateTimeZone( $wgDBerrorLogTZ );
1156 // Workaround for https://bugs.php.net/bug.php?id=52063
1157 // Can be removed when min PHP > 5.3.2
1158 if ( $logDBErrorTimeZoneObject === null ) {
1159 $d = date_create( "now" );
1161 $d = date_create( "now", $logDBErrorTimeZoneObject );
1164 $date = $d->format( 'D M j G:i:s T Y' );
1166 $text = "$date\t$host\t$wiki\t" . trim( $text ) . "\n";
1167 wfErrorLog( $text, $wgDBerrorLog );
1172 * Throws a warning that $function is deprecated
1174 * @param string $function
1175 * @param string|bool $version Version of MediaWiki that the function
1176 * was deprecated in (Added in 1.19).
1177 * @param string|bool $component Added in 1.19.
1178 * @param int $callerOffset How far up the call stack is the original
1179 * caller. 2 = function that called the function that called
1180 * wfDeprecated (Added in 1.20)
1184 function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) {
1185 MWDebug
::deprecated( $function, $version, $component, $callerOffset +
1 );
1189 * Send a warning either to the debug log or in a PHP error depending on
1190 * $wgDevelopmentWarnings. To log warnings in production, use wfLogWarning() instead.
1192 * @param string $msg message to send
1193 * @param int $callerOffset Number of items to go back in the backtrace to
1194 * find the correct caller (1 = function calling wfWarn, ...)
1195 * @param int $level PHP error level; defaults to E_USER_NOTICE;
1196 * only used when $wgDevelopmentWarnings is true
1198 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE
) {
1199 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'auto' );
1203 * Send a warning as a PHP error and the debug log. This is intended for logging
1204 * warnings in production. For logging development warnings, use WfWarn instead.
1206 * @param string $msg Message to send
1207 * @param int $callerOffset Number of items to go back in the backtrace to
1208 * find the correct caller (1 = function calling wfLogWarning, ...)
1209 * @param int $level PHP error level; defaults to E_USER_WARNING
1211 function wfLogWarning( $msg, $callerOffset = 1, $level = E_USER_WARNING
) {
1212 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'production' );
1216 * Log to a file without getting "file size exceeded" signals.
1218 * Can also log to TCP or UDP with the syntax udp://host:port/prefix. This will
1219 * send lines to the specified port, prefixed by the specified prefix and a space.
1221 * @param string $text
1222 * @param string $file Filename
1223 * @throws MWException
1225 function wfErrorLog( $text, $file ) {
1226 if ( substr( $file, 0, 4 ) == 'udp:' ) {
1227 # Needs the sockets extension
1228 if ( preg_match( '!^(tcp|udp):(?://)?\[([0-9a-fA-F:]+)\]:(\d+)(?:/(.*))?$!', $file, $m ) ) {
1229 // IPv6 bracketed host
1231 $port = intval( $m[3] );
1232 $prefix = isset( $m[4] ) ?
$m[4] : false;
1234 } elseif ( preg_match( '!^(tcp|udp):(?://)?([a-zA-Z0-9.-]+):(\d+)(?:/(.*))?$!', $file, $m ) ) {
1236 if ( !IP
::isIPv4( $host ) ) {
1237 $host = gethostbyname( $host );
1239 $port = intval( $m[3] );
1240 $prefix = isset( $m[4] ) ?
$m[4] : false;
1243 throw new MWException( __METHOD__
. ': Invalid UDP specification' );
1246 // Clean it up for the multiplexer
1247 if ( strval( $prefix ) !== '' ) {
1248 $text = preg_replace( '/^/m', $prefix . ' ', $text );
1251 if ( strlen( $text ) > 65506 ) {
1252 $text = substr( $text, 0, 65506 );
1255 if ( substr( $text, -1 ) != "\n" ) {
1258 } elseif ( strlen( $text ) > 65507 ) {
1259 $text = substr( $text, 0, 65507 );
1262 $sock = socket_create( $domain, SOCK_DGRAM
, SOL_UDP
);
1267 socket_sendto( $sock, $text, strlen( $text ), 0, $host, $port );
1268 socket_close( $sock );
1270 wfSuppressWarnings();
1271 $exists = file_exists( $file );
1272 $size = $exists ?
filesize( $file ) : false;
1273 if ( !$exists ||
( $size !== false && $size +
strlen( $text ) < 0x7fffffff ) ) {
1274 file_put_contents( $file, $text, FILE_APPEND
);
1276 wfRestoreWarnings();
1283 function wfLogProfilingData() {
1284 global $wgRequestTime, $wgDebugLogFile, $wgDebugLogGroups, $wgDebugRawPage;
1285 global $wgProfileLimit, $wgUser, $wgRequest;
1287 StatCounter
::singleton()->flush();
1289 $profiler = Profiler
::instance();
1291 # Profiling must actually be enabled...
1292 if ( $profiler->isStub() ) {
1296 // Get total page request time and only show pages that longer than
1297 // $wgProfileLimit time (default is 0)
1298 $elapsed = microtime( true ) - $wgRequestTime;
1299 if ( $elapsed <= $wgProfileLimit ) {
1303 $profiler->logData();
1305 // Check whether this should be logged in the debug file.
1306 if ( isset( $wgDebugLogGroups['profileoutput'] )
1307 && $wgDebugLogGroups['profileoutput'] === false
1309 // Explicitely disabled
1312 if ( !isset( $wgDebugLogGroups['profileoutput'] ) && $wgDebugLogFile == '' ) {
1313 // Logging not enabled; no point going further
1316 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1321 if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1322 $forward = ' forwarded for ' . $_SERVER['HTTP_X_FORWARDED_FOR'];
1324 if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1325 $forward .= ' client IP ' . $_SERVER['HTTP_CLIENT_IP'];
1327 if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1328 $forward .= ' from ' . $_SERVER['HTTP_FROM'];
1331 $forward = "\t(proxied via {$_SERVER['REMOTE_ADDR']}{$forward})";
1333 // Don't load $wgUser at this late stage just for statistics purposes
1334 // @todo FIXME: We can detect some anons even if it is not loaded. See User::getId()
1335 if ( $wgUser->isItemLoaded( 'id' ) && $wgUser->isAnon() ) {
1336 $forward .= ' anon';
1339 // Command line script uses a FauxRequest object which does not have
1340 // any knowledge about an URL and throw an exception instead.
1342 $requestUrl = $wgRequest->getRequestURL();
1343 } catch ( MWException
$e ) {
1344 $requestUrl = 'n/a';
1347 $log = sprintf( "%s\t%04.3f\t%s\n",
1348 gmdate( 'YmdHis' ), $elapsed,
1349 urldecode( $requestUrl . $forward ) );
1351 wfDebugLog( 'profileoutput', $log . $profiler->getOutput() );
1355 * Increment a statistics counter
1357 * @param string $key
1361 function wfIncrStats( $key, $count = 1 ) {
1362 StatCounter
::singleton()->incr( $key, $count );
1366 * Check whether the wiki is in read-only mode.
1370 function wfReadOnly() {
1371 return wfReadOnlyReason() !== false;
1375 * Get the value of $wgReadOnly or the contents of $wgReadOnlyFile.
1377 * @return string|bool String when in read-only mode; false otherwise
1379 function wfReadOnlyReason() {
1380 global $wgReadOnly, $wgReadOnlyFile;
1382 if ( $wgReadOnly === null ) {
1383 // Set $wgReadOnly for faster access next time
1384 if ( is_file( $wgReadOnlyFile ) && filesize( $wgReadOnlyFile ) > 0 ) {
1385 $wgReadOnly = file_get_contents( $wgReadOnlyFile );
1387 $wgReadOnly = false;
1395 * Return a Language object from $langcode
1397 * @param Language|string|bool $langcode Either:
1398 * - a Language object
1399 * - code of the language to get the message for, if it is
1400 * a valid code create a language for that language, if
1401 * it is a string but not a valid code then make a basic
1403 * - a boolean: if it's false then use the global object for
1404 * the current user's language (as a fallback for the old parameter
1405 * functionality), or if it is true then use global object
1406 * for the wiki's content language.
1409 function wfGetLangObj( $langcode = false ) {
1410 # Identify which language to get or create a language object for.
1411 # Using is_object here due to Stub objects.
1412 if ( is_object( $langcode ) ) {
1413 # Great, we already have the object (hopefully)!
1417 global $wgContLang, $wgLanguageCode;
1418 if ( $langcode === true ||
$langcode === $wgLanguageCode ) {
1419 # $langcode is the language code of the wikis content language object.
1420 # or it is a boolean and value is true
1425 if ( $langcode === false ||
$langcode === $wgLang->getCode() ) {
1426 # $langcode is the language code of user language object.
1427 # or it was a boolean and value is false
1431 $validCodes = array_keys( Language
::fetchLanguageNames() );
1432 if ( in_array( $langcode, $validCodes ) ) {
1433 # $langcode corresponds to a valid language.
1434 return Language
::factory( $langcode );
1437 # $langcode is a string, but not a valid language code; use content language.
1438 wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1443 * This is the function for getting translated interface messages.
1445 * @see Message class for documentation how to use them.
1446 * @see https://www.mediawiki.org/wiki/Manual:Messages_API
1448 * This function replaces all old wfMsg* functions.
1450 * @param string $key Message key
1451 * @param mixed [$params,...] Normal message parameters
1456 * @see Message::__construct
1458 function wfMessage( $key /*...*/ ) {
1459 $params = func_get_args();
1460 array_shift( $params );
1461 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
1462 $params = $params[0];
1464 return new Message( $key, $params );
1468 * This function accepts multiple message keys and returns a message instance
1469 * for the first message which is non-empty. If all messages are empty then an
1470 * instance of the first message key is returned.
1472 * @param string|string[] [$keys,...] Message keys
1477 * @see Message::newFallbackSequence
1479 function wfMessageFallback( /*...*/ ) {
1480 $args = func_get_args();
1481 return call_user_func_array( 'Message::newFallbackSequence', $args );
1485 * Get a message from anywhere, for the current user language.
1487 * Use wfMsgForContent() instead if the message should NOT
1488 * change depending on the user preferences.
1490 * @deprecated since 1.18
1492 * @param string $key lookup key for the message, usually
1493 * defined in languages/Language.php
1495 * Parameters to the message, which can be used to insert variable text into
1496 * it, can be passed to this function in the following formats:
1497 * - One per argument, starting at the second parameter
1498 * - As an array in the second parameter
1499 * These are not shown in the function definition.
1503 function wfMsg( $key ) {
1504 wfDeprecated( __METHOD__
, '1.21' );
1506 $args = func_get_args();
1507 array_shift( $args );
1508 return wfMsgReal( $key, $args );
1512 * Same as above except doesn't transform the message
1514 * @deprecated since 1.18
1516 * @param string $key
1519 function wfMsgNoTrans( $key ) {
1520 wfDeprecated( __METHOD__
, '1.21' );
1522 $args = func_get_args();
1523 array_shift( $args );
1524 return wfMsgReal( $key, $args, true, false, false );
1528 * Get a message from anywhere, for the current global language
1529 * set with $wgLanguageCode.
1531 * Use this if the message should NOT change dependent on the
1532 * language set in the user's preferences. This is the case for
1533 * most text written into logs, as well as link targets (such as
1534 * the name of the copyright policy page). Link titles, on the
1535 * other hand, should be shown in the UI language.
1537 * Note that MediaWiki allows users to change the user interface
1538 * language in their preferences, but a single installation
1539 * typically only contains content in one language.
1541 * Be wary of this distinction: If you use wfMsg() where you should
1542 * use wfMsgForContent(), a user of the software may have to
1543 * customize potentially hundreds of messages in
1544 * order to, e.g., fix a link in every possible language.
1546 * @deprecated since 1.18
1548 * @param string $key Lookup key for the message, usually
1549 * defined in languages/Language.php
1552 function wfMsgForContent( $key ) {
1553 wfDeprecated( __METHOD__
, '1.21' );
1555 global $wgForceUIMsgAsContentMsg;
1556 $args = func_get_args();
1557 array_shift( $args );
1559 if ( is_array( $wgForceUIMsgAsContentMsg )
1560 && in_array( $key, $wgForceUIMsgAsContentMsg )
1562 $forcontent = false;
1564 return wfMsgReal( $key, $args, true, $forcontent );
1568 * Same as above except doesn't transform the message
1570 * @deprecated since 1.18
1572 * @param string $key
1575 function wfMsgForContentNoTrans( $key ) {
1576 wfDeprecated( __METHOD__
, '1.21' );
1578 global $wgForceUIMsgAsContentMsg;
1579 $args = func_get_args();
1580 array_shift( $args );
1582 if ( is_array( $wgForceUIMsgAsContentMsg )
1583 && in_array( $key, $wgForceUIMsgAsContentMsg )
1585 $forcontent = false;
1587 return wfMsgReal( $key, $args, true, $forcontent, false );
1591 * Really get a message
1593 * @deprecated since 1.18
1595 * @param string $key Key to get.
1596 * @param array $args
1597 * @param bool $useDB
1598 * @param string|bool $forContent Language code, or false for user lang, true for content lang.
1599 * @param bool $transform Whether or not to transform the message.
1600 * @return string The requested message.
1602 function wfMsgReal( $key, $args, $useDB = true, $forContent = false, $transform = true ) {
1603 wfDeprecated( __METHOD__
, '1.21' );
1605 wfProfileIn( __METHOD__
);
1606 $message = wfMsgGetKey( $key, $useDB, $forContent, $transform );
1607 $message = wfMsgReplaceArgs( $message, $args );
1608 wfProfileOut( __METHOD__
);
1613 * Fetch a message string value, but don't replace any keys yet.
1615 * @deprecated since 1.18
1617 * @param string $key
1618 * @param bool $useDB
1619 * @param string|bool $langCode Code of the language to get the message for, or
1620 * behaves as a content language switch if it is a boolean.
1621 * @param bool $transform Whether to parse magic words, etc.
1624 function wfMsgGetKey( $key, $useDB = true, $langCode = false, $transform = true ) {
1625 wfDeprecated( __METHOD__
, '1.21' );
1627 wfRunHooks( 'NormalizeMessageKey', array( &$key, &$useDB, &$langCode, &$transform ) );
1629 $cache = MessageCache
::singleton();
1630 $message = $cache->get( $key, $useDB, $langCode );
1631 if ( $message === false ) {
1632 $message = '<' . htmlspecialchars( $key ) . '>';
1633 } elseif ( $transform ) {
1634 $message = $cache->transform( $message );
1640 * Replace message parameter keys on the given formatted output.
1642 * @param string $message
1643 * @param array $args
1647 function wfMsgReplaceArgs( $message, $args ) {
1648 # Fix windows line-endings
1649 # Some messages are split with explode("\n", $msg)
1650 $message = str_replace( "\r", '', $message );
1652 // Replace arguments
1653 if ( count( $args ) ) {
1654 if ( is_array( $args[0] ) ) {
1655 $args = array_values( $args[0] );
1657 $replacementKeys = array();
1658 foreach ( $args as $n => $param ) {
1659 $replacementKeys['$' . ( $n +
1 )] = $param;
1661 $message = strtr( $message, $replacementKeys );
1668 * Return an HTML-escaped version of a message.
1669 * Parameter replacements, if any, are done *after* the HTML-escaping,
1670 * so parameters may contain HTML (eg links or form controls). Be sure
1671 * to pre-escape them if you really do want plaintext, or just wrap
1672 * the whole thing in htmlspecialchars().
1674 * @deprecated since 1.18
1676 * @param string $key
1677 * @param string [$args,...] Parameters
1680 function wfMsgHtml( $key ) {
1681 wfDeprecated( __METHOD__
, '1.21' );
1683 $args = func_get_args();
1684 array_shift( $args );
1685 return wfMsgReplaceArgs( htmlspecialchars( wfMsgGetKey( $key ) ), $args );
1689 * Return an HTML version of message
1690 * Parameter replacements, if any, are done *after* parsing the wiki-text message,
1691 * so parameters may contain HTML (eg links or form controls). Be sure
1692 * to pre-escape them if you really do want plaintext, or just wrap
1693 * the whole thing in htmlspecialchars().
1695 * @deprecated since 1.18
1697 * @param string $key
1698 * @param string [$args,...] Parameters
1701 function wfMsgWikiHtml( $key ) {
1702 wfDeprecated( __METHOD__
, '1.21' );
1704 $args = func_get_args();
1705 array_shift( $args );
1706 return wfMsgReplaceArgs(
1707 MessageCache
::singleton()->parse( wfMsgGetKey( $key ), null,
1708 /* can't be set to false */ true, /* interface */ true )->getText(),
1713 * Returns message in the requested format
1715 * @deprecated since 1.18
1717 * @param string $key Key of the message
1718 * @param array $options Processing rules.
1719 * Can take the following options:
1720 * parse: parses wikitext to HTML
1721 * parseinline: parses wikitext to HTML and removes the surrounding
1722 * p's added by parser or tidy
1723 * escape: filters message through htmlspecialchars
1724 * escapenoentities: same, but allows entity references like   through
1725 * replaceafter: parameters are substituted after parsing or escaping
1726 * parsemag: transform the message using magic phrases
1727 * content: fetch message for content language instead of interface
1728 * Also can accept a single associative argument, of the form 'language' => 'xx':
1729 * language: Language object or language code to fetch message for
1730 * (overridden by content).
1731 * Behavior for conflicting options (e.g., parse+parseinline) is undefined.
1735 function wfMsgExt( $key, $options ) {
1736 wfDeprecated( __METHOD__
, '1.21' );
1738 $args = func_get_args();
1739 array_shift( $args );
1740 array_shift( $args );
1741 $options = (array)$options;
1743 foreach ( $options as $arrayKey => $option ) {
1744 if ( !preg_match( '/^[0-9]+|language$/', $arrayKey ) ) {
1745 # An unknown index, neither numeric nor "language"
1746 wfWarn( "wfMsgExt called with incorrect parameter key $arrayKey", 1, E_USER_WARNING
);
1747 } elseif ( preg_match( '/^[0-9]+$/', $arrayKey ) && !in_array( $option,
1748 array( 'parse', 'parseinline', 'escape', 'escapenoentities',
1749 'replaceafter', 'parsemag', 'content' ) ) ) {
1750 # A numeric index with unknown value
1751 wfWarn( "wfMsgExt called with incorrect parameter $option", 1, E_USER_WARNING
);
1755 if ( in_array( 'content', $options, true ) ) {
1758 $langCodeObj = null;
1759 } elseif ( array_key_exists( 'language', $options ) ) {
1760 $forContent = false;
1761 $langCode = wfGetLangObj( $options['language'] );
1762 $langCodeObj = $langCode;
1764 $forContent = false;
1766 $langCodeObj = null;
1769 $string = wfMsgGetKey( $key, /*DB*/true, $langCode, /*Transform*/false );
1771 if ( !in_array( 'replaceafter', $options, true ) ) {
1772 $string = wfMsgReplaceArgs( $string, $args );
1775 $messageCache = MessageCache
::singleton();
1776 $parseInline = in_array( 'parseinline', $options, true );
1777 if ( in_array( 'parse', $options, true ) ||
$parseInline ) {
1778 $string = $messageCache->parse( $string, null, true, !$forContent, $langCodeObj );
1779 if ( $string instanceof ParserOutput
) {
1780 $string = $string->getText();
1783 if ( $parseInline ) {
1784 $string = Parser
::stripOuterParagraph( $string );
1786 } elseif ( in_array( 'parsemag', $options, true ) ) {
1787 $string = $messageCache->transform( $string,
1788 !$forContent, $langCodeObj );
1791 if ( in_array( 'escape', $options, true ) ) {
1792 $string = htmlspecialchars ( $string );
1793 } elseif ( in_array( 'escapenoentities', $options, true ) ) {
1794 $string = Sanitizer
::escapeHtmlAllowEntities( $string );
1797 if ( in_array( 'replaceafter', $options, true ) ) {
1798 $string = wfMsgReplaceArgs( $string, $args );
1805 * Since wfMsg() and co suck, they don't return false if the message key they
1806 * looked up didn't exist but instead the key wrapped in <>'s, this function checks for the
1807 * nonexistence of messages by checking the MessageCache::get() result directly.
1809 * @deprecated since 1.18. Use Message::isDisabled().
1811 * @param string $key The message key looked up
1812 * @return bool True if the message *doesn't* exist.
1814 function wfEmptyMsg( $key ) {
1815 wfDeprecated( __METHOD__
, '1.21' );
1817 return MessageCache
::singleton()->get( $key, /*useDB*/true, /*content*/false ) === false;
1821 * Throw a debugging exception. This function previously once exited the process,
1822 * but now throws an exception instead, with similar results.
1824 * @deprecated since 1.22; just throw an MWException yourself
1825 * @param string $msg Message shown when dying.
1826 * @throws MWException
1828 function wfDebugDieBacktrace( $msg = '' ) {
1829 wfDeprecated( __FUNCTION__
, '1.22' );
1830 throw new MWException( $msg );
1834 * Fetch server name for use in error reporting etc.
1835 * Use real server name if available, so we know which machine
1836 * in a server farm generated the current page.
1840 function wfHostname() {
1842 if ( is_null( $host ) ) {
1844 # Hostname overriding
1845 global $wgOverrideHostname;
1846 if ( $wgOverrideHostname !== false ) {
1847 # Set static and skip any detection
1848 $host = $wgOverrideHostname;
1852 if ( function_exists( 'posix_uname' ) ) {
1853 // This function not present on Windows
1854 $uname = posix_uname();
1858 if ( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1859 $host = $uname['nodename'];
1860 } elseif ( getenv( 'COMPUTERNAME' ) ) {
1861 # Windows computer name
1862 $host = getenv( 'COMPUTERNAME' );
1864 # This may be a virtual server.
1865 $host = $_SERVER['SERVER_NAME'];
1872 * Returns a script tag that stores the amount of time it took MediaWiki to
1873 * handle the request in milliseconds as 'wgBackendResponseTime'.
1875 * If $wgShowHostnames is true, the script will also set 'wgHostname' to the
1876 * hostname of the server handling the request.
1880 function wfReportTime() {
1881 global $wgRequestTime, $wgShowHostnames;
1883 $responseTime = round( ( microtime( true ) - $wgRequestTime ) * 1000 );
1884 $reportVars = array( 'wgBackendResponseTime' => $responseTime );
1885 if ( $wgShowHostnames ) {
1886 $reportVars[ 'wgHostname' ] = wfHostname();
1888 return Skin
::makeVariablesScript( $reportVars );
1892 * Safety wrapper for debug_backtrace().
1894 * Will return an empty array if debug_backtrace is disabled, otherwise
1895 * the output from debug_backtrace() (trimmed).
1897 * @param int $limit This parameter can be used to limit the number of stack frames returned
1899 * @return array Array of backtrace information
1901 function wfDebugBacktrace( $limit = 0 ) {
1902 static $disabled = null;
1904 if ( is_null( $disabled ) ) {
1905 $disabled = !function_exists( 'debug_backtrace' );
1907 wfDebug( "debug_backtrace() is disabled\n" );
1914 if ( $limit && version_compare( PHP_VERSION
, '5.4.0', '>=' ) ) {
1915 return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT
, $limit +
1 ), 1 );
1917 return array_slice( debug_backtrace(), 1 );
1922 * Get a debug backtrace as a string
1926 function wfBacktrace() {
1927 global $wgCommandLineMode;
1929 if ( $wgCommandLineMode ) {
1934 $backtrace = wfDebugBacktrace();
1935 foreach ( $backtrace as $call ) {
1936 if ( isset( $call['file'] ) ) {
1937 $f = explode( DIRECTORY_SEPARATOR
, $call['file'] );
1938 $file = $f[count( $f ) - 1];
1942 if ( isset( $call['line'] ) ) {
1943 $line = $call['line'];
1947 if ( $wgCommandLineMode ) {
1948 $msg .= "$file line $line calls ";
1950 $msg .= '<li>' . $file . ' line ' . $line . ' calls ';
1952 if ( !empty( $call['class'] ) ) {
1953 $msg .= $call['class'] . $call['type'];
1955 $msg .= $call['function'] . '()';
1957 if ( $wgCommandLineMode ) {
1963 if ( $wgCommandLineMode ) {
1973 * Get the name of the function which called this function
1974 * wfGetCaller( 1 ) is the function with the wfGetCaller() call (ie. __FUNCTION__)
1975 * wfGetCaller( 2 ) [default] is the caller of the function running wfGetCaller()
1976 * wfGetCaller( 3 ) is the parent of that.
1981 function wfGetCaller( $level = 2 ) {
1982 $backtrace = wfDebugBacktrace( $level +
1 );
1983 if ( isset( $backtrace[$level] ) ) {
1984 return wfFormatStackFrame( $backtrace[$level] );
1991 * Return a string consisting of callers in the stack. Useful sometimes
1992 * for profiling specific points.
1994 * @param int $limit The maximum depth of the stack frame to return, or false for the entire stack.
1997 function wfGetAllCallers( $limit = 3 ) {
1998 $trace = array_reverse( wfDebugBacktrace() );
1999 if ( !$limit ||
$limit > count( $trace ) - 1 ) {
2000 $limit = count( $trace ) - 1;
2002 $trace = array_slice( $trace, -$limit - 1, $limit );
2003 return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
2007 * Return a string representation of frame
2009 * @param array $frame
2012 function wfFormatStackFrame( $frame ) {
2013 return isset( $frame['class'] ) ?
2014 $frame['class'] . '::' . $frame['function'] :
2018 /* Some generic result counters, pulled out of SearchEngine */
2023 * @param int $offset
2027 function wfShowingResults( $offset, $limit ) {
2028 return wfMessage( 'showingresults' )->numParams( $limit, $offset +
1 )->parse();
2032 * Generate (prev x| next x) (20|50|100...) type links for paging
2034 * @param string $offset
2036 * @param string $link
2037 * @param string $query Optional URL query parameter string
2038 * @param bool $atend Optional param for specified if this is the last page
2040 * @deprecated since 1.19; use Language::viewPrevNext() instead
2042 function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) {
2043 wfDeprecated( __METHOD__
, '1.19' );
2047 $query = wfCgiToArray( $query );
2049 if ( is_object( $link ) ) {
2052 $title = Title
::newFromText( $link );
2053 if ( is_null( $title ) ) {
2058 return $wgLang->viewPrevNext( $title, $offset, $limit, $query, $atend );
2063 * @todo FIXME: We may want to blacklist some broken browsers
2065 * @param bool $force
2066 * @return bool Whereas client accept gzip compression
2068 function wfClientAcceptsGzip( $force = false ) {
2069 static $result = null;
2070 if ( $result === null ||
$force ) {
2072 if ( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
2073 # @todo FIXME: We may want to blacklist some broken browsers
2076 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
2077 $_SERVER['HTTP_ACCEPT_ENCODING'],
2081 if ( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
2085 wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
2094 * Obtain the offset and limit values from the request string;
2095 * used in special pages
2097 * @param int $deflimit Default limit if none supplied
2098 * @param string $optionname Name of a user preference to check against
2101 function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
2103 return $wgRequest->getLimitOffset( $deflimit, $optionname );
2107 * Escapes the given text so that it may be output using addWikiText()
2108 * without any linking, formatting, etc. making its way through. This
2109 * is achieved by substituting certain characters with HTML entities.
2110 * As required by the callers, "<nowiki>" is not used.
2112 * @param string $text Text to be escaped
2115 function wfEscapeWikiText( $text ) {
2116 static $repl = null, $repl2 = null;
2117 if ( $repl === null ) {
2119 '"' => '"', '&' => '&', "'" => ''', '<' => '<',
2120 '=' => '=', '>' => '>', '[' => '[', ']' => ']',
2121 '{' => '{', '|' => '|', '}' => '}', ';' => ';',
2122 "\n#" => "\n#", "\r#" => "\r#",
2123 "\n*" => "\n*", "\r*" => "\r*",
2124 "\n:" => "\n:", "\r:" => "\r:",
2125 "\n " => "\n ", "\r " => "\r ",
2126 "\n\n" => "\n ", "\r\n" => " \n",
2127 "\n\r" => "\n ", "\r\r" => "\r ",
2128 "\n\t" => "\n	", "\r\t" => "\r	", // "\n\t\n" is treated like "\n\n"
2129 "\n----" => "\n----", "\r----" => "\r----",
2130 '__' => '__', '://' => '://',
2133 // We have to catch everything "\s" matches in PCRE
2134 foreach ( array( 'ISBN', 'RFC', 'PMID' ) as $magic ) {
2135 $repl["$magic "] = "$magic ";
2136 $repl["$magic\t"] = "$magic	";
2137 $repl["$magic\r"] = "$magic ";
2138 $repl["$magic\n"] = "$magic ";
2139 $repl["$magic\f"] = "$magic";
2142 // And handle protocols that don't use "://"
2143 global $wgUrlProtocols;
2145 foreach ( $wgUrlProtocols as $prot ) {
2146 if ( substr( $prot, -1 ) === ':' ) {
2147 $repl2[] = preg_quote( substr( $prot, 0, -1 ), '/' );
2150 $repl2 = $repl2 ?
'/\b(' . join( '|', $repl2 ) . '):/i' : '/^(?!)/';
2152 $text = substr( strtr( "\n$text", $repl ), 1 );
2153 $text = preg_replace( $repl2, '$1:', $text );
2158 * Get the current unix timestamp with microseconds. Useful for profiling
2159 * @deprecated since 1.22; call microtime() directly
2163 wfDeprecated( __FUNCTION__
, '1.22' );
2164 return microtime( true );
2168 * Sets dest to source and returns the original value of dest
2169 * If source is NULL, it just returns the value, it doesn't set the variable
2170 * If force is true, it will set the value even if source is NULL
2172 * @param mixed $dest
2173 * @param mixed $source
2174 * @param bool $force
2177 function wfSetVar( &$dest, $source, $force = false ) {
2179 if ( !is_null( $source ) ||
$force ) {
2186 * As for wfSetVar except setting a bit
2190 * @param bool $state
2194 function wfSetBit( &$dest, $bit, $state = true ) {
2195 $temp = (bool)( $dest & $bit );
2196 if ( !is_null( $state ) ) {
2207 * A wrapper around the PHP function var_export().
2208 * Either print it or add it to the regular output ($wgOut).
2210 * @param mixed $var A PHP variable to dump.
2212 function wfVarDump( $var ) {
2214 $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
2215 if ( headers_sent() ||
!isset( $wgOut ) ||
!is_object( $wgOut ) ) {
2218 $wgOut->addHTML( $s );
2223 * Provide a simple HTTP error.
2225 * @param int|string $code
2226 * @param string $label
2227 * @param string $desc
2229 function wfHttpError( $code, $label, $desc ) {
2232 header( "HTTP/1.0 $code $label" );
2233 header( "Status: $code $label" );
2234 $wgOut->sendCacheControl();
2236 header( 'Content-type: text/html; charset=utf-8' );
2237 print "<!doctype html>" .
2238 '<html><head><title>' .
2239 htmlspecialchars( $label ) .
2240 '</title></head><body><h1>' .
2241 htmlspecialchars( $label ) .
2243 nl2br( htmlspecialchars( $desc ) ) .
2244 "</p></body></html>\n";
2248 * Clear away any user-level output buffers, discarding contents.
2250 * Suitable for 'starting afresh', for instance when streaming
2251 * relatively large amounts of data without buffering, or wanting to
2252 * output image files without ob_gzhandler's compression.
2254 * The optional $resetGzipEncoding parameter controls suppression of
2255 * the Content-Encoding header sent by ob_gzhandler; by default it
2256 * is left. See comments for wfClearOutputBuffers() for why it would
2259 * Note that some PHP configuration options may add output buffer
2260 * layers which cannot be removed; these are left in place.
2262 * @param bool $resetGzipEncoding
2264 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
2265 if ( $resetGzipEncoding ) {
2266 // Suppress Content-Encoding and Content-Length
2267 // headers from 1.10+s wfOutputHandler
2268 global $wgDisableOutputCompression;
2269 $wgDisableOutputCompression = true;
2271 while ( $status = ob_get_status() ) {
2272 if ( $status['type'] == 0 /* PHP_OUTPUT_HANDLER_INTERNAL */ ) {
2273 // Probably from zlib.output_compression or other
2274 // PHP-internal setting which can't be removed.
2276 // Give up, and hope the result doesn't break
2280 if ( !ob_end_clean() ) {
2281 // Could not remove output buffer handler; abort now
2282 // to avoid getting in some kind of infinite loop.
2285 if ( $resetGzipEncoding ) {
2286 if ( $status['name'] == 'ob_gzhandler' ) {
2287 // Reset the 'Content-Encoding' field set by this handler
2288 // so we can start fresh.
2289 header_remove( 'Content-Encoding' );
2297 * More legible than passing a 'false' parameter to wfResetOutputBuffers():
2299 * Clear away output buffers, but keep the Content-Encoding header
2300 * produced by ob_gzhandler, if any.
2302 * This should be used for HTTP 304 responses, where you need to
2303 * preserve the Content-Encoding header of the real result, but
2304 * also need to suppress the output of ob_gzhandler to keep to spec
2305 * and avoid breaking Firefox in rare cases where the headers and
2306 * body are broken over two packets.
2308 function wfClearOutputBuffers() {
2309 wfResetOutputBuffers( false );
2313 * Converts an Accept-* header into an array mapping string values to quality
2316 * @param string $accept
2317 * @param string $def default
2318 * @return float[] Associative array of string => float pairs
2320 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
2321 # No arg means accept anything (per HTTP spec)
2323 return array( $def => 1.0 );
2328 $parts = explode( ',', $accept );
2330 foreach ( $parts as $part ) {
2331 # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
2332 $values = explode( ';', trim( $part ) );
2334 if ( count( $values ) == 1 ) {
2335 $prefs[$values[0]] = 1.0;
2336 } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
2337 $prefs[$values[0]] = floatval( $match[1] );
2345 * Checks if a given MIME type matches any of the keys in the given
2346 * array. Basic wildcards are accepted in the array keys.
2348 * Returns the matching MIME type (or wildcard) if a match, otherwise
2351 * @param string $type
2352 * @param array $avail
2356 function mimeTypeMatch( $type, $avail ) {
2357 if ( array_key_exists( $type, $avail ) ) {
2360 $parts = explode( '/', $type );
2361 if ( array_key_exists( $parts[0] . '/*', $avail ) ) {
2362 return $parts[0] . '/*';
2363 } elseif ( array_key_exists( '*/*', $avail ) ) {
2372 * Returns the 'best' match between a client's requested internet media types
2373 * and the server's list of available types. Each list should be an associative
2374 * array of type to preference (preference is a float between 0.0 and 1.0).
2375 * Wildcards in the types are acceptable.
2377 * @param array $cprefs Client's acceptable type list
2378 * @param array $sprefs Server's offered types
2381 * @todo FIXME: Doesn't handle params like 'text/plain; charset=UTF-8'
2382 * XXX: generalize to negotiate other stuff
2384 function wfNegotiateType( $cprefs, $sprefs ) {
2387 foreach ( array_keys( $sprefs ) as $type ) {
2388 $parts = explode( '/', $type );
2389 if ( $parts[1] != '*' ) {
2390 $ckey = mimeTypeMatch( $type, $cprefs );
2392 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
2397 foreach ( array_keys( $cprefs ) as $type ) {
2398 $parts = explode( '/', $type );
2399 if ( $parts[1] != '*' && !array_key_exists( $type, $sprefs ) ) {
2400 $skey = mimeTypeMatch( $type, $sprefs );
2402 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
2410 foreach ( array_keys( $combine ) as $type ) {
2411 if ( $combine[$type] > $bestq ) {
2413 $bestq = $combine[$type];
2421 * Reference-counted warning suppression
2425 function wfSuppressWarnings( $end = false ) {
2426 static $suppressCount = 0;
2427 static $originalLevel = false;
2430 if ( $suppressCount ) {
2432 if ( !$suppressCount ) {
2433 error_reporting( $originalLevel );
2437 if ( !$suppressCount ) {
2438 $originalLevel = error_reporting( E_ALL
& ~
(
2453 * Restore error level to previous value
2455 function wfRestoreWarnings() {
2456 wfSuppressWarnings( true );
2459 # Autodetect, convert and provide timestamps of various types
2462 * Unix time - the number of seconds since 1970-01-01 00:00:00 UTC
2464 define( 'TS_UNIX', 0 );
2467 * MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
2469 define( 'TS_MW', 1 );
2472 * MySQL DATETIME (YYYY-MM-DD HH:MM:SS)
2474 define( 'TS_DB', 2 );
2477 * RFC 2822 format, for E-mail and HTTP headers
2479 define( 'TS_RFC2822', 3 );
2482 * ISO 8601 format with no timezone: 1986-02-09T20:00:00Z
2484 * This is used by Special:Export
2486 define( 'TS_ISO_8601', 4 );
2489 * An Exif timestamp (YYYY:MM:DD HH:MM:SS)
2491 * @see http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the
2492 * DateTime tag and page 36 for the DateTimeOriginal and
2493 * DateTimeDigitized tags.
2495 define( 'TS_EXIF', 5 );
2498 * Oracle format time.
2500 define( 'TS_ORACLE', 6 );
2503 * Postgres format time.
2505 define( 'TS_POSTGRES', 7 );
2508 * ISO 8601 basic format with no timezone: 19860209T200000Z. This is used by ResourceLoader
2510 define( 'TS_ISO_8601_BASIC', 9 );
2513 * Get a timestamp string in one of various formats
2515 * @param mixed $outputtype A timestamp in one of the supported formats, the
2516 * function will autodetect which format is supplied and act accordingly.
2517 * @param mixed $ts Optional timestamp to convert, default 0 for the current time
2518 * @return string|bool String / false The same date in the format specified in $outputtype or false
2520 function wfTimestamp( $outputtype = TS_UNIX
, $ts = 0 ) {
2522 $timestamp = new MWTimestamp( $ts );
2523 return $timestamp->getTimestamp( $outputtype );
2524 } catch ( TimestampException
$e ) {
2525 wfDebug( "wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n" );
2531 * Return a formatted timestamp, or null if input is null.
2532 * For dealing with nullable timestamp columns in the database.
2534 * @param int $outputtype
2538 function wfTimestampOrNull( $outputtype = TS_UNIX
, $ts = null ) {
2539 if ( is_null( $ts ) ) {
2542 return wfTimestamp( $outputtype, $ts );
2547 * Convenience function; returns MediaWiki timestamp for the present time.
2551 function wfTimestampNow() {
2553 return wfTimestamp( TS_MW
, time() );
2557 * Check if the operating system is Windows
2559 * @return bool True if it's Windows, false otherwise.
2561 function wfIsWindows() {
2562 static $isWindows = null;
2563 if ( $isWindows === null ) {
2564 $isWindows = substr( php_uname(), 0, 7 ) == 'Windows';
2570 * Check if we are running under HHVM
2574 function wfIsHHVM() {
2575 return defined( 'HHVM_VERSION' );
2579 * Swap two variables
2584 function swap( &$x, &$y ) {
2591 * Tries to get the system directory for temporary files. First
2592 * $wgTmpDirectory is checked, and then the TMPDIR, TMP, and TEMP
2593 * environment variables are then checked in sequence, and if none are
2594 * set try sys_get_temp_dir().
2596 * NOTE: When possible, use instead the tmpfile() function to create
2597 * temporary files to avoid race conditions on file creation, etc.
2601 function wfTempDir() {
2602 global $wgTmpDirectory;
2604 if ( $wgTmpDirectory !== false ) {
2605 return $wgTmpDirectory;
2608 $tmpDir = array_map( "getenv", array( 'TMPDIR', 'TMP', 'TEMP' ) );
2610 foreach ( $tmpDir as $tmp ) {
2611 if ( $tmp && file_exists( $tmp ) && is_dir( $tmp ) && is_writable( $tmp ) ) {
2615 return sys_get_temp_dir();
2619 * Make directory, and make all parent directories if they don't exist
2621 * @param string $dir Full path to directory to create
2622 * @param int $mode Chmod value to use, default is $wgDirectoryMode
2623 * @param string $caller Optional caller param for debugging.
2624 * @throws MWException
2627 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2628 global $wgDirectoryMode;
2630 if ( FileBackend
::isStoragePath( $dir ) ) { // sanity
2631 throw new MWException( __FUNCTION__
. " given storage path '$dir'." );
2634 if ( !is_null( $caller ) ) {
2635 wfDebug( "$caller: called wfMkdirParents($dir)\n" );
2638 if ( strval( $dir ) === '' ||
( file_exists( $dir ) && is_dir( $dir ) ) ) {
2642 $dir = str_replace( array( '\\', '/' ), DIRECTORY_SEPARATOR
, $dir );
2644 if ( is_null( $mode ) ) {
2645 $mode = $wgDirectoryMode;
2648 // Turn off the normal warning, we're doing our own below
2649 wfSuppressWarnings();
2650 $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2651 wfRestoreWarnings();
2654 //directory may have been created on another request since we last checked
2655 if ( is_dir( $dir ) ) {
2659 // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2660 wfLogWarning( sprintf( "failed to mkdir \"%s\" mode 0%o", $dir, $mode ) );
2666 * Remove a directory and all its content.
2667 * Does not hide error.
2668 * @param string $dir
2670 function wfRecursiveRemoveDir( $dir ) {
2671 wfDebug( __FUNCTION__
. "( $dir )\n" );
2672 // taken from http://de3.php.net/manual/en/function.rmdir.php#98622
2673 if ( is_dir( $dir ) ) {
2674 $objects = scandir( $dir );
2675 foreach ( $objects as $object ) {
2676 if ( $object != "." && $object != ".." ) {
2677 if ( filetype( $dir . '/' . $object ) == "dir" ) {
2678 wfRecursiveRemoveDir( $dir . '/' . $object );
2680 unlink( $dir . '/' . $object );
2690 * @param int $nr The number to format
2691 * @param int $acc The number of digits after the decimal point, default 2
2692 * @param bool $round Whether or not to round the value, default true
2695 function wfPercent( $nr, $acc = 2, $round = true ) {
2696 $ret = sprintf( "%.${acc}f", $nr );
2697 return $round ?
round( $ret, $acc ) . '%' : "$ret%";
2701 * Safety wrapper around ini_get() for boolean settings.
2702 * The values returned from ini_get() are pre-normalized for settings
2703 * set via php.ini or php_flag/php_admin_flag... but *not*
2704 * for those set via php_value/php_admin_value.
2706 * It's fairly common for people to use php_value instead of php_flag,
2707 * which can leave you with an 'off' setting giving a false positive
2708 * for code that just takes the ini_get() return value as a boolean.
2710 * To make things extra interesting, setting via php_value accepts
2711 * "true" and "yes" as true, but php.ini and php_flag consider them false. :)
2712 * Unrecognized values go false... again opposite PHP's own coercion
2713 * from string to bool.
2715 * Luckily, 'properly' set settings will always come back as '0' or '1',
2716 * so we only have to worry about them and the 'improper' settings.
2718 * I frickin' hate PHP... :P
2720 * @param string $setting
2723 function wfIniGetBool( $setting ) {
2724 $val = strtolower( ini_get( $setting ) );
2725 // 'on' and 'true' can't have whitespace around them, but '1' can.
2729 ||
preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2733 * Windows-compatible version of escapeshellarg()
2734 * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
2735 * function puts single quotes in regardless of OS.
2737 * Also fixes the locale problems on Linux in PHP 5.2.6+ (bug backported to
2738 * earlier distro releases of PHP)
2740 * @param string [$args,...]
2743 function wfEscapeShellArg( /*...*/ ) {
2744 wfInitShellLocale();
2746 $args = func_get_args();
2749 foreach ( $args as $arg ) {
2756 if ( wfIsWindows() ) {
2757 // Escaping for an MSVC-style command line parser and CMD.EXE
2758 // @codingStandardsIgnoreStart For long URLs
2760 // * http://web.archive.org/web/20020708081031/http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
2761 // * http://technet.microsoft.com/en-us/library/cc723564.aspx
2764 // Double the backslashes before any double quotes. Escape the double quotes.
2765 // @codingStandardsIgnoreEnd
2766 $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE
);
2769 foreach ( $tokens as $token ) {
2770 if ( $iteration %
2 == 1 ) {
2771 // Delimiter, a double quote preceded by zero or more slashes
2772 $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
2773 } elseif ( $iteration %
4 == 2 ) {
2774 // ^ in $token will be outside quotes, need to be escaped
2775 $arg .= str_replace( '^', '^^', $token );
2776 } else { // $iteration % 4 == 0
2777 // ^ in $token will appear inside double quotes, so leave as is
2782 // Double the backslashes before the end of the string, because
2783 // we will soon add a quote
2785 if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
2786 $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
2789 // Add surrounding quotes
2790 $retVal .= '"' . $arg . '"';
2792 $retVal .= escapeshellarg( $arg );
2799 * Check if wfShellExec() is effectively disabled via php.ini config
2801 * @return bool|string False or one of (safemode,disabled)
2804 function wfShellExecDisabled() {
2805 static $disabled = null;
2806 if ( is_null( $disabled ) ) {
2807 if ( wfIniGetBool( 'safe_mode' ) ) {
2808 wfDebug( "wfShellExec can't run in safe_mode, PHP's exec functions are too broken.\n" );
2809 $disabled = 'safemode';
2810 } elseif ( !function_exists( 'proc_open' ) ) {
2811 wfDebug( "proc_open() is disabled\n" );
2812 $disabled = 'disabled';
2821 * Execute a shell command, with time and memory limits mirrored from the PHP
2822 * configuration if supported.
2824 * @param string $cmd Command line, properly escaped for shell.
2825 * @param null|mixed &$retval Optional, will receive the program's exit code.
2826 * (non-zero is usually failure). If there is an error from
2827 * read, select, or proc_open(), this will be set to -1.
2828 * @param array $environ Optional environment variables which should be
2829 * added to the executed command environment.
2830 * @param array $limits Optional array with limits(filesize, memory, time, walltime)
2831 * this overwrites the global wgMaxShell* limits.
2832 * @param array $options Array of options:
2833 * - duplicateStderr: Set this to true to duplicate stderr to stdout,
2834 * including errors from limit.sh
2836 * @return string Collected stdout as a string
2838 function wfShellExec( $cmd, &$retval = null, $environ = array(),
2839 $limits = array(), $options = array()
2841 global $IP, $wgMaxShellMemory, $wgMaxShellFileSize, $wgMaxShellTime,
2842 $wgMaxShellWallClockTime, $wgShellCgroup;
2844 $disabled = wfShellExecDisabled();
2847 return $disabled == 'safemode' ?
2848 'Unable to run external programs in safe mode.' :
2849 'Unable to run external programs, proc_open() is disabled.';
2852 $includeStderr = isset( $options['duplicateStderr'] ) && $options['duplicateStderr'];
2854 wfInitShellLocale();
2857 foreach ( $environ as $k => $v ) {
2858 if ( wfIsWindows() ) {
2859 /* Surrounding a set in quotes (method used by wfEscapeShellArg) makes the quotes themselves
2860 * appear in the environment variable, so we must use carat escaping as documented in
2861 * http://technet.microsoft.com/en-us/library/cc723564.aspx
2862 * Note however that the quote isn't listed there, but is needed, and the parentheses
2863 * are listed there but doesn't appear to need it.
2865 $envcmd .= "set $k=" . preg_replace( '/([&|()<>^"])/', '^\\1', $v ) . '&& ';
2867 /* Assume this is a POSIX shell, thus required to accept variable assignments before the command
2868 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_09_01
2870 $envcmd .= "$k=" . escapeshellarg( $v ) . ' ';
2873 $cmd = $envcmd . $cmd;
2875 $useLogPipe = false;
2876 if ( is_executable( '/bin/bash' ) ) {
2877 $time = intval ( isset( $limits['time'] ) ?
$limits['time'] : $wgMaxShellTime );
2878 if ( isset( $limits['walltime'] ) ) {
2879 $wallTime = intval( $limits['walltime'] );
2880 } elseif ( isset( $limits['time'] ) ) {
2883 $wallTime = intval( $wgMaxShellWallClockTime );
2885 $mem = intval ( isset( $limits['memory'] ) ?
$limits['memory'] : $wgMaxShellMemory );
2886 $filesize = intval ( isset( $limits['filesize'] ) ?
$limits['filesize'] : $wgMaxShellFileSize );
2888 if ( $time > 0 ||
$mem > 0 ||
$filesize > 0 ||
$wallTime > 0 ) {
2889 $cmd = '/bin/bash ' . escapeshellarg( "$IP/includes/limit.sh" ) . ' ' .
2890 escapeshellarg( $cmd ) . ' ' .
2892 "MW_INCLUDE_STDERR=" . ( $includeStderr ?
'1' : '' ) . ';' .
2893 "MW_CPU_LIMIT=$time; " .
2894 'MW_CGROUP=' . escapeshellarg( $wgShellCgroup ) . '; ' .
2895 "MW_MEM_LIMIT=$mem; " .
2896 "MW_FILE_SIZE_LIMIT=$filesize; " .
2897 "MW_WALL_CLOCK_LIMIT=$wallTime; " .
2898 "MW_USE_LOG_PIPE=yes"
2901 } elseif ( $includeStderr ) {
2904 } elseif ( $includeStderr ) {
2907 wfDebug( "wfShellExec: $cmd\n" );
2910 0 => array( 'file', 'php://stdin', 'r' ),
2911 1 => array( 'pipe', 'w' ),
2912 2 => array( 'file', 'php://stderr', 'w' ) );
2913 if ( $useLogPipe ) {
2914 $desc[3] = array( 'pipe', 'w' );
2917 $proc = proc_open( $cmd, $desc, $pipes );
2919 wfDebugLog( 'exec', "proc_open() failed: $cmd" );
2923 $outBuffer = $logBuffer = '';
2924 $emptyArray = array();
2928 // According to the documentation, it is possible for stream_select()
2929 // to fail due to EINTR. I haven't managed to induce this in testing
2930 // despite sending various signals. If it did happen, the error
2931 // message would take the form:
2933 // stream_select(): unable to select [4]: Interrupted system call (max_fd=5)
2935 // where [4] is the value of the macro EINTR and "Interrupted system
2936 // call" is string which according to the Linux manual is "possibly"
2937 // localised according to LC_MESSAGES.
2938 $eintr = defined( 'SOCKET_EINTR' ) ? SOCKET_EINTR
: 4;
2939 $eintrMessage = "stream_select(): unable to select [$eintr]";
2941 // Build a table mapping resource IDs to pipe FDs to work around a
2942 // PHP 5.3 issue in which stream_select() does not preserve array keys
2943 // <https://bugs.php.net/bug.php?id=53427>.
2945 foreach ( $pipes as $fd => $pipe ) {
2946 $fds[(int)$pipe] = $fd;
2950 $status = proc_get_status( $proc );
2951 if ( !$status['running'] ) {
2956 $readyPipes = $pipes;
2959 // @codingStandardsIgnoreStart Generic.PHP.NoSilencedErrors.Discouraged
2960 @trigger_error
( '' );
2961 if ( @stream_select
( $readyPipes, $emptyArray, $emptyArray, null ) === false ) {
2962 // @codingStandardsIgnoreEnd
2963 $error = error_get_last();
2964 if ( strncmp( $error['message'], $eintrMessage, strlen( $eintrMessage ) ) == 0 ) {
2967 trigger_error( $error['message'], E_USER_WARNING
);
2968 $logMsg = $error['message'];
2972 foreach ( $readyPipes as $pipe ) {
2973 $block = fread( $pipe, 65536 );
2974 $fd = $fds[(int)$pipe];
2975 if ( $block === '' ) {
2977 fclose( $pipes[$fd] );
2978 unset( $pipes[$fd] );
2982 } elseif ( $block === false ) {
2984 $logMsg = "Error reading from pipe";
2986 } elseif ( $fd == 1 ) {
2988 $outBuffer .= $block;
2989 } elseif ( $fd == 3 ) {
2991 $logBuffer .= $block;
2992 if ( strpos( $block, "\n" ) !== false ) {
2993 $lines = explode( "\n", $logBuffer );
2994 $logBuffer = array_pop( $lines );
2995 foreach ( $lines as $line ) {
2996 wfDebugLog( 'exec', $line );
3003 foreach ( $pipes as $pipe ) {
3007 // Use the status previously collected if possible, since proc_get_status()
3008 // just calls waitpid() which will not return anything useful the second time.
3009 if ( $status === false ) {
3010 $status = proc_get_status( $proc );
3013 if ( $logMsg !== false ) {
3014 // Read/select error
3016 proc_close( $proc );
3017 } elseif ( $status['signaled'] ) {
3018 $logMsg = "Exited with signal {$status['termsig']}";
3019 $retval = 128 +
$status['termsig'];
3020 proc_close( $proc );
3022 if ( $status['running'] ) {
3023 $retval = proc_close( $proc );
3025 $retval = $status['exitcode'];
3026 proc_close( $proc );
3028 if ( $retval == 127 ) {
3029 $logMsg = "Possibly missing executable file";
3030 } elseif ( $retval >= 129 && $retval <= 192 ) {
3031 $logMsg = "Probably exited with signal " . ( $retval - 128 );
3035 if ( $logMsg !== false ) {
3036 wfDebugLog( 'exec', "$logMsg: $cmd" );
3043 * Execute a shell command, returning both stdout and stderr. Convenience
3044 * function, as all the arguments to wfShellExec can become unwieldy.
3046 * @note This also includes errors from limit.sh, e.g. if $wgMaxShellFileSize is exceeded.
3047 * @param string $cmd Command line, properly escaped for shell.
3048 * @param null|mixed &$retval Optional, will receive the program's exit code.
3049 * (non-zero is usually failure)
3050 * @param array $environ optional environment variables which should be
3051 * added to the executed command environment.
3052 * @param array $limits Optional array with limits(filesize, memory, time, walltime)
3053 * this overwrites the global wgMaxShell* limits.
3054 * @return string Collected stdout and stderr as a string
3056 function wfShellExecWithStderr( $cmd, &$retval = null, $environ = array(), $limits = array() ) {
3057 return wfShellExec( $cmd, $retval, $environ, $limits, array( 'duplicateStderr' => true ) );
3061 * Workaround for http://bugs.php.net/bug.php?id=45132
3062 * escapeshellarg() destroys non-ASCII characters if LANG is not a UTF-8 locale
3064 function wfInitShellLocale() {
3065 static $done = false;
3070 global $wgShellLocale;
3071 if ( !wfIniGetBool( 'safe_mode' ) ) {
3072 putenv( "LC_CTYPE=$wgShellLocale" );
3073 setlocale( LC_CTYPE
, $wgShellLocale );
3078 * Alias to wfShellWikiCmd()
3080 * @see wfShellWikiCmd()
3082 function wfShellMaintenanceCmd( $script, array $parameters = array(), array $options = array() ) {
3083 return wfShellWikiCmd( $script, $parameters, $options );
3087 * Generate a shell-escaped command line string to run a MediaWiki cli script.
3088 * Note that $parameters should be a flat array and an option with an argument
3089 * should consist of two consecutive items in the array (do not use "--option value").
3091 * @param string $script MediaWiki cli script path
3092 * @param array $parameters Arguments and options to the script
3093 * @param array $options Associative array of options:
3094 * 'php': The path to the php executable
3095 * 'wrapper': Path to a PHP wrapper to handle the maintenance script
3098 function wfShellWikiCmd( $script, array $parameters = array(), array $options = array() ) {
3100 // Give site config file a chance to run the script in a wrapper.
3101 // The caller may likely want to call wfBasename() on $script.
3102 wfRunHooks( 'wfShellWikiCmd', array( &$script, &$parameters, &$options ) );
3103 $cmd = isset( $options['php'] ) ?
array( $options['php'] ) : array( $wgPhpCli );
3104 if ( isset( $options['wrapper'] ) ) {
3105 $cmd[] = $options['wrapper'];
3108 // Escape each parameter for shell
3109 return implode( " ", array_map( 'wfEscapeShellArg', array_merge( $cmd, $parameters ) ) );
3113 * wfMerge attempts to merge differences between three texts.
3114 * Returns true for a clean merge and false for failure or a conflict.
3116 * @param string $old
3117 * @param string $mine
3118 * @param string $yours
3119 * @param string $result
3122 function wfMerge( $old, $mine, $yours, &$result ) {
3125 # This check may also protect against code injection in
3126 # case of broken installations.
3127 wfSuppressWarnings();
3128 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
3129 wfRestoreWarnings();
3131 if ( !$haveDiff3 ) {
3132 wfDebug( "diff3 not found\n" );
3136 # Make temporary files
3138 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
3139 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
3140 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
3142 # NOTE: diff3 issues a warning to stderr if any of the files does not end with
3143 # a newline character. To avoid this, we normalize the trailing whitespace before
3144 # creating the diff.
3146 fwrite( $oldtextFile, rtrim( $old ) . "\n" );
3147 fclose( $oldtextFile );
3148 fwrite( $mytextFile, rtrim( $mine ) . "\n" );
3149 fclose( $mytextFile );
3150 fwrite( $yourtextFile, rtrim( $yours ) . "\n" );
3151 fclose( $yourtextFile );
3153 # Check for a conflict
3154 $cmd = wfEscapeShellArg( $wgDiff3 ) . ' -a --overlap-only ' .
3155 wfEscapeShellArg( $mytextName ) . ' ' .
3156 wfEscapeShellArg( $oldtextName ) . ' ' .
3157 wfEscapeShellArg( $yourtextName );
3158 $handle = popen( $cmd, 'r' );
3160 if ( fgets( $handle, 1024 ) ) {
3168 $cmd = wfEscapeShellArg( $wgDiff3 ) . ' -a -e --merge ' .
3169 wfEscapeShellArg( $mytextName, $oldtextName, $yourtextName );
3170 $handle = popen( $cmd, 'r' );
3173 $data = fread( $handle, 8192 );
3174 if ( strlen( $data ) == 0 ) {
3180 unlink( $mytextName );
3181 unlink( $oldtextName );
3182 unlink( $yourtextName );
3184 if ( $result === '' && $old !== '' && !$conflict ) {
3185 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
3192 * Returns unified plain-text diff of two texts.
3193 * Useful for machine processing of diffs.
3195 * @param string $before The text before the changes.
3196 * @param string $after The text after the changes.
3197 * @param string $params Command-line options for the diff command.
3198 * @return string Unified diff of $before and $after
3200 function wfDiff( $before, $after, $params = '-u' ) {
3201 if ( $before == $after ) {
3206 wfSuppressWarnings();
3207 $haveDiff = $wgDiff && file_exists( $wgDiff );
3208 wfRestoreWarnings();
3210 # This check may also protect against code injection in
3211 # case of broken installations.
3213 wfDebug( "diff executable not found\n" );
3214 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
3215 $format = new UnifiedDiffFormatter();
3216 return $format->format( $diffs );
3219 # Make temporary files
3221 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
3222 $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
3224 fwrite( $oldtextFile, $before );
3225 fclose( $oldtextFile );
3226 fwrite( $newtextFile, $after );
3227 fclose( $newtextFile );
3229 // Get the diff of the two files
3230 $cmd = "$wgDiff " . $params . ' ' . wfEscapeShellArg( $oldtextName, $newtextName );
3232 $h = popen( $cmd, 'r' );
3237 $data = fread( $h, 8192 );
3238 if ( strlen( $data ) == 0 ) {
3246 unlink( $oldtextName );
3247 unlink( $newtextName );
3249 // Kill the --- and +++ lines. They're not useful.
3250 $diff_lines = explode( "\n", $diff );
3251 if ( strpos( $diff_lines[0], '---' ) === 0 ) {
3252 unset( $diff_lines[0] );
3254 if ( strpos( $diff_lines[1], '+++' ) === 0 ) {
3255 unset( $diff_lines[1] );
3258 $diff = implode( "\n", $diff_lines );
3264 * This function works like "use VERSION" in Perl, the program will die with a
3265 * backtrace if the current version of PHP is less than the version provided
3267 * This is useful for extensions which due to their nature are not kept in sync
3268 * with releases, and might depend on other versions of PHP than the main code
3270 * Note: PHP might die due to parsing errors in some cases before it ever
3271 * manages to call this function, such is life
3273 * @see perldoc -f use
3275 * @param string|int|float $req_ver The version to check, can be a string, an integer, or a float
3276 * @throws MWException
3278 function wfUsePHP( $req_ver ) {
3279 $php_ver = PHP_VERSION
;
3281 if ( version_compare( $php_ver, (string)$req_ver, '<' ) ) {
3282 throw new MWException( "PHP $req_ver required--this is only $php_ver" );
3287 * This function works like "use VERSION" in Perl except it checks the version
3288 * of MediaWiki, the program will die with a backtrace if the current version
3289 * of MediaWiki is less than the version provided.
3291 * This is useful for extensions which due to their nature are not kept in sync
3294 * Note: Due to the behavior of PHP's version_compare() which is used in this
3295 * function, if you want to allow the 'wmf' development versions add a 'c' (or
3296 * any single letter other than 'a', 'b' or 'p') as a post-fix to your
3297 * targeted version number. For example if you wanted to allow any variation
3298 * of 1.22 use `wfUseMW( '1.22c' )`. Using an 'a' or 'b' instead of 'c' will
3299 * not result in the same comparison due to the internal logic of
3300 * version_compare().
3302 * @see perldoc -f use
3304 * @param string|int|float $req_ver The version to check, can be a string, an integer, or a float
3305 * @throws MWException
3307 function wfUseMW( $req_ver ) {
3310 if ( version_compare( $wgVersion, (string)$req_ver, '<' ) ) {
3311 throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
3316 * Return the final portion of a pathname.
3317 * Reimplemented because PHP5's "basename()" is buggy with multibyte text.
3318 * http://bugs.php.net/bug.php?id=33898
3320 * PHP's basename() only considers '\' a pathchar on Windows and Netware.
3321 * We'll consider it so always, as we don't want '\s' in our Unix paths either.
3323 * @param string $path
3324 * @param string $suffix String to remove if present
3327 function wfBaseName( $path, $suffix = '' ) {
3328 if ( $suffix == '' ) {
3331 $encSuffix = '(?:' . preg_quote( $suffix, '#' ) . ')?';
3335 if ( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
3343 * Generate a relative path name to the given file.
3344 * May explode on non-matching case-insensitive paths,
3345 * funky symlinks, etc.
3347 * @param string $path Absolute destination path including target filename
3348 * @param string $from Absolute source path, directory only
3351 function wfRelativePath( $path, $from ) {
3352 // Normalize mixed input on Windows...
3353 $path = str_replace( '/', DIRECTORY_SEPARATOR
, $path );
3354 $from = str_replace( '/', DIRECTORY_SEPARATOR
, $from );
3356 // Trim trailing slashes -- fix for drive root
3357 $path = rtrim( $path, DIRECTORY_SEPARATOR
);
3358 $from = rtrim( $from, DIRECTORY_SEPARATOR
);
3360 $pieces = explode( DIRECTORY_SEPARATOR
, dirname( $path ) );
3361 $against = explode( DIRECTORY_SEPARATOR
, $from );
3363 if ( $pieces[0] !== $against[0] ) {
3364 // Non-matching Windows drive letters?
3365 // Return a full path.
3369 // Trim off common prefix
3370 while ( count( $pieces ) && count( $against )
3371 && $pieces[0] == $against[0] ) {
3372 array_shift( $pieces );
3373 array_shift( $against );
3376 // relative dots to bump us to the parent
3377 while ( count( $against ) ) {
3378 array_unshift( $pieces, '..' );
3379 array_shift( $against );
3382 array_push( $pieces, wfBaseName( $path ) );
3384 return implode( DIRECTORY_SEPARATOR
, $pieces );
3388 * Convert an arbitrarily-long digit string from one numeric base
3389 * to another, optionally zero-padding to a minimum column width.
3391 * Supports base 2 through 36; digit values 10-36 are represented
3392 * as lowercase letters a-z. Input is case-insensitive.
3394 * @param string $input Input number
3395 * @param int $sourceBase Base of the input number
3396 * @param int $destBase Desired base of the output
3397 * @param int $pad Minimum number of digits in the output (pad with zeroes)
3398 * @param bool $lowercase Whether to output in lowercase or uppercase
3399 * @param string $engine Either "gmp", "bcmath", or "php"
3400 * @return string|bool The output number as a string, or false on error
3402 function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1,
3403 $lowercase = true, $engine = 'auto'
3405 $input = (string)$input;
3411 $sourceBase != (int)$sourceBase ||
3412 $destBase != (int)$destBase ||
3413 $pad != (int)$pad ||
3415 "/^[" . substr( '0123456789abcdefghijklmnopqrstuvwxyz', 0, $sourceBase ) . "]+$/i",
3422 static $baseChars = array(
3423 10 => 'a', 11 => 'b', 12 => 'c', 13 => 'd', 14 => 'e', 15 => 'f',
3424 16 => 'g', 17 => 'h', 18 => 'i', 19 => 'j', 20 => 'k', 21 => 'l',
3425 22 => 'm', 23 => 'n', 24 => 'o', 25 => 'p', 26 => 'q', 27 => 'r',
3426 28 => 's', 29 => 't', 30 => 'u', 31 => 'v', 32 => 'w', 33 => 'x',
3427 34 => 'y', 35 => 'z',
3429 '0' => 0, '1' => 1, '2' => 2, '3' => 3, '4' => 4, '5' => 5,
3430 '6' => 6, '7' => 7, '8' => 8, '9' => 9, 'a' => 10, 'b' => 11,
3431 'c' => 12, 'd' => 13, 'e' => 14, 'f' => 15, 'g' => 16, 'h' => 17,
3432 'i' => 18, 'j' => 19, 'k' => 20, 'l' => 21, 'm' => 22, 'n' => 23,
3433 'o' => 24, 'p' => 25, 'q' => 26, 'r' => 27, 's' => 28, 't' => 29,
3434 'u' => 30, 'v' => 31, 'w' => 32, 'x' => 33, 'y' => 34, 'z' => 35
3437 if ( extension_loaded( 'gmp' ) && ( $engine == 'auto' ||
$engine == 'gmp' ) ) {
3438 $result = gmp_strval( gmp_init( $input, $sourceBase ), $destBase );
3439 } elseif ( extension_loaded( 'bcmath' ) && ( $engine == 'auto' ||
$engine == 'bcmath' ) ) {
3441 foreach ( str_split( strtolower( $input ) ) as $char ) {
3442 $decimal = bcmul( $decimal, $sourceBase );
3443 $decimal = bcadd( $decimal, $baseChars[$char] );
3446 // @codingStandardsIgnoreStart Generic.CodeAnalysis.ForLoopWithTestFunctionCall.NotAllowed
3447 for ( $result = ''; bccomp( $decimal, 0 ); $decimal = bcdiv( $decimal, $destBase, 0 ) ) {
3448 $result .= $baseChars[bcmod( $decimal, $destBase )];
3450 // @codingStandardsIgnoreEnd
3452 $result = strrev( $result );
3454 $inDigits = array();
3455 foreach ( str_split( strtolower( $input ) ) as $char ) {
3456 $inDigits[] = $baseChars[$char];
3459 // Iterate over the input, modulo-ing out an output digit
3460 // at a time until input is gone.
3462 while ( $inDigits ) {
3464 $workDigits = array();
3467 foreach ( $inDigits as $digit ) {
3468 $work *= $sourceBase;
3471 if ( $workDigits ||
$work >= $destBase ) {
3472 $workDigits[] = (int)( $work / $destBase );
3477 // All that division leaves us with a remainder,
3478 // which is conveniently our next output digit.
3479 $result .= $baseChars[$work];
3482 $inDigits = $workDigits;
3485 $result = strrev( $result );
3488 if ( !$lowercase ) {
3489 $result = strtoupper( $result );
3492 return str_pad( $result, $pad, '0', STR_PAD_LEFT
);
3496 * Check if there is sufficient entropy in php's built-in session generation
3498 * @return bool true = there is sufficient entropy
3500 function wfCheckEntropy() {
3502 ( wfIsWindows() && version_compare( PHP_VERSION
, '5.3.3', '>=' ) )
3503 ||
ini_get( 'session.entropy_file' )
3505 && intval( ini_get( 'session.entropy_length' ) ) >= 32;
3509 * Override session_id before session startup if php's built-in
3510 * session generation code is not secure.
3512 function wfFixSessionID() {
3513 // If the cookie or session id is already set we already have a session and should abort
3514 if ( isset( $_COOKIE[session_name()] ) ||
session_id() ) {
3518 // PHP's built-in session entropy is enabled if:
3519 // - entropy_file is set or you're on Windows with php 5.3.3+
3520 // - AND entropy_length is > 0
3521 // We treat it as disabled if it doesn't have an entropy length of at least 32
3522 $entropyEnabled = wfCheckEntropy();
3524 // If built-in entropy is not enabled or not sufficient override PHP's
3525 // built in session id generation code
3526 if ( !$entropyEnabled ) {
3527 wfDebug( __METHOD__
. ": PHP's built in entropy is disabled or not sufficient, " .
3528 "overriding session id generation using our cryptrand source.\n" );
3529 session_id( MWCryptRand
::generateHex( 32 ) );
3534 * Reset the session_id
3538 function wfResetSessionID() {
3539 global $wgCookieSecure;
3540 $oldSessionId = session_id();
3541 $cookieParams = session_get_cookie_params();
3542 if ( wfCheckEntropy() && $wgCookieSecure == $cookieParams['secure'] ) {
3543 session_regenerate_id( false );
3547 wfSetupSession( MWCryptRand
::generateHex( 32 ) );
3550 $newSessionId = session_id();
3551 wfRunHooks( 'ResetSessionID', array( $oldSessionId, $newSessionId ) );
3555 * Initialise php session
3557 * @param bool $sessionId
3559 function wfSetupSession( $sessionId = false ) {
3560 global $wgSessionsInMemcached, $wgSessionsInObjectCache, $wgCookiePath, $wgCookieDomain,
3561 $wgCookieSecure, $wgCookieHttpOnly, $wgSessionHandler;
3562 if ( $wgSessionsInObjectCache ||
$wgSessionsInMemcached ) {
3563 ObjectCacheSessionHandler
::install();
3564 } elseif ( $wgSessionHandler && $wgSessionHandler != ini_get( 'session.save_handler' ) ) {
3565 # Only set this if $wgSessionHandler isn't null and session.save_handler
3566 # hasn't already been set to the desired value (that causes errors)
3567 ini_set( 'session.save_handler', $wgSessionHandler );
3569 session_set_cookie_params(
3570 0, $wgCookiePath, $wgCookieDomain, $wgCookieSecure, $wgCookieHttpOnly );
3571 session_cache_limiter( 'private, must-revalidate' );
3573 session_id( $sessionId );
3577 wfSuppressWarnings();
3579 wfRestoreWarnings();
3583 * Get an object from the precompiled serialized directory
3585 * @param string $name
3586 * @return mixed The variable on success, false on failure
3588 function wfGetPrecompiledData( $name ) {
3591 $file = "$IP/serialized/$name";
3592 if ( file_exists( $file ) ) {
3593 $blob = file_get_contents( $file );
3595 return unserialize( $blob );
3604 * @param string [$args,...]
3607 function wfMemcKey( /*...*/ ) {
3608 global $wgCachePrefix;
3609 $prefix = $wgCachePrefix === false ?
wfWikiID() : $wgCachePrefix;
3610 $args = func_get_args();
3611 $key = $prefix . ':' . implode( ':', $args );
3612 $key = str_replace( ' ', '_', $key );
3617 * Get a cache key for a foreign DB
3620 * @param string $prefix
3621 * @param string [$args,...]
3624 function wfForeignMemcKey( $db, $prefix /*...*/ ) {
3625 $args = array_slice( func_get_args(), 2 );
3627 $key = "$db-$prefix:" . implode( ':', $args );
3629 $key = $db . ':' . implode( ':', $args );
3631 return str_replace( ' ', '_', $key );
3635 * Get an ASCII string identifying this wiki
3636 * This is used as a prefix in memcached keys
3640 function wfWikiID() {
3641 global $wgDBprefix, $wgDBname;
3642 if ( $wgDBprefix ) {
3643 return "$wgDBname-$wgDBprefix";
3650 * Split a wiki ID into DB name and table prefix
3652 * @param string $wiki
3656 function wfSplitWikiID( $wiki ) {
3657 $bits = explode( '-', $wiki, 2 );
3658 if ( count( $bits ) < 2 ) {
3665 * Get a Database object.
3667 * @param int $db Index of the connection to get. May be DB_MASTER for the
3668 * master (for write queries), DB_SLAVE for potentially lagged read
3669 * queries, or an integer >= 0 for a particular server.
3671 * @param string|string[] $groups Query groups. An array of group names that this query
3672 * belongs to. May contain a single string if the query is only
3675 * @param string|bool $wiki The wiki ID, or false for the current wiki
3677 * Note: multiple calls to wfGetDB(DB_SLAVE) during the course of one request
3678 * will always return the same object, unless the underlying connection or load
3679 * balancer is manually destroyed.
3681 * Note 2: use $this->getDB() in maintenance scripts that may be invoked by
3682 * updater to ensure that a proper database is being updated.
3684 * @return DatabaseBase
3686 function &wfGetDB( $db, $groups = array(), $wiki = false ) {
3687 return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
3691 * Get a load balancer object.
3693 * @param string|bool $wiki wiki ID, or false for the current wiki
3694 * @return LoadBalancer
3696 function wfGetLB( $wiki = false ) {
3697 return wfGetLBFactory()->getMainLB( $wiki );
3701 * Get the load balancer factory object
3705 function &wfGetLBFactory() {
3706 return LBFactory
::singleton();
3711 * Shortcut for RepoGroup::singleton()->findFile()
3713 * @param string $title or Title object
3714 * @param array $options Associative array of options:
3715 * time: requested time for an archived image, or false for the
3716 * current version. An image object will be returned which was
3717 * created at the specified time.
3719 * ignoreRedirect: If true, do not follow file redirects
3721 * private: If true, return restricted (deleted) files if the current
3722 * user is allowed to view them. Otherwise, such files will not
3725 * bypassCache: If true, do not use the process-local cache of File objects
3727 * @return File|bool File, or false if the file does not exist
3729 function wfFindFile( $title, $options = array() ) {
3730 return RepoGroup
::singleton()->findFile( $title, $options );
3734 * Get an object referring to a locally registered file.
3735 * Returns a valid placeholder object if the file does not exist.
3737 * @param Title|string $title
3738 * @return LocalFile|null A File, or null if passed an invalid Title
3740 function wfLocalFile( $title ) {
3741 return RepoGroup
::singleton()->getLocalRepo()->newFile( $title );
3745 * Should low-performance queries be disabled?
3748 * @codeCoverageIgnore
3750 function wfQueriesMustScale() {
3751 global $wgMiserMode;
3753 ||
( SiteStats
::pages() > 100000
3754 && SiteStats
::edits() > 1000000
3755 && SiteStats
::users() > 10000 );
3759 * Get the path to a specified script file, respecting file
3760 * extensions; this is a wrapper around $wgScriptExtension etc.
3761 * except for 'index' and 'load' which use $wgScript/$wgLoadScript
3763 * @param string $script Script filename, sans extension
3766 function wfScript( $script = 'index' ) {
3767 global $wgScriptPath, $wgScriptExtension, $wgScript, $wgLoadScript;
3768 if ( $script === 'index' ) {
3770 } elseif ( $script === 'load' ) {
3771 return $wgLoadScript;
3773 return "{$wgScriptPath}/{$script}{$wgScriptExtension}";
3778 * Get the script URL.
3780 * @return string script URL
3782 function wfGetScriptUrl() {
3783 if ( isset( $_SERVER['SCRIPT_NAME'] ) ) {
3785 # as it was called, minus the query string.
3787 # Some sites use Apache rewrite rules to handle subdomains,
3788 # and have PHP set up in a weird way that causes PHP_SELF
3789 # to contain the rewritten URL instead of the one that the
3790 # outside world sees.
3792 # If in this mode, use SCRIPT_URL instead, which mod_rewrite
3793 # provides containing the "before" URL.
3794 return $_SERVER['SCRIPT_NAME'];
3796 return $_SERVER['URL'];
3801 * Convenience function converts boolean values into "true"
3802 * or "false" (string) values
3804 * @param bool $value
3807 function wfBoolToStr( $value ) {
3808 return $value ?
'true' : 'false';
3812 * Get a platform-independent path to the null file, e.g. /dev/null
3816 function wfGetNull() {
3817 return wfIsWindows() ?
'NUL' : '/dev/null';
3821 * Modern version of wfWaitForSlaves(). Instead of looking at replication lag
3822 * and waiting for it to go down, this waits for the slaves to catch up to the
3823 * master position. Use this when updating very large numbers of rows, as
3824 * in maintenance scripts, to avoid causing too much lag. Of course, this is
3825 * a no-op if there are no slaves.
3827 * @param int|bool $maxLag (deprecated)
3828 * @param string|bool $wiki Wiki identifier accepted by wfGetLB
3829 * @param string|bool $cluster Cluster name accepted by LBFactory. Default: false.
3831 function wfWaitForSlaves( $maxLag = false, $wiki = false, $cluster = false ) {
3832 if ( $cluster !== false ) {
3833 $lb = wfGetLBFactory()->getExternalLB( $cluster );
3835 $lb = wfGetLB( $wiki );
3838 // bug 27975 - Don't try to wait for slaves if there are none
3839 // Prevents permission error when getting master position
3840 if ( $lb->getServerCount() > 1 ) {
3841 $dbw = $lb->getConnection( DB_MASTER
, array(), $wiki );
3842 $pos = $dbw->getMasterPos();
3843 // The DBMS may not support getMasterPos() or the whole
3844 // load balancer might be fake (e.g. $wgAllDBsAreLocalhost).
3845 if ( $pos !== false ) {
3846 $lb->waitForAll( $pos );
3852 * Count down from $seconds to zero on the terminal, with a one-second pause
3853 * between showing each number. For use in command-line scripts.
3855 * @codeCoverageIgnore
3856 * @param int $seconds
3858 function wfCountDown( $seconds ) {
3859 for ( $i = $seconds; $i >= 0; $i-- ) {
3860 if ( $i != $seconds ) {
3861 echo str_repeat( "\x08", strlen( $i +
1 ) );
3873 * Replace all invalid characters with -
3874 * Additional characters can be defined in $wgIllegalFileChars (see bug 20489)
3875 * By default, $wgIllegalFileChars = ':'
3877 * @param string $name Filename to process
3880 function wfStripIllegalFilenameChars( $name ) {
3881 global $wgIllegalFileChars;
3882 $illegalFileChars = $wgIllegalFileChars ?
"|[" . $wgIllegalFileChars . "]" : '';
3883 $name = wfBaseName( $name );
3884 $name = preg_replace(
3885 "/[^" . Title
::legalChars() . "]" . $illegalFileChars . "/",
3893 * Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit;
3895 * @return int Value the memory limit was set to.
3897 function wfMemoryLimit() {
3898 global $wgMemoryLimit;
3899 $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
3900 if ( $memlimit != -1 ) {
3901 $conflimit = wfShorthandToInteger( $wgMemoryLimit );
3902 if ( $conflimit == -1 ) {
3903 wfDebug( "Removing PHP's memory limit\n" );
3904 wfSuppressWarnings();
3905 ini_set( 'memory_limit', $conflimit );
3906 wfRestoreWarnings();
3908 } elseif ( $conflimit > $memlimit ) {
3909 wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
3910 wfSuppressWarnings();
3911 ini_set( 'memory_limit', $conflimit );
3912 wfRestoreWarnings();
3920 * Converts shorthand byte notation to integer form
3922 * @param string $string
3925 function wfShorthandToInteger( $string = '' ) {
3926 $string = trim( $string );
3927 if ( $string === '' ) {
3930 $last = $string[strlen( $string ) - 1];
3931 $val = intval( $string );
3936 // break intentionally missing
3940 // break intentionally missing
3950 * Get the normalised IETF language tag
3951 * See unit test for examples.
3953 * @param string $code The language code.
3954 * @return string The language code which complying with BCP 47 standards.
3956 function wfBCP47( $code ) {
3957 $codeSegment = explode( '-', $code );
3959 foreach ( $codeSegment as $segNo => $seg ) {
3960 // when previous segment is x, it is a private segment and should be lc
3961 if ( $segNo > 0 && strtolower( $codeSegment[( $segNo - 1 )] ) == 'x' ) {
3962 $codeBCP[$segNo] = strtolower( $seg );
3963 // ISO 3166 country code
3964 } elseif ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) {
3965 $codeBCP[$segNo] = strtoupper( $seg );
3966 // ISO 15924 script code
3967 } elseif ( ( strlen( $seg ) == 4 ) && ( $segNo > 0 ) ) {
3968 $codeBCP[$segNo] = ucfirst( strtolower( $seg ) );
3969 // Use lowercase for other cases
3971 $codeBCP[$segNo] = strtolower( $seg );
3974 $langCode = implode( '-', $codeBCP );
3979 * Get a cache object.
3981 * @param int $inputType Cache type, one the the CACHE_* constants.
3984 function wfGetCache( $inputType ) {
3985 return ObjectCache
::getInstance( $inputType );
3989 * Get the main cache object
3993 function wfGetMainCache() {
3994 global $wgMainCacheType;
3995 return ObjectCache
::getInstance( $wgMainCacheType );
3999 * Get the cache object used by the message cache
4003 function wfGetMessageCacheStorage() {
4004 global $wgMessageCacheType;
4005 return ObjectCache
::getInstance( $wgMessageCacheType );
4009 * Get the cache object used by the parser cache
4013 function wfGetParserCacheStorage() {
4014 global $wgParserCacheType;
4015 return ObjectCache
::getInstance( $wgParserCacheType );
4019 * Get the cache object used by the language converter
4023 function wfGetLangConverterCacheStorage() {
4024 global $wgLanguageConverterCacheType;
4025 return ObjectCache
::getInstance( $wgLanguageConverterCacheType );
4029 * Call hook functions defined in $wgHooks
4031 * @param string $event Event name
4032 * @param array $args Parameters passed to hook functions
4033 * @param string|null $deprecatedVersion Optionally mark hook as deprecated with version number
4035 * @return bool True if no handler aborted the hook
4037 function wfRunHooks( $event, array $args = array(), $deprecatedVersion = null ) {
4038 return Hooks
::run( $event, $args, $deprecatedVersion );
4042 * Wrapper around php's unpack.
4044 * @param string $format The format string (See php's docs)
4045 * @param string $data A binary string of binary data
4046 * @param int|bool $length The minimum length of $data or false. This is to
4047 * prevent reading beyond the end of $data. false to disable the check.
4049 * Also be careful when using this function to read unsigned 32 bit integer
4050 * because php might make it negative.
4052 * @throws MWException if $data not long enough, or if unpack fails
4053 * @return array Associative array of the extracted data
4055 function wfUnpack( $format, $data, $length = false ) {
4056 if ( $length !== false ) {
4057 $realLen = strlen( $data );
4058 if ( $realLen < $length ) {
4059 throw new MWException( "Tried to use wfUnpack on a "
4060 . "string of length $realLen, but needed one "
4061 . "of at least length $length."
4066 wfSuppressWarnings();
4067 $result = unpack( $format, $data );
4068 wfRestoreWarnings();
4070 if ( $result === false ) {
4071 // If it cannot extract the packed data.
4072 throw new MWException( "unpack could not unpack binary data" );
4078 * Determine if an image exists on the 'bad image list'.
4080 * The format of MediaWiki:Bad_image_list is as follows:
4081 * * Only list items (lines starting with "*") are considered
4082 * * The first link on a line must be a link to a bad image
4083 * * Any subsequent links on the same line are considered to be exceptions,
4084 * i.e. articles where the image may occur inline.
4086 * @param string $name The image name to check
4087 * @param Title|bool $contextTitle The page on which the image occurs, if known
4088 * @param string $blacklist Wikitext of a file blacklist
4091 function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
4092 static $badImageCache = null; // based on bad_image_list msg
4093 wfProfileIn( __METHOD__
);
4096 $redirectTitle = RepoGroup
::singleton()->checkRedirect( Title
::makeTitle( NS_FILE
, $name ) );
4097 if ( $redirectTitle ) {
4098 $name = $redirectTitle->getDBkey();
4101 # Run the extension hook
4103 if ( !wfRunHooks( 'BadImage', array( $name, &$bad ) ) ) {
4104 wfProfileOut( __METHOD__
);
4108 $cacheable = ( $blacklist === null );
4109 if ( $cacheable && $badImageCache !== null ) {
4110 $badImages = $badImageCache;
4111 } else { // cache miss
4112 if ( $blacklist === null ) {
4113 $blacklist = wfMessage( 'bad_image_list' )->inContentLanguage()->plain(); // site list
4115 # Build the list now
4116 $badImages = array();
4117 $lines = explode( "\n", $blacklist );
4118 foreach ( $lines as $line ) {
4120 if ( substr( $line, 0, 1 ) !== '*' ) {
4126 if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
4130 $exceptions = array();
4131 $imageDBkey = false;
4132 foreach ( $m[1] as $i => $titleText ) {
4133 $title = Title
::newFromText( $titleText );
4134 if ( !is_null( $title ) ) {
4136 $imageDBkey = $title->getDBkey();
4138 $exceptions[$title->getPrefixedDBkey()] = true;
4143 if ( $imageDBkey !== false ) {
4144 $badImages[$imageDBkey] = $exceptions;
4148 $badImageCache = $badImages;
4152 $contextKey = $contextTitle ?
$contextTitle->getPrefixedDBkey() : false;
4153 $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
4154 wfProfileOut( __METHOD__
);
4159 * Determine whether the client at a given source IP is likely to be able to
4160 * access the wiki via HTTPS.
4162 * @param string $ip The IPv4/6 address in the normal human-readable form
4165 function wfCanIPUseHTTPS( $ip ) {
4167 wfRunHooks( 'CanIPUseHTTPS', array( $ip, &$canDo ) );
4172 * Work out the IP address based on various globals
4173 * For trusted proxies, use the XFF client IP (first of the chain)
4175 * @deprecated since 1.19; call $wgRequest->getIP() directly.
4178 function wfGetIP() {
4179 wfDeprecated( __METHOD__
, '1.19' );
4181 return $wgRequest->getIP();
4185 * Checks if an IP is a trusted proxy provider.
4186 * Useful to tell if X-Forwarded-For data is possibly bogus.
4187 * Squid cache servers for the site are whitelisted.
4188 * @deprecated Since 1.24, use IP::isTrustedProxy()
4193 function wfIsTrustedProxy( $ip ) {
4194 return IP
::isTrustedProxy( $ip );
4198 * Checks if an IP matches a proxy we've configured.
4199 * @deprecated Since 1.24, use IP::isConfiguredProxy()
4203 * @since 1.23 Supports CIDR ranges in $wgSquidServersNoPurge
4205 function wfIsConfiguredProxy( $ip ) {
4206 return IP
::isConfiguredProxy( $ip );