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( 'mb_substr' ) ) {
41 * @see Fallback::mb_substr
44 function mb_substr( $str, $start, $count = 'end' ) {
45 return Fallback
::mb_substr( $str, $start, $count );
50 * @see Fallback::mb_substr_split_unicode
53 function mb_substr_split_unicode( $str, $splitPos ) {
54 return Fallback
::mb_substr_split_unicode( $str, $splitPos );
58 if ( !function_exists( 'mb_strlen' ) ) {
61 * @see Fallback::mb_strlen
64 function mb_strlen( $str, $enc = '' ) {
65 return Fallback
::mb_strlen( $str, $enc );
69 if ( !function_exists( 'mb_strpos' ) ) {
72 * @see Fallback::mb_strpos
75 function mb_strpos( $haystack, $needle, $offset = 0, $encoding = '' ) {
76 return Fallback
::mb_strpos( $haystack, $needle, $offset, $encoding );
80 if ( !function_exists( 'mb_strrpos' ) ) {
83 * @see Fallback::mb_strrpos
86 function mb_strrpos( $haystack, $needle, $offset = 0, $encoding = '' ) {
87 return Fallback
::mb_strrpos( $haystack, $needle, $offset, $encoding );
91 // gzdecode function only exists in PHP >= 5.4.0
92 // http://php.net/gzdecode
93 if ( !function_exists( 'gzdecode' ) ) {
99 function gzdecode( $data ) {
100 return gzinflate( substr( $data, 10, -8 ) );
104 // hash_equals function only exists in PHP >= 5.6.0
105 // http://php.net/hash_equals
106 if ( !function_exists( 'hash_equals' ) ) {
108 * Check whether a user-provided string is equal to a fixed-length secret string
109 * without revealing bytes of the secret string through timing differences.
111 * The usual way to compare strings (PHP's === operator or the underlying memcmp()
112 * function in C) is to compare corresponding bytes and stop at the first difference,
113 * which would take longer for a partial match than for a complete mismatch. This
114 * is not secure when one of the strings (e.g. an HMAC or token) must remain secret
115 * and the other may come from an attacker. Statistical analysis of timing measurements
116 * over many requests may allow the attacker to guess the string's bytes one at a time
117 * (and check his guesses) even if the timing differences are extremely small.
119 * When making such a security-sensitive comparison, it is essential that the sequence
120 * in which instructions are executed and memory locations are accessed not depend on
121 * the secret string's value. HOWEVER, for simplicity, we do not attempt to minimize
122 * the inevitable leakage of the string's length. That is generally known anyway as
123 * a chararacteristic of the hash function used to compute the secret value.
125 * Longer explanation: http://www.emerose.com/timing-attacks-explained
127 * @codeCoverageIgnore
128 * @param string $known_string Fixed-length secret string to compare against
129 * @param string $user_string User-provided string
130 * @return bool True if the strings are the same, false otherwise
132 function hash_equals( $known_string, $user_string ) {
133 // Strict type checking as in PHP's native implementation
134 if ( !is_string( $known_string ) ) {
135 trigger_error( 'hash_equals(): Expected known_string to be a string, ' .
136 gettype( $known_string ) . ' given', E_USER_WARNING
);
141 if ( !is_string( $user_string ) ) {
142 trigger_error( 'hash_equals(): Expected user_string to be a string, ' .
143 gettype( $user_string ) . ' given', E_USER_WARNING
);
148 $known_string_len = strlen( $known_string );
149 if ( $known_string_len !== strlen( $user_string ) ) {
154 for ( $i = 0; $i < $known_string_len; $i++
) {
155 $result |
= ord( $known_string[$i] ) ^
ord( $user_string[$i] );
158 return ( $result === 0 );
164 * Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
169 function wfArrayDiff2( $a, $b ) {
170 return array_udiff( $a, $b, 'wfArrayDiff2_cmp' );
174 * @param array|string $a
175 * @param array|string $b
178 function wfArrayDiff2_cmp( $a, $b ) {
179 if ( is_string( $a ) && is_string( $b ) ) {
180 return strcmp( $a, $b );
181 } elseif ( count( $a ) !== count( $b ) ) {
182 return count( $a ) < count( $b ) ?
-1 : 1;
186 while ( ( list( , $valueA ) = each( $a ) ) && ( list( , $valueB ) = each( $b ) ) ) {
187 $cmp = strcmp( $valueA, $valueB );
197 * Appends to second array if $value differs from that in $default
199 * @param string|int $key
200 * @param mixed $value
201 * @param mixed $default
202 * @param array $changed Array to alter
203 * @throws MWException
205 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
206 if ( is_null( $changed ) ) {
207 throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' );
209 if ( $default[$key] !== $value ) {
210 $changed[$key] = $value;
215 * Merge arrays in the style of getUserPermissionsErrors, with duplicate removal
217 * wfMergeErrorArrays(
218 * array( array( 'x' ) ),
219 * array( array( 'x', '2' ) ),
220 * array( array( 'x' ) ),
221 * array( array( 'y' ) )
230 * @param array $array1,...
233 function wfMergeErrorArrays( /*...*/ ) {
234 $args = func_get_args();
236 foreach ( $args as $errors ) {
237 foreach ( $errors as $params ) {
238 # @todo FIXME: Sometimes get nested arrays for $params,
239 # which leads to E_NOTICEs
240 $spec = implode( "\t", $params );
241 $out[$spec] = $params;
244 return array_values( $out );
248 * Insert array into another array after the specified *KEY*
250 * @param array $array The array.
251 * @param array $insert The array to insert.
252 * @param mixed $after The key to insert after
255 function wfArrayInsertAfter( array $array, array $insert, $after ) {
256 // Find the offset of the element to insert after.
257 $keys = array_keys( $array );
258 $offsetByKey = array_flip( $keys );
260 $offset = $offsetByKey[$after];
262 // Insert at the specified offset
263 $before = array_slice( $array, 0, $offset +
1, true );
264 $after = array_slice( $array, $offset +
1, count( $array ) - $offset, true );
266 $output = $before +
$insert +
$after;
272 * Recursively converts the parameter (an object) to an array with the same data
274 * @param object|array $objOrArray
275 * @param bool $recursive
278 function wfObjectToArray( $objOrArray, $recursive = true ) {
280 if ( is_object( $objOrArray ) ) {
281 $objOrArray = get_object_vars( $objOrArray );
283 foreach ( $objOrArray as $key => $value ) {
284 if ( $recursive && ( is_object( $value ) ||
is_array( $value ) ) ) {
285 $value = wfObjectToArray( $value );
288 $array[$key] = $value;
295 * Get a random decimal value between 0 and 1, in a way
296 * not likely to give duplicate values for any realistic
297 * number of articles.
301 function wfRandom() {
302 # The maximum random value is "only" 2^31-1, so get two random
303 # values to reduce the chance of dupes
304 $max = mt_getrandmax() +
1;
305 $rand = number_format( ( mt_rand() * $max +
mt_rand() ) / $max / $max, 12, '.', '' );
311 * Get a random string containing a number of pseudo-random hex
313 * @note This is not secure, if you are trying to generate some sort
314 * of token please use MWCryptRand instead.
316 * @param int $length The length of the string to generate
320 function wfRandomString( $length = 32 ) {
322 for ( $n = 0; $n < $length; $n +
= 7 ) {
323 $str .= sprintf( '%07x', mt_rand() & 0xfffffff );
325 return substr( $str, 0, $length );
329 * We want some things to be included as literal characters in our title URLs
330 * for prettiness, which urlencode encodes by default. According to RFC 1738,
331 * all of the following should be safe:
335 * But + is not safe because it's used to indicate a space; &= are only safe in
336 * paths and not in queries (and we don't distinguish here); ' seems kind of
337 * scary; and urlencode() doesn't touch -_. to begin with. Plus, although /
338 * is reserved, we don't care. So the list we unescape is:
342 * However, IIS7 redirects fail when the url contains a colon (Bug 22709),
343 * so no fancy : for IIS7.
345 * %2F in the page titles seems to fatally break for some reason.
350 function wfUrlencode( $s ) {
353 if ( is_null( $s ) ) {
358 if ( is_null( $needle ) ) {
359 $needle = array( '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F' );
360 if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) ||
361 ( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false )
367 $s = urlencode( $s );
370 array( ';', '@', '$', '!', '*', '(', ')', ',', '/', ':' ),
378 * This function takes two arrays as input, and returns a CGI-style string, e.g.
379 * "days=7&limit=100". Options in the first array override options in the second.
380 * Options set to null or false will not be output.
382 * @param array $array1 ( String|Array )
383 * @param array $array2 ( String|Array )
384 * @param string $prefix
387 function wfArrayToCgi( $array1, $array2 = null, $prefix = '' ) {
388 if ( !is_null( $array2 ) ) {
389 $array1 = $array1 +
$array2;
393 foreach ( $array1 as $key => $value ) {
394 if ( !is_null( $value ) && $value !== false ) {
398 if ( $prefix !== '' ) {
399 $key = $prefix . "[$key]";
401 if ( is_array( $value ) ) {
403 foreach ( $value as $k => $v ) {
404 $cgi .= $firstTime ?
'' : '&';
405 if ( is_array( $v ) ) {
406 $cgi .= wfArrayToCgi( $v, null, $key . "[$k]" );
408 $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v );
413 if ( is_object( $value ) ) {
414 $value = $value->__toString();
416 $cgi .= urlencode( $key ) . '=' . urlencode( $value );
424 * This is the logical opposite of wfArrayToCgi(): it accepts a query string as
425 * its argument and returns the same string in array form. This allows compatibility
426 * with legacy functions that accept raw query strings instead of nice
427 * arrays. Of course, keys and values are urldecode()d.
429 * @param string $query Query string
430 * @return string[] Array version of input
432 function wfCgiToArray( $query ) {
433 if ( isset( $query[0] ) && $query[0] == '?' ) {
434 $query = substr( $query, 1 );
436 $bits = explode( '&', $query );
438 foreach ( $bits as $bit ) {
442 if ( strpos( $bit, '=' ) === false ) {
443 // Pieces like &qwerty become 'qwerty' => '' (at least this is what php does)
447 list( $key, $value ) = explode( '=', $bit );
449 $key = urldecode( $key );
450 $value = urldecode( $value );
451 if ( strpos( $key, '[' ) !== false ) {
452 $keys = array_reverse( explode( '[', $key ) );
453 $key = array_pop( $keys );
455 foreach ( $keys as $k ) {
456 $k = substr( $k, 0, -1 );
457 $temp = array( $k => $temp );
459 if ( isset( $ret[$key] ) ) {
460 $ret[$key] = array_merge( $ret[$key], $temp );
472 * Append a query string to an existing URL, which may or may not already
473 * have query string parameters already. If so, they will be combined.
476 * @param string|string[] $query String or associative array
479 function wfAppendQuery( $url, $query ) {
480 if ( is_array( $query ) ) {
481 $query = wfArrayToCgi( $query );
483 if ( $query != '' ) {
484 if ( false === strpos( $url, '?' ) ) {
495 * Expand a potentially local URL to a fully-qualified URL. Assumes $wgServer
498 * The meaning of the PROTO_* constants is as follows:
499 * PROTO_HTTP: Output a URL starting with http://
500 * PROTO_HTTPS: Output a URL starting with https://
501 * PROTO_RELATIVE: Output a URL starting with // (protocol-relative URL)
502 * PROTO_CURRENT: Output a URL starting with either http:// or https:// , depending
503 * on which protocol was used for the current incoming request
504 * PROTO_CANONICAL: For URLs without a domain, like /w/index.php , use $wgCanonicalServer.
505 * For protocol-relative URLs, use the protocol of $wgCanonicalServer
506 * PROTO_INTERNAL: Like PROTO_CANONICAL, but uses $wgInternalServer instead of $wgCanonicalServer
508 * @todo this won't work with current-path-relative URLs
509 * like "subdir/foo.html", etc.
511 * @param string $url Either fully-qualified or a local path + query
512 * @param string $defaultProto One of the PROTO_* constants. Determines the
513 * protocol to use if $url or $wgServer is protocol-relative
514 * @return string Fully-qualified URL, current-path-relative URL or false if
515 * no valid URL can be constructed
517 function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT
) {
518 global $wgServer, $wgCanonicalServer, $wgInternalServer, $wgRequest,
520 if ( $defaultProto === PROTO_CANONICAL
) {
521 $serverUrl = $wgCanonicalServer;
522 } elseif ( $defaultProto === PROTO_INTERNAL
&& $wgInternalServer !== false ) {
523 // Make $wgInternalServer fall back to $wgServer if not set
524 $serverUrl = $wgInternalServer;
526 $serverUrl = $wgServer;
527 if ( $defaultProto === PROTO_CURRENT
) {
528 $defaultProto = $wgRequest->getProtocol() . '://';
532 // Analyze $serverUrl to obtain its protocol
533 $bits = wfParseUrl( $serverUrl );
534 $serverHasProto = $bits && $bits['scheme'] != '';
536 if ( $defaultProto === PROTO_CANONICAL ||
$defaultProto === PROTO_INTERNAL
) {
537 if ( $serverHasProto ) {
538 $defaultProto = $bits['scheme'] . '://';
540 // $wgCanonicalServer or $wgInternalServer doesn't have a protocol.
541 // This really isn't supposed to happen. Fall back to HTTP in this
543 $defaultProto = PROTO_HTTP
;
547 $defaultProtoWithoutSlashes = substr( $defaultProto, 0, -2 );
549 if ( substr( $url, 0, 2 ) == '//' ) {
550 $url = $defaultProtoWithoutSlashes . $url;
551 } elseif ( substr( $url, 0, 1 ) == '/' ) {
552 // If $serverUrl is protocol-relative, prepend $defaultProtoWithoutSlashes,
553 // otherwise leave it alone.
554 $url = ( $serverHasProto ?
'' : $defaultProtoWithoutSlashes ) . $serverUrl . $url;
557 $bits = wfParseUrl( $url );
559 // ensure proper port for HTTPS arrives in URL
560 // https://bugzilla.wikimedia.org/show_bug.cgi?id=65184
561 if ( $defaultProto === PROTO_HTTPS
&& $wgHttpsPort != 443 ) {
562 $bits['port'] = $wgHttpsPort;
565 if ( $bits && isset( $bits['path'] ) ) {
566 $bits['path'] = wfRemoveDotSegments( $bits['path'] );
567 return wfAssembleUrl( $bits );
571 } elseif ( substr( $url, 0, 1 ) != '/' ) {
572 # URL is a relative path
573 return wfRemoveDotSegments( $url );
576 # Expanded URL is not valid.
581 * This function will reassemble a URL parsed with wfParseURL. This is useful
582 * if you need to edit part of a URL and put it back together.
584 * This is the basic structure used (brackets contain keys for $urlParts):
585 * [scheme][delimiter][user]:[pass]@[host]:[port][path]?[query]#[fragment]
587 * @todo Need to integrate this into wfExpandUrl (bug 32168)
590 * @param array $urlParts URL parts, as output from wfParseUrl
591 * @return string URL assembled from its component parts
593 function wfAssembleUrl( $urlParts ) {
596 if ( isset( $urlParts['delimiter'] ) ) {
597 if ( isset( $urlParts['scheme'] ) ) {
598 $result .= $urlParts['scheme'];
601 $result .= $urlParts['delimiter'];
604 if ( isset( $urlParts['host'] ) ) {
605 if ( isset( $urlParts['user'] ) ) {
606 $result .= $urlParts['user'];
607 if ( isset( $urlParts['pass'] ) ) {
608 $result .= ':' . $urlParts['pass'];
613 $result .= $urlParts['host'];
615 if ( isset( $urlParts['port'] ) ) {
616 $result .= ':' . $urlParts['port'];
620 if ( isset( $urlParts['path'] ) ) {
621 $result .= $urlParts['path'];
624 if ( isset( $urlParts['query'] ) ) {
625 $result .= '?' . $urlParts['query'];
628 if ( isset( $urlParts['fragment'] ) ) {
629 $result .= '#' . $urlParts['fragment'];
636 * Remove all dot-segments in the provided URL path. For example,
637 * '/a/./b/../c/' becomes '/a/c/'. For details on the algorithm, please see
638 * RFC3986 section 5.2.4.
640 * @todo Need to integrate this into wfExpandUrl (bug 32168)
642 * @param string $urlPath URL path, potentially containing dot-segments
643 * @return string URL path with all dot-segments removed
645 function wfRemoveDotSegments( $urlPath ) {
648 $inputLength = strlen( $urlPath );
650 while ( $inputOffset < $inputLength ) {
651 $prefixLengthOne = substr( $urlPath, $inputOffset, 1 );
652 $prefixLengthTwo = substr( $urlPath, $inputOffset, 2 );
653 $prefixLengthThree = substr( $urlPath, $inputOffset, 3 );
654 $prefixLengthFour = substr( $urlPath, $inputOffset, 4 );
657 if ( $prefixLengthTwo == './' ) {
658 # Step A, remove leading "./"
660 } elseif ( $prefixLengthThree == '../' ) {
661 # Step A, remove leading "../"
663 } elseif ( ( $prefixLengthTwo == '/.' ) && ( $inputOffset +
2 == $inputLength ) ) {
664 # Step B, replace leading "/.$" with "/"
666 $urlPath[$inputOffset] = '/';
667 } elseif ( $prefixLengthThree == '/./' ) {
668 # Step B, replace leading "/./" with "/"
670 } elseif ( $prefixLengthThree == '/..' && ( $inputOffset +
3 == $inputLength ) ) {
671 # Step C, replace leading "/..$" with "/" and
672 # remove last path component in output
674 $urlPath[$inputOffset] = '/';
676 } elseif ( $prefixLengthFour == '/../' ) {
677 # Step C, replace leading "/../" with "/" and
678 # remove last path component in output
681 } elseif ( ( $prefixLengthOne == '.' ) && ( $inputOffset +
1 == $inputLength ) ) {
682 # Step D, remove "^.$"
684 } elseif ( ( $prefixLengthTwo == '..' ) && ( $inputOffset +
2 == $inputLength ) ) {
685 # Step D, remove "^..$"
688 # Step E, move leading path segment to output
689 if ( $prefixLengthOne == '/' ) {
690 $slashPos = strpos( $urlPath, '/', $inputOffset +
1 );
692 $slashPos = strpos( $urlPath, '/', $inputOffset );
694 if ( $slashPos === false ) {
695 $output .= substr( $urlPath, $inputOffset );
696 $inputOffset = $inputLength;
698 $output .= substr( $urlPath, $inputOffset, $slashPos - $inputOffset );
699 $inputOffset +
= $slashPos - $inputOffset;
704 $slashPos = strrpos( $output, '/' );
705 if ( $slashPos === false ) {
708 $output = substr( $output, 0, $slashPos );
717 * Returns a regular expression of url protocols
719 * @param bool $includeProtocolRelative If false, remove '//' from the returned protocol list.
720 * DO NOT USE this directly, use wfUrlProtocolsWithoutProtRel() instead
723 function wfUrlProtocols( $includeProtocolRelative = true ) {
724 global $wgUrlProtocols;
726 // Cache return values separately based on $includeProtocolRelative
727 static $withProtRel = null, $withoutProtRel = null;
728 $cachedValue = $includeProtocolRelative ?
$withProtRel : $withoutProtRel;
729 if ( !is_null( $cachedValue ) ) {
733 // Support old-style $wgUrlProtocols strings, for backwards compatibility
734 // with LocalSettings files from 1.5
735 if ( is_array( $wgUrlProtocols ) ) {
736 $protocols = array();
737 foreach ( $wgUrlProtocols as $protocol ) {
738 // Filter out '//' if !$includeProtocolRelative
739 if ( $includeProtocolRelative ||
$protocol !== '//' ) {
740 $protocols[] = preg_quote( $protocol, '/' );
744 $retval = implode( '|', $protocols );
746 // Ignore $includeProtocolRelative in this case
747 // This case exists for pre-1.6 compatibility, and we can safely assume
748 // that '//' won't appear in a pre-1.6 config because protocol-relative
749 // URLs weren't supported until 1.18
750 $retval = $wgUrlProtocols;
753 // Cache return value
754 if ( $includeProtocolRelative ) {
755 $withProtRel = $retval;
757 $withoutProtRel = $retval;
763 * Like wfUrlProtocols(), but excludes '//' from the protocol list. Use this if
764 * you need a regex that matches all URL protocols but does not match protocol-
768 function wfUrlProtocolsWithoutProtRel() {
769 return wfUrlProtocols( false );
773 * parse_url() work-alike, but non-broken. Differences:
775 * 1) Does not raise warnings on bad URLs (just returns false).
776 * 2) Handles protocols that don't use :// (e.g., mailto: and news:, as well as
777 * protocol-relative URLs) correctly.
778 * 3) Adds a "delimiter" element to the array, either '://', ':' or '//' (see (2)).
780 * @param string $url A URL to parse
781 * @return string[] Bits of the URL in an associative array, per PHP docs
783 function wfParseUrl( $url ) {
784 global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
786 // Protocol-relative URLs are handled really badly by parse_url(). It's so
787 // bad that the easiest way to handle them is to just prepend 'http:' and
788 // strip the protocol out later.
789 $wasRelative = substr( $url, 0, 2 ) == '//';
790 if ( $wasRelative ) {
793 wfSuppressWarnings();
794 $bits = parse_url( $url );
796 // parse_url() returns an array without scheme for some invalid URLs, e.g.
797 // parse_url("%0Ahttp://example.com") == array( 'host' => '%0Ahttp', 'path' => 'example.com' )
798 if ( !$bits ||
!isset( $bits['scheme'] ) ) {
802 // parse_url() incorrectly handles schemes case-sensitively. Convert it to lowercase.
803 $bits['scheme'] = strtolower( $bits['scheme'] );
805 // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
806 if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
807 $bits['delimiter'] = '://';
808 } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
809 $bits['delimiter'] = ':';
810 // parse_url detects for news: and mailto: the host part of an url as path
811 // We have to correct this wrong detection
812 if ( isset( $bits['path'] ) ) {
813 $bits['host'] = $bits['path'];
820 /* Provide an empty host for eg. file:/// urls (see bug 28627) */
821 if ( !isset( $bits['host'] ) ) {
825 if ( isset( $bits['path'] ) ) {
826 /* parse_url loses the third / for file:///c:/ urls (but not on variants) */
827 if ( substr( $bits['path'], 0, 1 ) !== '/' ) {
828 $bits['path'] = '/' . $bits['path'];
835 // If the URL was protocol-relative, fix scheme and delimiter
836 if ( $wasRelative ) {
837 $bits['scheme'] = '';
838 $bits['delimiter'] = '//';
844 * Take a URL, make sure it's expanded to fully qualified, and replace any
845 * encoded non-ASCII Unicode characters with their UTF-8 original forms
846 * for more compact display and legibility for local audiences.
848 * @todo handle punycode domains too
853 function wfExpandIRI( $url ) {
854 return preg_replace_callback(
855 '/((?:%[89A-F][0-9A-F])+)/i',
856 'wfExpandIRI_callback',
862 * Private callback for wfExpandIRI
863 * @param array $matches
866 function wfExpandIRI_callback( $matches ) {
867 return urldecode( $matches[1] );
871 * Make URL indexes, appropriate for the el_index field of externallinks.
876 function wfMakeUrlIndexes( $url ) {
877 $bits = wfParseUrl( $url );
879 // Reverse the labels in the hostname, convert to lower case
880 // For emails reverse domainpart only
881 if ( $bits['scheme'] == 'mailto' ) {
882 $mailparts = explode( '@', $bits['host'], 2 );
883 if ( count( $mailparts ) === 2 ) {
884 $domainpart = strtolower( implode( '.', array_reverse( explode( '.', $mailparts[1] ) ) ) );
886 // No domain specified, don't mangle it
889 $reversedHost = $domainpart . '@' . $mailparts[0];
891 $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) );
893 // Add an extra dot to the end
894 // Why? Is it in wrong place in mailto links?
895 if ( substr( $reversedHost, -1, 1 ) !== '.' ) {
896 $reversedHost .= '.';
898 // Reconstruct the pseudo-URL
899 $prot = $bits['scheme'];
900 $index = $prot . $bits['delimiter'] . $reversedHost;
901 // Leave out user and password. Add the port, path, query and fragment
902 if ( isset( $bits['port'] ) ) {
903 $index .= ':' . $bits['port'];
905 if ( isset( $bits['path'] ) ) {
906 $index .= $bits['path'];
910 if ( isset( $bits['query'] ) ) {
911 $index .= '?' . $bits['query'];
913 if ( isset( $bits['fragment'] ) ) {
914 $index .= '#' . $bits['fragment'];
918 return array( "http:$index", "https:$index" );
920 return array( $index );
925 * Check whether a given URL has a domain that occurs in a given set of domains
926 * @param string $url URL
927 * @param array $domains Array of domains (strings)
928 * @return bool True if the host part of $url ends in one of the strings in $domains
930 function wfMatchesDomainList( $url, $domains ) {
931 $bits = wfParseUrl( $url );
932 if ( is_array( $bits ) && isset( $bits['host'] ) ) {
933 $host = '.' . $bits['host'];
934 foreach ( (array)$domains as $domain ) {
935 $domain = '.' . $domain;
936 if ( substr( $host, -strlen( $domain ) ) === $domain ) {
945 * Sends a line to the debug log if enabled or, optionally, to a comment in output.
946 * In normal operation this is a NOP.
948 * Controlling globals:
949 * $wgDebugLogFile - points to the log file
950 * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
951 * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
953 * @param string $text
954 * @param string|bool $dest Destination of the message:
955 * - 'all': both to the log and HTML (debug toolbar or HTML comments)
956 * - 'log': only to the log and not in HTML
957 * For backward compatibility, it can also take a boolean:
958 * - true: same as 'all'
959 * - false: same as 'log'
961 function wfDebug( $text, $dest = 'all' ) {
962 global $wgDebugLogFile, $wgDebugRawPage, $wgDebugLogPrefix;
964 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
968 // Turn $dest into a string if it's a boolean (for b/c)
969 if ( $dest === true ) {
971 } elseif ( $dest === false ) {
975 $timer = wfDebugTimer();
976 if ( $timer !== '' ) {
977 $text = preg_replace( '/[^\n]/', $timer . '\0', $text, 1 );
980 if ( $dest === 'all' ) {
981 MWDebug
::debugMsg( $text );
984 if ( $wgDebugLogFile != '' ) {
985 # Strip unprintables; they can switch terminal modes when binary data
986 # gets dumped, which is pretty annoying.
987 $text = preg_replace( '![\x00-\x08\x0b\x0c\x0e-\x1f]!', ' ', $text );
988 $text = $wgDebugLogPrefix . $text;
989 wfErrorLog( $text, $wgDebugLogFile );
994 * Returns true if debug logging should be suppressed if $wgDebugRawPage = false
997 function wfIsDebugRawPage() {
999 if ( $cache !== null ) {
1002 # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
1003 if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
1005 isset( $_SERVER['SCRIPT_NAME'] )
1006 && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
1017 * Get microsecond timestamps for debug logs
1021 function wfDebugTimer() {
1022 global $wgDebugTimestamps, $wgRequestTime;
1024 if ( !$wgDebugTimestamps ) {
1028 $prefix = sprintf( "%6.4f", microtime( true ) - $wgRequestTime );
1029 $mem = sprintf( "%5.1fM", ( memory_get_usage( true ) / ( 1024 * 1024 ) ) );
1030 return "$prefix $mem ";
1034 * Send a line giving PHP memory usage.
1036 * @param bool $exact Print exact byte values instead of kibibytes (default: false)
1038 function wfDebugMem( $exact = false ) {
1039 $mem = memory_get_usage();
1041 $mem = floor( $mem / 1024 ) . ' KiB';
1045 wfDebug( "Memory usage: $mem\n" );
1049 * Send a line to a supplementary debug log file, if configured, or main debug log if not.
1050 * To configure a supplementary log file, set $wgDebugLogGroups[$logGroup] to a string
1051 * filename or an associative array mapping 'destination' to the desired filename. The
1052 * associative array may also contain a 'sample' key with an integer value, specifying
1053 * a sampling factor.
1055 * @since 1.23 support for sampling log messages via $wgDebugLogGroups.
1057 * @param string $logGroup
1058 * @param string $text
1059 * @param string|bool $dest Destination of the message:
1060 * - 'all': both to the log and HTML (debug toolbar or HTML comments)
1061 * - 'log': only to the log and not in HTML
1062 * - 'private': only to the specifc log if set in $wgDebugLogGroups and
1063 * discarded otherwise
1064 * For backward compatibility, it can also take a boolean:
1065 * - true: same as 'all'
1066 * - false: same as 'private'
1068 function wfDebugLog( $logGroup, $text, $dest = 'all' ) {
1069 global $wgDebugLogGroups;
1071 $text = trim( $text ) . "\n";
1073 // Turn $dest into a string if it's a boolean (for b/c)
1074 if ( $dest === true ) {
1076 } elseif ( $dest === false ) {
1080 if ( !isset( $wgDebugLogGroups[$logGroup] ) ) {
1081 if ( $dest !== 'private' ) {
1082 wfDebug( "[$logGroup] $text", $dest );
1087 if ( $dest === 'all' ) {
1088 MWDebug
::debugMsg( "[$logGroup] $text" );
1091 $logConfig = $wgDebugLogGroups[$logGroup];
1092 if ( $logConfig === false ) {
1095 if ( is_array( $logConfig ) ) {
1096 if ( isset( $logConfig['sample'] ) && mt_rand( 1, $logConfig['sample'] ) !== 1 ) {
1099 $destination = $logConfig['destination'];
1101 $destination = strval( $logConfig );
1104 $time = wfTimestamp( TS_DB
);
1106 $host = wfHostname();
1107 wfErrorLog( "$time $host $wiki: $text", $destination );
1111 * Log for database errors
1113 * @param string $text Database error message.
1115 function wfLogDBError( $text ) {
1116 global $wgDBerrorLog, $wgDBerrorLogTZ;
1117 static $logDBErrorTimeZoneObject = null;
1119 if ( $wgDBerrorLog ) {
1120 $host = wfHostname();
1123 if ( $wgDBerrorLogTZ && !$logDBErrorTimeZoneObject ) {
1124 $logDBErrorTimeZoneObject = new DateTimeZone( $wgDBerrorLogTZ );
1127 // Workaround for https://bugs.php.net/bug.php?id=52063
1128 // Can be removed when min PHP > 5.3.2
1129 if ( $logDBErrorTimeZoneObject === null ) {
1130 $d = date_create( "now" );
1132 $d = date_create( "now", $logDBErrorTimeZoneObject );
1135 $date = $d->format( 'D M j G:i:s T Y' );
1137 $text = "$date\t$host\t$wiki\t" . trim( $text ) . "\n";
1138 wfErrorLog( $text, $wgDBerrorLog );
1143 * Throws a warning that $function is deprecated
1145 * @param string $function
1146 * @param string|bool $version Version of MediaWiki that the function
1147 * was deprecated in (Added in 1.19).
1148 * @param string|bool $component Added in 1.19.
1149 * @param int $callerOffset How far up the call stack is the original
1150 * caller. 2 = function that called the function that called
1151 * wfDeprecated (Added in 1.20)
1155 function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) {
1156 MWDebug
::deprecated( $function, $version, $component, $callerOffset +
1 );
1160 * Send a warning either to the debug log or in a PHP error depending on
1161 * $wgDevelopmentWarnings. To log warnings in production, use wfLogWarning() instead.
1163 * @param string $msg Message to send
1164 * @param int $callerOffset Number of items to go back in the backtrace to
1165 * find the correct caller (1 = function calling wfWarn, ...)
1166 * @param int $level PHP error level; defaults to E_USER_NOTICE;
1167 * only used when $wgDevelopmentWarnings is true
1169 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE
) {
1170 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'auto' );
1174 * Send a warning as a PHP error and the debug log. This is intended for logging
1175 * warnings in production. For logging development warnings, use WfWarn instead.
1177 * @param string $msg Message to send
1178 * @param int $callerOffset Number of items to go back in the backtrace to
1179 * find the correct caller (1 = function calling wfLogWarning, ...)
1180 * @param int $level PHP error level; defaults to E_USER_WARNING
1182 function wfLogWarning( $msg, $callerOffset = 1, $level = E_USER_WARNING
) {
1183 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'production' );
1187 * Log to a file without getting "file size exceeded" signals.
1189 * Can also log to TCP or UDP with the syntax udp://host:port/prefix. This will
1190 * send lines to the specified port, prefixed by the specified prefix and a space.
1192 * @param string $text
1193 * @param string $file Filename
1194 * @throws MWException
1196 function wfErrorLog( $text, $file ) {
1197 if ( substr( $file, 0, 4 ) == 'udp:' ) {
1198 # Needs the sockets extension
1199 if ( preg_match( '!^(tcp|udp):(?://)?\[([0-9a-fA-F:]+)\]:(\d+)(?:/(.*))?$!', $file, $m ) ) {
1200 // IPv6 bracketed host
1202 $port = intval( $m[3] );
1203 $prefix = isset( $m[4] ) ?
$m[4] : false;
1205 } elseif ( preg_match( '!^(tcp|udp):(?://)?([a-zA-Z0-9.-]+):(\d+)(?:/(.*))?$!', $file, $m ) ) {
1207 if ( !IP
::isIPv4( $host ) ) {
1208 $host = gethostbyname( $host );
1210 $port = intval( $m[3] );
1211 $prefix = isset( $m[4] ) ?
$m[4] : false;
1214 throw new MWException( __METHOD__
. ': Invalid UDP specification' );
1217 // Clean it up for the multiplexer
1218 if ( strval( $prefix ) !== '' ) {
1219 $text = preg_replace( '/^/m', $prefix . ' ', $text );
1222 if ( strlen( $text ) > 65506 ) {
1223 $text = substr( $text, 0, 65506 );
1226 if ( substr( $text, -1 ) != "\n" ) {
1229 } elseif ( strlen( $text ) > 65507 ) {
1230 $text = substr( $text, 0, 65507 );
1233 $sock = socket_create( $domain, SOCK_DGRAM
, SOL_UDP
);
1238 socket_sendto( $sock, $text, strlen( $text ), 0, $host, $port );
1239 socket_close( $sock );
1241 wfSuppressWarnings();
1242 $exists = file_exists( $file );
1243 $size = $exists ?
filesize( $file ) : false;
1244 if ( !$exists ||
( $size !== false && $size +
strlen( $text ) < 0x7fffffff ) ) {
1245 file_put_contents( $file, $text, FILE_APPEND
);
1247 wfRestoreWarnings();
1254 function wfLogProfilingData() {
1255 global $wgRequestTime, $wgDebugLogFile, $wgDebugLogGroups, $wgDebugRawPage;
1256 global $wgProfileLimit, $wgUser, $wgRequest;
1258 StatCounter
::singleton()->flush();
1260 $profiler = Profiler
::instance();
1262 # Profiling must actually be enabled...
1263 if ( $profiler->isStub() ) {
1267 // Get total page request time and only show pages that longer than
1268 // $wgProfileLimit time (default is 0)
1269 $elapsed = microtime( true ) - $wgRequestTime;
1270 if ( $elapsed <= $wgProfileLimit ) {
1274 $profiler->logData();
1276 // Check whether this should be logged in the debug file.
1277 if ( isset( $wgDebugLogGroups['profileoutput'] )
1278 && $wgDebugLogGroups['profileoutput'] === false
1280 // Explicitely disabled
1283 if ( !isset( $wgDebugLogGroups['profileoutput'] ) && $wgDebugLogFile == '' ) {
1284 // Logging not enabled; no point going further
1287 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1292 if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1293 $forward = ' forwarded for ' . $_SERVER['HTTP_X_FORWARDED_FOR'];
1295 if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1296 $forward .= ' client IP ' . $_SERVER['HTTP_CLIENT_IP'];
1298 if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1299 $forward .= ' from ' . $_SERVER['HTTP_FROM'];
1302 $forward = "\t(proxied via {$_SERVER['REMOTE_ADDR']}{$forward})";
1304 // Don't load $wgUser at this late stage just for statistics purposes
1305 // @todo FIXME: We can detect some anons even if it is not loaded. See User::getId()
1306 if ( $wgUser->isItemLoaded( 'id' ) && $wgUser->isAnon() ) {
1307 $forward .= ' anon';
1310 // Command line script uses a FauxRequest object which does not have
1311 // any knowledge about an URL and throw an exception instead.
1313 $requestUrl = $wgRequest->getRequestURL();
1314 } catch ( MWException
$e ) {
1315 $requestUrl = 'n/a';
1318 $log = sprintf( "%s\t%04.3f\t%s\n",
1319 gmdate( 'YmdHis' ), $elapsed,
1320 urldecode( $requestUrl . $forward ) );
1322 wfDebugLog( 'profileoutput', $log . $profiler->getOutput() );
1326 * Increment a statistics counter
1328 * @param string $key
1332 function wfIncrStats( $key, $count = 1 ) {
1333 StatCounter
::singleton()->incr( $key, $count );
1337 * Check whether the wiki is in read-only mode.
1341 function wfReadOnly() {
1342 return wfReadOnlyReason() !== false;
1346 * Get the value of $wgReadOnly or the contents of $wgReadOnlyFile.
1348 * @return string|bool String when in read-only mode; false otherwise
1350 function wfReadOnlyReason() {
1351 global $wgReadOnly, $wgReadOnlyFile;
1353 if ( $wgReadOnly === null ) {
1354 // Set $wgReadOnly for faster access next time
1355 if ( is_file( $wgReadOnlyFile ) && filesize( $wgReadOnlyFile ) > 0 ) {
1356 $wgReadOnly = file_get_contents( $wgReadOnlyFile );
1358 $wgReadOnly = false;
1366 * Return a Language object from $langcode
1368 * @param Language|string|bool $langcode Either:
1369 * - a Language object
1370 * - code of the language to get the message for, if it is
1371 * a valid code create a language for that language, if
1372 * it is a string but not a valid code then make a basic
1374 * - a boolean: if it's false then use the global object for
1375 * the current user's language (as a fallback for the old parameter
1376 * functionality), or if it is true then use global object
1377 * for the wiki's content language.
1380 function wfGetLangObj( $langcode = false ) {
1381 # Identify which language to get or create a language object for.
1382 # Using is_object here due to Stub objects.
1383 if ( is_object( $langcode ) ) {
1384 # Great, we already have the object (hopefully)!
1388 global $wgContLang, $wgLanguageCode;
1389 if ( $langcode === true ||
$langcode === $wgLanguageCode ) {
1390 # $langcode is the language code of the wikis content language object.
1391 # or it is a boolean and value is true
1396 if ( $langcode === false ||
$langcode === $wgLang->getCode() ) {
1397 # $langcode is the language code of user language object.
1398 # or it was a boolean and value is false
1402 $validCodes = array_keys( Language
::fetchLanguageNames() );
1403 if ( in_array( $langcode, $validCodes ) ) {
1404 # $langcode corresponds to a valid language.
1405 return Language
::factory( $langcode );
1408 # $langcode is a string, but not a valid language code; use content language.
1409 wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1414 * This is the function for getting translated interface messages.
1416 * @see Message class for documentation how to use them.
1417 * @see https://www.mediawiki.org/wiki/Manual:Messages_API
1419 * This function replaces all old wfMsg* functions.
1421 * @param string|string[] $key Message key, or array of keys
1422 * @param mixed $params,... Normal message parameters
1427 * @see Message::__construct
1429 function wfMessage( $key /*...*/ ) {
1430 $params = func_get_args();
1431 array_shift( $params );
1432 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
1433 $params = $params[0];
1435 return new Message( $key, $params );
1439 * This function accepts multiple message keys and returns a message instance
1440 * for the first message which is non-empty. If all messages are empty then an
1441 * instance of the first message key is returned.
1443 * @param string|string[] $keys,... Message keys
1448 * @see Message::newFallbackSequence
1450 function wfMessageFallback( /*...*/ ) {
1451 $args = func_get_args();
1452 return call_user_func_array( 'Message::newFallbackSequence', $args );
1456 * Get a message from anywhere, for the current user language.
1458 * Use wfMsgForContent() instead if the message should NOT
1459 * change depending on the user preferences.
1461 * @deprecated since 1.18
1463 * @param string $key Lookup key for the message, usually
1464 * defined in languages/Language.php
1466 * Parameters to the message, which can be used to insert variable text into
1467 * it, can be passed to this function in the following formats:
1468 * - One per argument, starting at the second parameter
1469 * - As an array in the second parameter
1470 * These are not shown in the function definition.
1474 function wfMsg( $key ) {
1475 wfDeprecated( __METHOD__
, '1.21' );
1477 $args = func_get_args();
1478 array_shift( $args );
1479 return wfMsgReal( $key, $args );
1483 * Same as above except doesn't transform the message
1485 * @deprecated since 1.18
1487 * @param string $key
1490 function wfMsgNoTrans( $key ) {
1491 wfDeprecated( __METHOD__
, '1.21' );
1493 $args = func_get_args();
1494 array_shift( $args );
1495 return wfMsgReal( $key, $args, true, false, false );
1499 * Get a message from anywhere, for the current global language
1500 * set with $wgLanguageCode.
1502 * Use this if the message should NOT change dependent on the
1503 * language set in the user's preferences. This is the case for
1504 * most text written into logs, as well as link targets (such as
1505 * the name of the copyright policy page). Link titles, on the
1506 * other hand, should be shown in the UI language.
1508 * Note that MediaWiki allows users to change the user interface
1509 * language in their preferences, but a single installation
1510 * typically only contains content in one language.
1512 * Be wary of this distinction: If you use wfMsg() where you should
1513 * use wfMsgForContent(), a user of the software may have to
1514 * customize potentially hundreds of messages in
1515 * order to, e.g., fix a link in every possible language.
1517 * @deprecated since 1.18
1519 * @param string $key Lookup key for the message, usually
1520 * defined in languages/Language.php
1523 function wfMsgForContent( $key ) {
1524 wfDeprecated( __METHOD__
, '1.21' );
1526 global $wgForceUIMsgAsContentMsg;
1527 $args = func_get_args();
1528 array_shift( $args );
1530 if ( is_array( $wgForceUIMsgAsContentMsg )
1531 && in_array( $key, $wgForceUIMsgAsContentMsg )
1533 $forcontent = false;
1535 return wfMsgReal( $key, $args, true, $forcontent );
1539 * Same as above except doesn't transform the message
1541 * @deprecated since 1.18
1543 * @param string $key
1546 function wfMsgForContentNoTrans( $key ) {
1547 wfDeprecated( __METHOD__
, '1.21' );
1549 global $wgForceUIMsgAsContentMsg;
1550 $args = func_get_args();
1551 array_shift( $args );
1553 if ( is_array( $wgForceUIMsgAsContentMsg )
1554 && in_array( $key, $wgForceUIMsgAsContentMsg )
1556 $forcontent = false;
1558 return wfMsgReal( $key, $args, true, $forcontent, false );
1562 * Really get a message
1564 * @deprecated since 1.18
1566 * @param string $key Key to get.
1567 * @param array $args
1568 * @param bool $useDB
1569 * @param string|bool $forContent Language code, or false for user lang, true for content lang.
1570 * @param bool $transform Whether or not to transform the message.
1571 * @return string The requested message.
1573 function wfMsgReal( $key, $args, $useDB = true, $forContent = false, $transform = true ) {
1574 wfDeprecated( __METHOD__
, '1.21' );
1576 wfProfileIn( __METHOD__
);
1577 $message = wfMsgGetKey( $key, $useDB, $forContent, $transform );
1578 $message = wfMsgReplaceArgs( $message, $args );
1579 wfProfileOut( __METHOD__
);
1584 * Fetch a message string value, but don't replace any keys yet.
1586 * @deprecated since 1.18
1588 * @param string $key
1589 * @param bool $useDB
1590 * @param string|bool $langCode Code of the language to get the message for, or
1591 * behaves as a content language switch if it is a boolean.
1592 * @param bool $transform Whether to parse magic words, etc.
1595 function wfMsgGetKey( $key, $useDB = true, $langCode = false, $transform = true ) {
1596 wfDeprecated( __METHOD__
, '1.21' );
1598 wfRunHooks( 'NormalizeMessageKey', array( &$key, &$useDB, &$langCode, &$transform ) );
1600 $cache = MessageCache
::singleton();
1601 $message = $cache->get( $key, $useDB, $langCode );
1602 if ( $message === false ) {
1603 $message = '<' . htmlspecialchars( $key ) . '>';
1604 } elseif ( $transform ) {
1605 $message = $cache->transform( $message );
1611 * Replace message parameter keys on the given formatted output.
1613 * @param string $message
1614 * @param array $args
1618 function wfMsgReplaceArgs( $message, $args ) {
1619 # Fix windows line-endings
1620 # Some messages are split with explode("\n", $msg)
1621 $message = str_replace( "\r", '', $message );
1623 // Replace arguments
1624 if ( count( $args ) ) {
1625 if ( is_array( $args[0] ) ) {
1626 $args = array_values( $args[0] );
1628 $replacementKeys = array();
1629 foreach ( $args as $n => $param ) {
1630 $replacementKeys['$' . ( $n +
1 )] = $param;
1632 $message = strtr( $message, $replacementKeys );
1639 * Return an HTML-escaped version of a message.
1640 * Parameter replacements, if any, are done *after* the HTML-escaping,
1641 * so parameters may contain HTML (eg links or form controls). Be sure
1642 * to pre-escape them if you really do want plaintext, or just wrap
1643 * the whole thing in htmlspecialchars().
1645 * @deprecated since 1.18
1647 * @param string $key
1648 * @param string $args,... Parameters
1651 function wfMsgHtml( $key ) {
1652 wfDeprecated( __METHOD__
, '1.21' );
1654 $args = func_get_args();
1655 array_shift( $args );
1656 return wfMsgReplaceArgs( htmlspecialchars( wfMsgGetKey( $key ) ), $args );
1660 * Return an HTML version of message
1661 * Parameter replacements, if any, are done *after* parsing the wiki-text message,
1662 * so parameters may contain HTML (eg links or form controls). Be sure
1663 * to pre-escape them if you really do want plaintext, or just wrap
1664 * the whole thing in htmlspecialchars().
1666 * @deprecated since 1.18
1668 * @param string $key
1669 * @param string $args,... Parameters
1672 function wfMsgWikiHtml( $key ) {
1673 wfDeprecated( __METHOD__
, '1.21' );
1675 $args = func_get_args();
1676 array_shift( $args );
1677 return wfMsgReplaceArgs(
1678 MessageCache
::singleton()->parse( wfMsgGetKey( $key ), null,
1679 /* can't be set to false */ true, /* interface */ true )->getText(),
1684 * Returns message in the requested format
1686 * @deprecated since 1.18
1688 * @param string $key Key of the message
1689 * @param array $options Processing rules.
1690 * Can take the following options:
1691 * parse: parses wikitext to HTML
1692 * parseinline: parses wikitext to HTML and removes the surrounding
1693 * p's added by parser or tidy
1694 * escape: filters message through htmlspecialchars
1695 * escapenoentities: same, but allows entity references like   through
1696 * replaceafter: parameters are substituted after parsing or escaping
1697 * parsemag: transform the message using magic phrases
1698 * content: fetch message for content language instead of interface
1699 * Also can accept a single associative argument, of the form 'language' => 'xx':
1700 * language: Language object or language code to fetch message for
1701 * (overridden by content).
1702 * Behavior for conflicting options (e.g., parse+parseinline) is undefined.
1706 function wfMsgExt( $key, $options ) {
1707 wfDeprecated( __METHOD__
, '1.21' );
1709 $args = func_get_args();
1710 array_shift( $args );
1711 array_shift( $args );
1712 $options = (array)$options;
1714 foreach ( $options as $arrayKey => $option ) {
1715 if ( !preg_match( '/^[0-9]+|language$/', $arrayKey ) ) {
1716 # An unknown index, neither numeric nor "language"
1717 wfWarn( "wfMsgExt called with incorrect parameter key $arrayKey", 1, E_USER_WARNING
);
1718 } elseif ( preg_match( '/^[0-9]+$/', $arrayKey ) && !in_array( $option,
1719 array( 'parse', 'parseinline', 'escape', 'escapenoentities',
1720 'replaceafter', 'parsemag', 'content' ) ) ) {
1721 # A numeric index with unknown value
1722 wfWarn( "wfMsgExt called with incorrect parameter $option", 1, E_USER_WARNING
);
1726 if ( in_array( 'content', $options, true ) ) {
1729 $langCodeObj = null;
1730 } elseif ( array_key_exists( 'language', $options ) ) {
1731 $forContent = false;
1732 $langCode = wfGetLangObj( $options['language'] );
1733 $langCodeObj = $langCode;
1735 $forContent = false;
1737 $langCodeObj = null;
1740 $string = wfMsgGetKey( $key, /*DB*/true, $langCode, /*Transform*/false );
1742 if ( !in_array( 'replaceafter', $options, true ) ) {
1743 $string = wfMsgReplaceArgs( $string, $args );
1746 $messageCache = MessageCache
::singleton();
1747 $parseInline = in_array( 'parseinline', $options, true );
1748 if ( in_array( 'parse', $options, true ) ||
$parseInline ) {
1749 $string = $messageCache->parse( $string, null, true, !$forContent, $langCodeObj );
1750 if ( $string instanceof ParserOutput
) {
1751 $string = $string->getText();
1754 if ( $parseInline ) {
1755 $string = Parser
::stripOuterParagraph( $string );
1757 } elseif ( in_array( 'parsemag', $options, true ) ) {
1758 $string = $messageCache->transform( $string,
1759 !$forContent, $langCodeObj );
1762 if ( in_array( 'escape', $options, true ) ) {
1763 $string = htmlspecialchars ( $string );
1764 } elseif ( in_array( 'escapenoentities', $options, true ) ) {
1765 $string = Sanitizer
::escapeHtmlAllowEntities( $string );
1768 if ( in_array( 'replaceafter', $options, true ) ) {
1769 $string = wfMsgReplaceArgs( $string, $args );
1776 * Since wfMsg() and co suck, they don't return false if the message key they
1777 * looked up didn't exist but instead the key wrapped in <>'s, this function checks for the
1778 * nonexistence of messages by checking the MessageCache::get() result directly.
1780 * @deprecated since 1.18. Use Message::isDisabled().
1782 * @param string $key The message key looked up
1783 * @return bool True if the message *doesn't* exist.
1785 function wfEmptyMsg( $key ) {
1786 wfDeprecated( __METHOD__
, '1.21' );
1788 return MessageCache
::singleton()->get( $key, /*useDB*/true, /*content*/false ) === false;
1792 * Fetch server name for use in error reporting etc.
1793 * Use real server name if available, so we know which machine
1794 * in a server farm generated the current page.
1798 function wfHostname() {
1800 if ( is_null( $host ) ) {
1802 # Hostname overriding
1803 global $wgOverrideHostname;
1804 if ( $wgOverrideHostname !== false ) {
1805 # Set static and skip any detection
1806 $host = $wgOverrideHostname;
1810 if ( function_exists( 'posix_uname' ) ) {
1811 // This function not present on Windows
1812 $uname = posix_uname();
1816 if ( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1817 $host = $uname['nodename'];
1818 } elseif ( getenv( 'COMPUTERNAME' ) ) {
1819 # Windows computer name
1820 $host = getenv( 'COMPUTERNAME' );
1822 # This may be a virtual server.
1823 $host = $_SERVER['SERVER_NAME'];
1830 * Returns a script tag that stores the amount of time it took MediaWiki to
1831 * handle the request in milliseconds as 'wgBackendResponseTime'.
1833 * If $wgShowHostnames is true, the script will also set 'wgHostname' to the
1834 * hostname of the server handling the request.
1838 function wfReportTime() {
1839 global $wgRequestTime, $wgShowHostnames;
1841 $responseTime = round( ( microtime( true ) - $wgRequestTime ) * 1000 );
1842 $reportVars = array( 'wgBackendResponseTime' => $responseTime );
1843 if ( $wgShowHostnames ) {
1844 $reportVars['wgHostname'] = wfHostname();
1846 return Skin
::makeVariablesScript( $reportVars );
1850 * Safety wrapper for debug_backtrace().
1852 * Will return an empty array if debug_backtrace is disabled, otherwise
1853 * the output from debug_backtrace() (trimmed).
1855 * @param int $limit This parameter can be used to limit the number of stack frames returned
1857 * @return array Array of backtrace information
1859 function wfDebugBacktrace( $limit = 0 ) {
1860 static $disabled = null;
1862 if ( is_null( $disabled ) ) {
1863 $disabled = !function_exists( 'debug_backtrace' );
1865 wfDebug( "debug_backtrace() is disabled\n" );
1872 if ( $limit && version_compare( PHP_VERSION
, '5.4.0', '>=' ) ) {
1873 return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT
, $limit +
1 ), 1 );
1875 return array_slice( debug_backtrace(), 1 );
1880 * Get a debug backtrace as a string
1884 function wfBacktrace() {
1885 global $wgCommandLineMode;
1887 if ( $wgCommandLineMode ) {
1892 $backtrace = wfDebugBacktrace();
1893 foreach ( $backtrace as $call ) {
1894 if ( isset( $call['file'] ) ) {
1895 $f = explode( DIRECTORY_SEPARATOR
, $call['file'] );
1896 $file = $f[count( $f ) - 1];
1900 if ( isset( $call['line'] ) ) {
1901 $line = $call['line'];
1905 if ( $wgCommandLineMode ) {
1906 $msg .= "$file line $line calls ";
1908 $msg .= '<li>' . $file . ' line ' . $line . ' calls ';
1910 if ( !empty( $call['class'] ) ) {
1911 $msg .= $call['class'] . $call['type'];
1913 $msg .= $call['function'] . '()';
1915 if ( $wgCommandLineMode ) {
1921 if ( $wgCommandLineMode ) {
1931 * Get the name of the function which called this function
1932 * wfGetCaller( 1 ) is the function with the wfGetCaller() call (ie. __FUNCTION__)
1933 * wfGetCaller( 2 ) [default] is the caller of the function running wfGetCaller()
1934 * wfGetCaller( 3 ) is the parent of that.
1939 function wfGetCaller( $level = 2 ) {
1940 $backtrace = wfDebugBacktrace( $level +
1 );
1941 if ( isset( $backtrace[$level] ) ) {
1942 return wfFormatStackFrame( $backtrace[$level] );
1949 * Return a string consisting of callers in the stack. Useful sometimes
1950 * for profiling specific points.
1952 * @param int $limit The maximum depth of the stack frame to return, or false for the entire stack.
1955 function wfGetAllCallers( $limit = 3 ) {
1956 $trace = array_reverse( wfDebugBacktrace() );
1957 if ( !$limit ||
$limit > count( $trace ) - 1 ) {
1958 $limit = count( $trace ) - 1;
1960 $trace = array_slice( $trace, -$limit - 1, $limit );
1961 return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1965 * Return a string representation of frame
1967 * @param array $frame
1970 function wfFormatStackFrame( $frame ) {
1971 return isset( $frame['class'] ) ?
1972 $frame['class'] . '::' . $frame['function'] :
1976 /* Some generic result counters, pulled out of SearchEngine */
1981 * @param int $offset
1985 function wfShowingResults( $offset, $limit ) {
1986 return wfMessage( 'showingresults' )->numParams( $limit, $offset +
1 )->parse();
1991 * @todo FIXME: We may want to blacklist some broken browsers
1993 * @param bool $force
1994 * @return bool Whereas client accept gzip compression
1996 function wfClientAcceptsGzip( $force = false ) {
1997 static $result = null;
1998 if ( $result === null ||
$force ) {
2000 if ( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
2001 # @todo FIXME: We may want to blacklist some broken browsers
2004 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
2005 $_SERVER['HTTP_ACCEPT_ENCODING'],
2009 if ( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
2013 wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
2022 * Obtain the offset and limit values from the request string;
2023 * used in special pages
2025 * @param int $deflimit Default limit if none supplied
2026 * @param string $optionname Name of a user preference to check against
2028 * @deprecated since 1.24, just call WebRequest::getLimitOffset() directly
2030 function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
2032 wfDeprecated( __METHOD__
, '1.24' );
2033 return $wgRequest->getLimitOffset( $deflimit, $optionname );
2037 * Escapes the given text so that it may be output using addWikiText()
2038 * without any linking, formatting, etc. making its way through. This
2039 * is achieved by substituting certain characters with HTML entities.
2040 * As required by the callers, "<nowiki>" is not used.
2042 * @param string $text Text to be escaped
2045 function wfEscapeWikiText( $text ) {
2046 static $repl = null, $repl2 = null;
2047 if ( $repl === null ) {
2049 '"' => '"', '&' => '&', "'" => ''', '<' => '<',
2050 '=' => '=', '>' => '>', '[' => '[', ']' => ']',
2051 '{' => '{', '|' => '|', '}' => '}', ';' => ';',
2052 "\n#" => "\n#", "\r#" => "\r#",
2053 "\n*" => "\n*", "\r*" => "\r*",
2054 "\n:" => "\n:", "\r:" => "\r:",
2055 "\n " => "\n ", "\r " => "\r ",
2056 "\n\n" => "\n ", "\r\n" => " \n",
2057 "\n\r" => "\n ", "\r\r" => "\r ",
2058 "\n\t" => "\n	", "\r\t" => "\r	", // "\n\t\n" is treated like "\n\n"
2059 "\n----" => "\n----", "\r----" => "\r----",
2060 '__' => '__', '://' => '://',
2063 // We have to catch everything "\s" matches in PCRE
2064 foreach ( array( 'ISBN', 'RFC', 'PMID' ) as $magic ) {
2065 $repl["$magic "] = "$magic ";
2066 $repl["$magic\t"] = "$magic	";
2067 $repl["$magic\r"] = "$magic ";
2068 $repl["$magic\n"] = "$magic ";
2069 $repl["$magic\f"] = "$magic";
2072 // And handle protocols that don't use "://"
2073 global $wgUrlProtocols;
2075 foreach ( $wgUrlProtocols as $prot ) {
2076 if ( substr( $prot, -1 ) === ':' ) {
2077 $repl2[] = preg_quote( substr( $prot, 0, -1 ), '/' );
2080 $repl2 = $repl2 ?
'/\b(' . join( '|', $repl2 ) . '):/i' : '/^(?!)/';
2082 $text = substr( strtr( "\n$text", $repl ), 1 );
2083 $text = preg_replace( $repl2, '$1:', $text );
2088 * Sets dest to source and returns the original value of dest
2089 * If source is NULL, it just returns the value, it doesn't set the variable
2090 * If force is true, it will set the value even if source is NULL
2092 * @param mixed $dest
2093 * @param mixed $source
2094 * @param bool $force
2097 function wfSetVar( &$dest, $source, $force = false ) {
2099 if ( !is_null( $source ) ||
$force ) {
2106 * As for wfSetVar except setting a bit
2110 * @param bool $state
2114 function wfSetBit( &$dest, $bit, $state = true ) {
2115 $temp = (bool)( $dest & $bit );
2116 if ( !is_null( $state ) ) {
2127 * A wrapper around the PHP function var_export().
2128 * Either print it or add it to the regular output ($wgOut).
2130 * @param mixed $var A PHP variable to dump.
2132 function wfVarDump( $var ) {
2134 $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
2135 if ( headers_sent() ||
!isset( $wgOut ) ||
!is_object( $wgOut ) ) {
2138 $wgOut->addHTML( $s );
2143 * Provide a simple HTTP error.
2145 * @param int|string $code
2146 * @param string $label
2147 * @param string $desc
2149 function wfHttpError( $code, $label, $desc ) {
2152 header( "HTTP/1.0 $code $label" );
2153 header( "Status: $code $label" );
2154 $wgOut->sendCacheControl();
2156 header( 'Content-type: text/html; charset=utf-8' );
2157 print "<!doctype html>" .
2158 '<html><head><title>' .
2159 htmlspecialchars( $label ) .
2160 '</title></head><body><h1>' .
2161 htmlspecialchars( $label ) .
2163 nl2br( htmlspecialchars( $desc ) ) .
2164 "</p></body></html>\n";
2168 * Clear away any user-level output buffers, discarding contents.
2170 * Suitable for 'starting afresh', for instance when streaming
2171 * relatively large amounts of data without buffering, or wanting to
2172 * output image files without ob_gzhandler's compression.
2174 * The optional $resetGzipEncoding parameter controls suppression of
2175 * the Content-Encoding header sent by ob_gzhandler; by default it
2176 * is left. See comments for wfClearOutputBuffers() for why it would
2179 * Note that some PHP configuration options may add output buffer
2180 * layers which cannot be removed; these are left in place.
2182 * @param bool $resetGzipEncoding
2184 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
2185 if ( $resetGzipEncoding ) {
2186 // Suppress Content-Encoding and Content-Length
2187 // headers from 1.10+s wfOutputHandler
2188 global $wgDisableOutputCompression;
2189 $wgDisableOutputCompression = true;
2191 while ( $status = ob_get_status() ) {
2192 if ( $status['type'] == 0 /* PHP_OUTPUT_HANDLER_INTERNAL */ ) {
2193 // Probably from zlib.output_compression or other
2194 // PHP-internal setting which can't be removed.
2196 // Give up, and hope the result doesn't break
2200 if ( !ob_end_clean() ) {
2201 // Could not remove output buffer handler; abort now
2202 // to avoid getting in some kind of infinite loop.
2205 if ( $resetGzipEncoding ) {
2206 if ( $status['name'] == 'ob_gzhandler' ) {
2207 // Reset the 'Content-Encoding' field set by this handler
2208 // so we can start fresh.
2209 header_remove( 'Content-Encoding' );
2217 * More legible than passing a 'false' parameter to wfResetOutputBuffers():
2219 * Clear away output buffers, but keep the Content-Encoding header
2220 * produced by ob_gzhandler, if any.
2222 * This should be used for HTTP 304 responses, where you need to
2223 * preserve the Content-Encoding header of the real result, but
2224 * also need to suppress the output of ob_gzhandler to keep to spec
2225 * and avoid breaking Firefox in rare cases where the headers and
2226 * body are broken over two packets.
2228 function wfClearOutputBuffers() {
2229 wfResetOutputBuffers( false );
2233 * Converts an Accept-* header into an array mapping string values to quality
2236 * @param string $accept
2237 * @param string $def Default
2238 * @return float[] Associative array of string => float pairs
2240 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
2241 # No arg means accept anything (per HTTP spec)
2243 return array( $def => 1.0 );
2248 $parts = explode( ',', $accept );
2250 foreach ( $parts as $part ) {
2251 # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
2252 $values = explode( ';', trim( $part ) );
2254 if ( count( $values ) == 1 ) {
2255 $prefs[$values[0]] = 1.0;
2256 } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
2257 $prefs[$values[0]] = floatval( $match[1] );
2265 * Checks if a given MIME type matches any of the keys in the given
2266 * array. Basic wildcards are accepted in the array keys.
2268 * Returns the matching MIME type (or wildcard) if a match, otherwise
2271 * @param string $type
2272 * @param array $avail
2276 function mimeTypeMatch( $type, $avail ) {
2277 if ( array_key_exists( $type, $avail ) ) {
2280 $parts = explode( '/', $type );
2281 if ( array_key_exists( $parts[0] . '/*', $avail ) ) {
2282 return $parts[0] . '/*';
2283 } elseif ( array_key_exists( '*/*', $avail ) ) {
2292 * Returns the 'best' match between a client's requested internet media types
2293 * and the server's list of available types. Each list should be an associative
2294 * array of type to preference (preference is a float between 0.0 and 1.0).
2295 * Wildcards in the types are acceptable.
2297 * @param array $cprefs Client's acceptable type list
2298 * @param array $sprefs Server's offered types
2301 * @todo FIXME: Doesn't handle params like 'text/plain; charset=UTF-8'
2302 * XXX: generalize to negotiate other stuff
2304 function wfNegotiateType( $cprefs, $sprefs ) {
2307 foreach ( array_keys( $sprefs ) as $type ) {
2308 $parts = explode( '/', $type );
2309 if ( $parts[1] != '*' ) {
2310 $ckey = mimeTypeMatch( $type, $cprefs );
2312 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
2317 foreach ( array_keys( $cprefs ) as $type ) {
2318 $parts = explode( '/', $type );
2319 if ( $parts[1] != '*' && !array_key_exists( $type, $sprefs ) ) {
2320 $skey = mimeTypeMatch( $type, $sprefs );
2322 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
2330 foreach ( array_keys( $combine ) as $type ) {
2331 if ( $combine[$type] > $bestq ) {
2333 $bestq = $combine[$type];
2341 * Reference-counted warning suppression
2345 function wfSuppressWarnings( $end = false ) {
2346 static $suppressCount = 0;
2347 static $originalLevel = false;
2350 if ( $suppressCount ) {
2352 if ( !$suppressCount ) {
2353 error_reporting( $originalLevel );
2357 if ( !$suppressCount ) {
2358 $originalLevel = error_reporting( E_ALL
& ~
(
2373 * Restore error level to previous value
2375 function wfRestoreWarnings() {
2376 wfSuppressWarnings( true );
2379 # Autodetect, convert and provide timestamps of various types
2382 * Unix time - the number of seconds since 1970-01-01 00:00:00 UTC
2384 define( 'TS_UNIX', 0 );
2387 * MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
2389 define( 'TS_MW', 1 );
2392 * MySQL DATETIME (YYYY-MM-DD HH:MM:SS)
2394 define( 'TS_DB', 2 );
2397 * RFC 2822 format, for E-mail and HTTP headers
2399 define( 'TS_RFC2822', 3 );
2402 * ISO 8601 format with no timezone: 1986-02-09T20:00:00Z
2404 * This is used by Special:Export
2406 define( 'TS_ISO_8601', 4 );
2409 * An Exif timestamp (YYYY:MM:DD HH:MM:SS)
2411 * @see http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the
2412 * DateTime tag and page 36 for the DateTimeOriginal and
2413 * DateTimeDigitized tags.
2415 define( 'TS_EXIF', 5 );
2418 * Oracle format time.
2420 define( 'TS_ORACLE', 6 );
2423 * Postgres format time.
2425 define( 'TS_POSTGRES', 7 );
2428 * ISO 8601 basic format with no timezone: 19860209T200000Z. This is used by ResourceLoader
2430 define( 'TS_ISO_8601_BASIC', 9 );
2433 * Get a timestamp string in one of various formats
2435 * @param mixed $outputtype A timestamp in one of the supported formats, the
2436 * function will autodetect which format is supplied and act accordingly.
2437 * @param mixed $ts Optional timestamp to convert, default 0 for the current time
2438 * @return string|bool String / false The same date in the format specified in $outputtype or false
2440 function wfTimestamp( $outputtype = TS_UNIX
, $ts = 0 ) {
2442 $timestamp = new MWTimestamp( $ts );
2443 return $timestamp->getTimestamp( $outputtype );
2444 } catch ( TimestampException
$e ) {
2445 wfDebug( "wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n" );
2451 * Return a formatted timestamp, or null if input is null.
2452 * For dealing with nullable timestamp columns in the database.
2454 * @param int $outputtype
2458 function wfTimestampOrNull( $outputtype = TS_UNIX
, $ts = null ) {
2459 if ( is_null( $ts ) ) {
2462 return wfTimestamp( $outputtype, $ts );
2467 * Convenience function; returns MediaWiki timestamp for the present time.
2471 function wfTimestampNow() {
2473 return wfTimestamp( TS_MW
, time() );
2477 * Check if the operating system is Windows
2479 * @return bool True if it's Windows, false otherwise.
2481 function wfIsWindows() {
2482 static $isWindows = null;
2483 if ( $isWindows === null ) {
2484 $isWindows = substr( php_uname(), 0, 7 ) == 'Windows';
2490 * Check if we are running under HHVM
2494 function wfIsHHVM() {
2495 return defined( 'HHVM_VERSION' );
2499 * Swap two variables
2501 * @deprecated since 1.24
2505 function swap( &$x, &$y ) {
2506 wfDeprecated( __FUNCTION__
, '1.24' );
2513 * Tries to get the system directory for temporary files. First
2514 * $wgTmpDirectory is checked, and then the TMPDIR, TMP, and TEMP
2515 * environment variables are then checked in sequence, and if none are
2516 * set try sys_get_temp_dir().
2518 * NOTE: When possible, use instead the tmpfile() function to create
2519 * temporary files to avoid race conditions on file creation, etc.
2523 function wfTempDir() {
2524 global $wgTmpDirectory;
2526 if ( $wgTmpDirectory !== false ) {
2527 return $wgTmpDirectory;
2530 $tmpDir = array_map( "getenv", array( 'TMPDIR', 'TMP', 'TEMP' ) );
2532 foreach ( $tmpDir as $tmp ) {
2533 if ( $tmp && file_exists( $tmp ) && is_dir( $tmp ) && is_writable( $tmp ) ) {
2537 return sys_get_temp_dir();
2541 * Make directory, and make all parent directories if they don't exist
2543 * @param string $dir Full path to directory to create
2544 * @param int $mode Chmod value to use, default is $wgDirectoryMode
2545 * @param string $caller Optional caller param for debugging.
2546 * @throws MWException
2549 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2550 global $wgDirectoryMode;
2552 if ( FileBackend
::isStoragePath( $dir ) ) { // sanity
2553 throw new MWException( __FUNCTION__
. " given storage path '$dir'." );
2556 if ( !is_null( $caller ) ) {
2557 wfDebug( "$caller: called wfMkdirParents($dir)\n" );
2560 if ( strval( $dir ) === '' ||
( file_exists( $dir ) && is_dir( $dir ) ) ) {
2564 $dir = str_replace( array( '\\', '/' ), DIRECTORY_SEPARATOR
, $dir );
2566 if ( is_null( $mode ) ) {
2567 $mode = $wgDirectoryMode;
2570 // Turn off the normal warning, we're doing our own below
2571 wfSuppressWarnings();
2572 $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2573 wfRestoreWarnings();
2576 //directory may have been created on another request since we last checked
2577 if ( is_dir( $dir ) ) {
2581 // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2582 wfLogWarning( sprintf( "failed to mkdir \"%s\" mode 0%o", $dir, $mode ) );
2588 * Remove a directory and all its content.
2589 * Does not hide error.
2590 * @param string $dir
2592 function wfRecursiveRemoveDir( $dir ) {
2593 wfDebug( __FUNCTION__
. "( $dir )\n" );
2594 // taken from http://de3.php.net/manual/en/function.rmdir.php#98622
2595 if ( is_dir( $dir ) ) {
2596 $objects = scandir( $dir );
2597 foreach ( $objects as $object ) {
2598 if ( $object != "." && $object != ".." ) {
2599 if ( filetype( $dir . '/' . $object ) == "dir" ) {
2600 wfRecursiveRemoveDir( $dir . '/' . $object );
2602 unlink( $dir . '/' . $object );
2612 * @param int $nr The number to format
2613 * @param int $acc The number of digits after the decimal point, default 2
2614 * @param bool $round Whether or not to round the value, default true
2617 function wfPercent( $nr, $acc = 2, $round = true ) {
2618 $ret = sprintf( "%.${acc}f", $nr );
2619 return $round ?
round( $ret, $acc ) . '%' : "$ret%";
2623 * Safety wrapper around ini_get() for boolean settings.
2624 * The values returned from ini_get() are pre-normalized for settings
2625 * set via php.ini or php_flag/php_admin_flag... but *not*
2626 * for those set via php_value/php_admin_value.
2628 * It's fairly common for people to use php_value instead of php_flag,
2629 * which can leave you with an 'off' setting giving a false positive
2630 * for code that just takes the ini_get() return value as a boolean.
2632 * To make things extra interesting, setting via php_value accepts
2633 * "true" and "yes" as true, but php.ini and php_flag consider them false. :)
2634 * Unrecognized values go false... again opposite PHP's own coercion
2635 * from string to bool.
2637 * Luckily, 'properly' set settings will always come back as '0' or '1',
2638 * so we only have to worry about them and the 'improper' settings.
2640 * I frickin' hate PHP... :P
2642 * @param string $setting
2645 function wfIniGetBool( $setting ) {
2646 $val = strtolower( ini_get( $setting ) );
2647 // 'on' and 'true' can't have whitespace around them, but '1' can.
2651 ||
preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2655 * Windows-compatible version of escapeshellarg()
2656 * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
2657 * function puts single quotes in regardless of OS.
2659 * Also fixes the locale problems on Linux in PHP 5.2.6+ (bug backported to
2660 * earlier distro releases of PHP)
2662 * @param string $args,...
2665 function wfEscapeShellArg( /*...*/ ) {
2666 wfInitShellLocale();
2668 $args = func_get_args();
2671 foreach ( $args as $arg ) {
2678 if ( wfIsWindows() ) {
2679 // Escaping for an MSVC-style command line parser and CMD.EXE
2680 // @codingStandardsIgnoreStart For long URLs
2682 // * http://web.archive.org/web/20020708081031/http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
2683 // * http://technet.microsoft.com/en-us/library/cc723564.aspx
2686 // Double the backslashes before any double quotes. Escape the double quotes.
2687 // @codingStandardsIgnoreEnd
2688 $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE
);
2691 foreach ( $tokens as $token ) {
2692 if ( $iteration %
2 == 1 ) {
2693 // Delimiter, a double quote preceded by zero or more slashes
2694 $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
2695 } elseif ( $iteration %
4 == 2 ) {
2696 // ^ in $token will be outside quotes, need to be escaped
2697 $arg .= str_replace( '^', '^^', $token );
2698 } else { // $iteration % 4 == 0
2699 // ^ in $token will appear inside double quotes, so leave as is
2704 // Double the backslashes before the end of the string, because
2705 // we will soon add a quote
2707 if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
2708 $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
2711 // Add surrounding quotes
2712 $retVal .= '"' . $arg . '"';
2714 $retVal .= escapeshellarg( $arg );
2721 * Check if wfShellExec() is effectively disabled via php.ini config
2723 * @return bool|string False or one of (safemode,disabled)
2726 function wfShellExecDisabled() {
2727 static $disabled = null;
2728 if ( is_null( $disabled ) ) {
2729 if ( wfIniGetBool( 'safe_mode' ) ) {
2730 wfDebug( "wfShellExec can't run in safe_mode, PHP's exec functions are too broken.\n" );
2731 $disabled = 'safemode';
2732 } elseif ( !function_exists( 'proc_open' ) ) {
2733 wfDebug( "proc_open() is disabled\n" );
2734 $disabled = 'disabled';
2743 * Execute a shell command, with time and memory limits mirrored from the PHP
2744 * configuration if supported.
2746 * @param string|string[] $cmd If string, a properly shell-escaped command line,
2747 * or an array of unescaped arguments, in which case each value will be escaped
2748 * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
2749 * @param null|mixed &$retval Optional, will receive the program's exit code.
2750 * (non-zero is usually failure). If there is an error from
2751 * read, select, or proc_open(), this will be set to -1.
2752 * @param array $environ Optional environment variables which should be
2753 * added to the executed command environment.
2754 * @param array $limits Optional array with limits(filesize, memory, time, walltime)
2755 * this overwrites the global wgMaxShell* limits.
2756 * @param array $options Array of options:
2757 * - duplicateStderr: Set this to true to duplicate stderr to stdout,
2758 * including errors from limit.sh
2760 * @return string Collected stdout as a string
2762 function wfShellExec( $cmd, &$retval = null, $environ = array(),
2763 $limits = array(), $options = array()
2765 global $IP, $wgMaxShellMemory, $wgMaxShellFileSize, $wgMaxShellTime,
2766 $wgMaxShellWallClockTime, $wgShellCgroup;
2768 $disabled = wfShellExecDisabled();
2771 return $disabled == 'safemode' ?
2772 'Unable to run external programs in safe mode.' :
2773 'Unable to run external programs, proc_open() is disabled.';
2776 $includeStderr = isset( $options['duplicateStderr'] ) && $options['duplicateStderr'];
2778 wfInitShellLocale();
2781 foreach ( $environ as $k => $v ) {
2782 if ( wfIsWindows() ) {
2783 /* Surrounding a set in quotes (method used by wfEscapeShellArg) makes the quotes themselves
2784 * appear in the environment variable, so we must use carat escaping as documented in
2785 * http://technet.microsoft.com/en-us/library/cc723564.aspx
2786 * Note however that the quote isn't listed there, but is needed, and the parentheses
2787 * are listed there but doesn't appear to need it.
2789 $envcmd .= "set $k=" . preg_replace( '/([&|()<>^"])/', '^\\1', $v ) . '&& ';
2791 /* Assume this is a POSIX shell, thus required to accept variable assignments before the command
2792 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_09_01
2794 $envcmd .= "$k=" . escapeshellarg( $v ) . ' ';
2797 if ( is_array( $cmd ) ) {
2798 // Command line may be given as an array, escape each value and glue them together with a space
2800 foreach ( $cmd as $val ) {
2801 $cmdVals[] = wfEscapeShellArg( $val );
2803 $cmd = implode( ' ', $cmdVals );
2806 $cmd = $envcmd . $cmd;
2808 $useLogPipe = false;
2809 if ( is_executable( '/bin/bash' ) ) {
2810 $time = intval ( isset( $limits['time'] ) ?
$limits['time'] : $wgMaxShellTime );
2811 if ( isset( $limits['walltime'] ) ) {
2812 $wallTime = intval( $limits['walltime'] );
2813 } elseif ( isset( $limits['time'] ) ) {
2816 $wallTime = intval( $wgMaxShellWallClockTime );
2818 $mem = intval ( isset( $limits['memory'] ) ?
$limits['memory'] : $wgMaxShellMemory );
2819 $filesize = intval ( isset( $limits['filesize'] ) ?
$limits['filesize'] : $wgMaxShellFileSize );
2821 if ( $time > 0 ||
$mem > 0 ||
$filesize > 0 ||
$wallTime > 0 ) {
2822 $cmd = '/bin/bash ' . escapeshellarg( "$IP/includes/limit.sh" ) . ' ' .
2823 escapeshellarg( $cmd ) . ' ' .
2825 "MW_INCLUDE_STDERR=" . ( $includeStderr ?
'1' : '' ) . ';' .
2826 "MW_CPU_LIMIT=$time; " .
2827 'MW_CGROUP=' . escapeshellarg( $wgShellCgroup ) . '; ' .
2828 "MW_MEM_LIMIT=$mem; " .
2829 "MW_FILE_SIZE_LIMIT=$filesize; " .
2830 "MW_WALL_CLOCK_LIMIT=$wallTime; " .
2831 "MW_USE_LOG_PIPE=yes"
2834 } elseif ( $includeStderr ) {
2837 } elseif ( $includeStderr ) {
2840 wfDebug( "wfShellExec: $cmd\n" );
2843 0 => array( 'file', 'php://stdin', 'r' ),
2844 1 => array( 'pipe', 'w' ),
2845 2 => array( 'file', 'php://stderr', 'w' ) );
2846 if ( $useLogPipe ) {
2847 $desc[3] = array( 'pipe', 'w' );
2850 $proc = proc_open( $cmd, $desc, $pipes );
2852 wfDebugLog( 'exec', "proc_open() failed: $cmd" );
2856 $outBuffer = $logBuffer = '';
2857 $emptyArray = array();
2861 // According to the documentation, it is possible for stream_select()
2862 // to fail due to EINTR. I haven't managed to induce this in testing
2863 // despite sending various signals. If it did happen, the error
2864 // message would take the form:
2866 // stream_select(): unable to select [4]: Interrupted system call (max_fd=5)
2868 // where [4] is the value of the macro EINTR and "Interrupted system
2869 // call" is string which according to the Linux manual is "possibly"
2870 // localised according to LC_MESSAGES.
2871 $eintr = defined( 'SOCKET_EINTR' ) ? SOCKET_EINTR
: 4;
2872 $eintrMessage = "stream_select(): unable to select [$eintr]";
2874 // Build a table mapping resource IDs to pipe FDs to work around a
2875 // PHP 5.3 issue in which stream_select() does not preserve array keys
2876 // <https://bugs.php.net/bug.php?id=53427>.
2878 foreach ( $pipes as $fd => $pipe ) {
2879 $fds[(int)$pipe] = $fd;
2886 while ( $running === true ||
$numReadyPipes !== 0 ) {
2888 $status = proc_get_status( $proc );
2889 // If the process has terminated, switch to nonblocking selects
2890 // for getting any data still waiting to be read.
2891 if ( !$status['running'] ) {
2897 $readyPipes = $pipes;
2900 // @codingStandardsIgnoreStart Generic.PHP.NoSilencedErrors.Discouraged
2901 @trigger_error
( '' );
2902 $numReadyPipes = @stream_select
( $readyPipes, $emptyArray, $emptyArray, $timeout );
2903 if ( $numReadyPipes === false ) {
2904 // @codingStandardsIgnoreEnd
2905 $error = error_get_last();
2906 if ( strncmp( $error['message'], $eintrMessage, strlen( $eintrMessage ) ) == 0 ) {
2909 trigger_error( $error['message'], E_USER_WARNING
);
2910 $logMsg = $error['message'];
2914 foreach ( $readyPipes as $pipe ) {
2915 $block = fread( $pipe, 65536 );
2916 $fd = $fds[(int)$pipe];
2917 if ( $block === '' ) {
2919 fclose( $pipes[$fd] );
2920 unset( $pipes[$fd] );
2924 } elseif ( $block === false ) {
2926 $logMsg = "Error reading from pipe";
2928 } elseif ( $fd == 1 ) {
2930 $outBuffer .= $block;
2931 } elseif ( $fd == 3 ) {
2933 $logBuffer .= $block;
2934 if ( strpos( $block, "\n" ) !== false ) {
2935 $lines = explode( "\n", $logBuffer );
2936 $logBuffer = array_pop( $lines );
2937 foreach ( $lines as $line ) {
2938 wfDebugLog( 'exec', $line );
2945 foreach ( $pipes as $pipe ) {
2949 // Use the status previously collected if possible, since proc_get_status()
2950 // just calls waitpid() which will not return anything useful the second time.
2952 $status = proc_get_status( $proc );
2955 if ( $logMsg !== false ) {
2956 // Read/select error
2958 proc_close( $proc );
2959 } elseif ( $status['signaled'] ) {
2960 $logMsg = "Exited with signal {$status['termsig']}";
2961 $retval = 128 +
$status['termsig'];
2962 proc_close( $proc );
2964 if ( $status['running'] ) {
2965 $retval = proc_close( $proc );
2967 $retval = $status['exitcode'];
2968 proc_close( $proc );
2970 if ( $retval == 127 ) {
2971 $logMsg = "Possibly missing executable file";
2972 } elseif ( $retval >= 129 && $retval <= 192 ) {
2973 $logMsg = "Probably exited with signal " . ( $retval - 128 );
2977 if ( $logMsg !== false ) {
2978 wfDebugLog( 'exec', "$logMsg: $cmd" );
2985 * Execute a shell command, returning both stdout and stderr. Convenience
2986 * function, as all the arguments to wfShellExec can become unwieldy.
2988 * @note This also includes errors from limit.sh, e.g. if $wgMaxShellFileSize is exceeded.
2989 * @param string|string[] $cmd If string, a properly shell-escaped command line,
2990 * or an array of unescaped arguments, in which case each value will be escaped
2991 * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
2992 * @param null|mixed &$retval Optional, will receive the program's exit code.
2993 * (non-zero is usually failure)
2994 * @param array $environ Optional environment variables which should be
2995 * added to the executed command environment.
2996 * @param array $limits Optional array with limits(filesize, memory, time, walltime)
2997 * this overwrites the global wgMaxShell* limits.
2998 * @return string Collected stdout and stderr as a string
3000 function wfShellExecWithStderr( $cmd, &$retval = null, $environ = array(), $limits = array() ) {
3001 return wfShellExec( $cmd, $retval, $environ, $limits, array( 'duplicateStderr' => true ) );
3005 * Workaround for http://bugs.php.net/bug.php?id=45132
3006 * escapeshellarg() destroys non-ASCII characters if LANG is not a UTF-8 locale
3008 function wfInitShellLocale() {
3009 static $done = false;
3014 global $wgShellLocale;
3015 if ( !wfIniGetBool( 'safe_mode' ) ) {
3016 putenv( "LC_CTYPE=$wgShellLocale" );
3017 setlocale( LC_CTYPE
, $wgShellLocale );
3022 * Alias to wfShellWikiCmd()
3024 * @see wfShellWikiCmd()
3026 function wfShellMaintenanceCmd( $script, array $parameters = array(), array $options = array() ) {
3027 return wfShellWikiCmd( $script, $parameters, $options );
3031 * Generate a shell-escaped command line string to run a MediaWiki cli script.
3032 * Note that $parameters should be a flat array and an option with an argument
3033 * should consist of two consecutive items in the array (do not use "--option value").
3035 * @param string $script MediaWiki cli script path
3036 * @param array $parameters Arguments and options to the script
3037 * @param array $options Associative array of options:
3038 * 'php': The path to the php executable
3039 * 'wrapper': Path to a PHP wrapper to handle the maintenance script
3042 function wfShellWikiCmd( $script, array $parameters = array(), array $options = array() ) {
3044 // Give site config file a chance to run the script in a wrapper.
3045 // The caller may likely want to call wfBasename() on $script.
3046 wfRunHooks( 'wfShellWikiCmd', array( &$script, &$parameters, &$options ) );
3047 $cmd = isset( $options['php'] ) ?
array( $options['php'] ) : array( $wgPhpCli );
3048 if ( isset( $options['wrapper'] ) ) {
3049 $cmd[] = $options['wrapper'];
3052 // Escape each parameter for shell
3053 return implode( " ", array_map( 'wfEscapeShellArg', array_merge( $cmd, $parameters ) ) );
3057 * wfMerge attempts to merge differences between three texts.
3058 * Returns true for a clean merge and false for failure or a conflict.
3060 * @param string $old
3061 * @param string $mine
3062 * @param string $yours
3063 * @param string $result
3066 function wfMerge( $old, $mine, $yours, &$result ) {
3069 # This check may also protect against code injection in
3070 # case of broken installations.
3071 wfSuppressWarnings();
3072 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
3073 wfRestoreWarnings();
3075 if ( !$haveDiff3 ) {
3076 wfDebug( "diff3 not found\n" );
3080 # Make temporary files
3082 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
3083 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
3084 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
3086 # NOTE: diff3 issues a warning to stderr if any of the files does not end with
3087 # a newline character. To avoid this, we normalize the trailing whitespace before
3088 # creating the diff.
3090 fwrite( $oldtextFile, rtrim( $old ) . "\n" );
3091 fclose( $oldtextFile );
3092 fwrite( $mytextFile, rtrim( $mine ) . "\n" );
3093 fclose( $mytextFile );
3094 fwrite( $yourtextFile, rtrim( $yours ) . "\n" );
3095 fclose( $yourtextFile );
3097 # Check for a conflict
3098 $cmd = wfEscapeShellArg( $wgDiff3 ) . ' -a --overlap-only ' .
3099 wfEscapeShellArg( $mytextName ) . ' ' .
3100 wfEscapeShellArg( $oldtextName ) . ' ' .
3101 wfEscapeShellArg( $yourtextName );
3102 $handle = popen( $cmd, 'r' );
3104 if ( fgets( $handle, 1024 ) ) {
3112 $cmd = wfEscapeShellArg( $wgDiff3 ) . ' -a -e --merge ' .
3113 wfEscapeShellArg( $mytextName, $oldtextName, $yourtextName );
3114 $handle = popen( $cmd, 'r' );
3117 $data = fread( $handle, 8192 );
3118 if ( strlen( $data ) == 0 ) {
3124 unlink( $mytextName );
3125 unlink( $oldtextName );
3126 unlink( $yourtextName );
3128 if ( $result === '' && $old !== '' && !$conflict ) {
3129 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
3136 * Returns unified plain-text diff of two texts.
3137 * Useful for machine processing of diffs.
3139 * @param string $before The text before the changes.
3140 * @param string $after The text after the changes.
3141 * @param string $params Command-line options for the diff command.
3142 * @return string Unified diff of $before and $after
3144 function wfDiff( $before, $after, $params = '-u' ) {
3145 if ( $before == $after ) {
3150 wfSuppressWarnings();
3151 $haveDiff = $wgDiff && file_exists( $wgDiff );
3152 wfRestoreWarnings();
3154 # This check may also protect against code injection in
3155 # case of broken installations.
3157 wfDebug( "diff executable not found\n" );
3158 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
3159 $format = new UnifiedDiffFormatter();
3160 return $format->format( $diffs );
3163 # Make temporary files
3165 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
3166 $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
3168 fwrite( $oldtextFile, $before );
3169 fclose( $oldtextFile );
3170 fwrite( $newtextFile, $after );
3171 fclose( $newtextFile );
3173 // Get the diff of the two files
3174 $cmd = "$wgDiff " . $params . ' ' . wfEscapeShellArg( $oldtextName, $newtextName );
3176 $h = popen( $cmd, 'r' );
3181 $data = fread( $h, 8192 );
3182 if ( strlen( $data ) == 0 ) {
3190 unlink( $oldtextName );
3191 unlink( $newtextName );
3193 // Kill the --- and +++ lines. They're not useful.
3194 $diff_lines = explode( "\n", $diff );
3195 if ( isset( $diff_lines[0] ) && strpos( $diff_lines[0], '---' ) === 0 ) {
3196 unset( $diff_lines[0] );
3198 if ( isset( $diff_lines[1] ) && strpos( $diff_lines[1], '+++' ) === 0 ) {
3199 unset( $diff_lines[1] );
3202 $diff = implode( "\n", $diff_lines );
3208 * This function works like "use VERSION" in Perl, the program will die with a
3209 * backtrace if the current version of PHP is less than the version provided
3211 * This is useful for extensions which due to their nature are not kept in sync
3212 * with releases, and might depend on other versions of PHP than the main code
3214 * Note: PHP might die due to parsing errors in some cases before it ever
3215 * manages to call this function, such is life
3217 * @see perldoc -f use
3219 * @param string|int|float $req_ver The version to check, can be a string, an integer, or a float
3220 * @throws MWException
3222 function wfUsePHP( $req_ver ) {
3223 $php_ver = PHP_VERSION
;
3225 if ( version_compare( $php_ver, (string)$req_ver, '<' ) ) {
3226 throw new MWException( "PHP $req_ver required--this is only $php_ver" );
3231 * This function works like "use VERSION" in Perl except it checks the version
3232 * of MediaWiki, the program will die with a backtrace if the current version
3233 * of MediaWiki is less than the version provided.
3235 * This is useful for extensions which due to their nature are not kept in sync
3238 * Note: Due to the behavior of PHP's version_compare() which is used in this
3239 * function, if you want to allow the 'wmf' development versions add a 'c' (or
3240 * any single letter other than 'a', 'b' or 'p') as a post-fix to your
3241 * targeted version number. For example if you wanted to allow any variation
3242 * of 1.22 use `wfUseMW( '1.22c' )`. Using an 'a' or 'b' instead of 'c' will
3243 * not result in the same comparison due to the internal logic of
3244 * version_compare().
3246 * @see perldoc -f use
3248 * @param string|int|float $req_ver The version to check, can be a string, an integer, or a float
3249 * @throws MWException
3251 function wfUseMW( $req_ver ) {
3254 if ( version_compare( $wgVersion, (string)$req_ver, '<' ) ) {
3255 throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
3260 * Return the final portion of a pathname.
3261 * Reimplemented because PHP5's "basename()" is buggy with multibyte text.
3262 * http://bugs.php.net/bug.php?id=33898
3264 * PHP's basename() only considers '\' a pathchar on Windows and Netware.
3265 * We'll consider it so always, as we don't want '\s' in our Unix paths either.
3267 * @param string $path
3268 * @param string $suffix String to remove if present
3271 function wfBaseName( $path, $suffix = '' ) {
3272 if ( $suffix == '' ) {
3275 $encSuffix = '(?:' . preg_quote( $suffix, '#' ) . ')?';
3279 if ( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
3287 * Generate a relative path name to the given file.
3288 * May explode on non-matching case-insensitive paths,
3289 * funky symlinks, etc.
3291 * @param string $path Absolute destination path including target filename
3292 * @param string $from Absolute source path, directory only
3295 function wfRelativePath( $path, $from ) {
3296 // Normalize mixed input on Windows...
3297 $path = str_replace( '/', DIRECTORY_SEPARATOR
, $path );
3298 $from = str_replace( '/', DIRECTORY_SEPARATOR
, $from );
3300 // Trim trailing slashes -- fix for drive root
3301 $path = rtrim( $path, DIRECTORY_SEPARATOR
);
3302 $from = rtrim( $from, DIRECTORY_SEPARATOR
);
3304 $pieces = explode( DIRECTORY_SEPARATOR
, dirname( $path ) );
3305 $against = explode( DIRECTORY_SEPARATOR
, $from );
3307 if ( $pieces[0] !== $against[0] ) {
3308 // Non-matching Windows drive letters?
3309 // Return a full path.
3313 // Trim off common prefix
3314 while ( count( $pieces ) && count( $against )
3315 && $pieces[0] == $against[0] ) {
3316 array_shift( $pieces );
3317 array_shift( $against );
3320 // relative dots to bump us to the parent
3321 while ( count( $against ) ) {
3322 array_unshift( $pieces, '..' );
3323 array_shift( $against );
3326 array_push( $pieces, wfBaseName( $path ) );
3328 return implode( DIRECTORY_SEPARATOR
, $pieces );
3332 * Convert an arbitrarily-long digit string from one numeric base
3333 * to another, optionally zero-padding to a minimum column width.
3335 * Supports base 2 through 36; digit values 10-36 are represented
3336 * as lowercase letters a-z. Input is case-insensitive.
3338 * @param string $input Input number
3339 * @param int $sourceBase Base of the input number
3340 * @param int $destBase Desired base of the output
3341 * @param int $pad Minimum number of digits in the output (pad with zeroes)
3342 * @param bool $lowercase Whether to output in lowercase or uppercase
3343 * @param string $engine Either "gmp", "bcmath", or "php"
3344 * @return string|bool The output number as a string, or false on error
3346 function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1,
3347 $lowercase = true, $engine = 'auto'
3349 $input = (string)$input;
3355 $sourceBase != (int)$sourceBase ||
3356 $destBase != (int)$destBase ||
3357 $pad != (int)$pad ||
3359 "/^[" . substr( '0123456789abcdefghijklmnopqrstuvwxyz', 0, $sourceBase ) . "]+$/i",
3366 static $baseChars = array(
3367 10 => 'a', 11 => 'b', 12 => 'c', 13 => 'd', 14 => 'e', 15 => 'f',
3368 16 => 'g', 17 => 'h', 18 => 'i', 19 => 'j', 20 => 'k', 21 => 'l',
3369 22 => 'm', 23 => 'n', 24 => 'o', 25 => 'p', 26 => 'q', 27 => 'r',
3370 28 => 's', 29 => 't', 30 => 'u', 31 => 'v', 32 => 'w', 33 => 'x',
3371 34 => 'y', 35 => 'z',
3373 '0' => 0, '1' => 1, '2' => 2, '3' => 3, '4' => 4, '5' => 5,
3374 '6' => 6, '7' => 7, '8' => 8, '9' => 9, 'a' => 10, 'b' => 11,
3375 'c' => 12, 'd' => 13, 'e' => 14, 'f' => 15, 'g' => 16, 'h' => 17,
3376 'i' => 18, 'j' => 19, 'k' => 20, 'l' => 21, 'm' => 22, 'n' => 23,
3377 'o' => 24, 'p' => 25, 'q' => 26, 'r' => 27, 's' => 28, 't' => 29,
3378 'u' => 30, 'v' => 31, 'w' => 32, 'x' => 33, 'y' => 34, 'z' => 35
3381 if ( extension_loaded( 'gmp' ) && ( $engine == 'auto' ||
$engine == 'gmp' ) ) {
3382 // Removing leading zeros works around broken base detection code in
3383 // some PHP versions (see <https://bugs.php.net/bug.php?id=50175> and
3384 // <https://bugs.php.net/bug.php?id=55398>).
3385 $result = gmp_strval( gmp_init( ltrim( $input, '0' ), $sourceBase ), $destBase );
3386 } elseif ( extension_loaded( 'bcmath' ) && ( $engine == 'auto' ||
$engine == 'bcmath' ) ) {
3388 foreach ( str_split( strtolower( $input ) ) as $char ) {
3389 $decimal = bcmul( $decimal, $sourceBase );
3390 $decimal = bcadd( $decimal, $baseChars[$char] );
3393 // @codingStandardsIgnoreStart Generic.CodeAnalysis.ForLoopWithTestFunctionCall.NotAllowed
3394 for ( $result = ''; bccomp( $decimal, 0 ); $decimal = bcdiv( $decimal, $destBase, 0 ) ) {
3395 $result .= $baseChars[bcmod( $decimal, $destBase )];
3397 // @codingStandardsIgnoreEnd
3399 $result = strrev( $result );
3401 $inDigits = array();
3402 foreach ( str_split( strtolower( $input ) ) as $char ) {
3403 $inDigits[] = $baseChars[$char];
3406 // Iterate over the input, modulo-ing out an output digit
3407 // at a time until input is gone.
3409 while ( $inDigits ) {
3411 $workDigits = array();
3414 foreach ( $inDigits as $digit ) {
3415 $work *= $sourceBase;
3418 if ( $workDigits ||
$work >= $destBase ) {
3419 $workDigits[] = (int)( $work / $destBase );
3424 // All that division leaves us with a remainder,
3425 // which is conveniently our next output digit.
3426 $result .= $baseChars[$work];
3429 $inDigits = $workDigits;
3432 $result = strrev( $result );
3435 if ( !$lowercase ) {
3436 $result = strtoupper( $result );
3439 return str_pad( $result, $pad, '0', STR_PAD_LEFT
);
3443 * Check if there is sufficient entropy in php's built-in session generation
3445 * @return bool True = there is sufficient entropy
3447 function wfCheckEntropy() {
3449 ( wfIsWindows() && version_compare( PHP_VERSION
, '5.3.3', '>=' ) )
3450 ||
ini_get( 'session.entropy_file' )
3452 && intval( ini_get( 'session.entropy_length' ) ) >= 32;
3456 * Override session_id before session startup if php's built-in
3457 * session generation code is not secure.
3459 function wfFixSessionID() {
3460 // If the cookie or session id is already set we already have a session and should abort
3461 if ( isset( $_COOKIE[session_name()] ) ||
session_id() ) {
3465 // PHP's built-in session entropy is enabled if:
3466 // - entropy_file is set or you're on Windows with php 5.3.3+
3467 // - AND entropy_length is > 0
3468 // We treat it as disabled if it doesn't have an entropy length of at least 32
3469 $entropyEnabled = wfCheckEntropy();
3471 // If built-in entropy is not enabled or not sufficient override PHP's
3472 // built in session id generation code
3473 if ( !$entropyEnabled ) {
3474 wfDebug( __METHOD__
. ": PHP's built in entropy is disabled or not sufficient, " .
3475 "overriding session id generation using our cryptrand source.\n" );
3476 session_id( MWCryptRand
::generateHex( 32 ) );
3481 * Reset the session_id
3485 function wfResetSessionID() {
3486 global $wgCookieSecure;
3487 $oldSessionId = session_id();
3488 $cookieParams = session_get_cookie_params();
3489 if ( wfCheckEntropy() && $wgCookieSecure == $cookieParams['secure'] ) {
3490 session_regenerate_id( false );
3494 wfSetupSession( MWCryptRand
::generateHex( 32 ) );
3497 $newSessionId = session_id();
3498 wfRunHooks( 'ResetSessionID', array( $oldSessionId, $newSessionId ) );
3502 * Initialise php session
3504 * @param bool $sessionId
3506 function wfSetupSession( $sessionId = false ) {
3507 global $wgSessionsInMemcached, $wgSessionsInObjectCache, $wgCookiePath, $wgCookieDomain,
3508 $wgCookieSecure, $wgCookieHttpOnly, $wgSessionHandler;
3509 if ( $wgSessionsInObjectCache ||
$wgSessionsInMemcached ) {
3510 ObjectCacheSessionHandler
::install();
3511 } elseif ( $wgSessionHandler && $wgSessionHandler != ini_get( 'session.save_handler' ) ) {
3512 # Only set this if $wgSessionHandler isn't null and session.save_handler
3513 # hasn't already been set to the desired value (that causes errors)
3514 ini_set( 'session.save_handler', $wgSessionHandler );
3516 session_set_cookie_params(
3517 0, $wgCookiePath, $wgCookieDomain, $wgCookieSecure, $wgCookieHttpOnly );
3518 session_cache_limiter( 'private, must-revalidate' );
3520 session_id( $sessionId );
3524 wfSuppressWarnings();
3526 wfRestoreWarnings();
3530 * Get an object from the precompiled serialized directory
3532 * @param string $name
3533 * @return mixed The variable on success, false on failure
3535 function wfGetPrecompiledData( $name ) {
3538 $file = "$IP/serialized/$name";
3539 if ( file_exists( $file ) ) {
3540 $blob = file_get_contents( $file );
3542 return unserialize( $blob );
3551 * @param string $args,...
3554 function wfMemcKey( /*...*/ ) {
3555 global $wgCachePrefix;
3556 $prefix = $wgCachePrefix === false ?
wfWikiID() : $wgCachePrefix;
3557 $args = func_get_args();
3558 $key = $prefix . ':' . implode( ':', $args );
3559 $key = str_replace( ' ', '_', $key );
3564 * Get a cache key for a foreign DB
3567 * @param string $prefix
3568 * @param string $args,...
3571 function wfForeignMemcKey( $db, $prefix /*...*/ ) {
3572 $args = array_slice( func_get_args(), 2 );
3574 $key = "$db-$prefix:" . implode( ':', $args );
3576 $key = $db . ':' . implode( ':', $args );
3578 return str_replace( ' ', '_', $key );
3582 * Get an ASCII string identifying this wiki
3583 * This is used as a prefix in memcached keys
3587 function wfWikiID() {
3588 global $wgDBprefix, $wgDBname;
3589 if ( $wgDBprefix ) {
3590 return "$wgDBname-$wgDBprefix";
3597 * Split a wiki ID into DB name and table prefix
3599 * @param string $wiki
3603 function wfSplitWikiID( $wiki ) {
3604 $bits = explode( '-', $wiki, 2 );
3605 if ( count( $bits ) < 2 ) {
3612 * Get a Database object.
3614 * @param int $db Index of the connection to get. May be DB_MASTER for the
3615 * master (for write queries), DB_SLAVE for potentially lagged read
3616 * queries, or an integer >= 0 for a particular server.
3618 * @param string|string[] $groups Query groups. An array of group names that this query
3619 * belongs to. May contain a single string if the query is only
3622 * @param string|bool $wiki The wiki ID, or false for the current wiki
3624 * Note: multiple calls to wfGetDB(DB_SLAVE) during the course of one request
3625 * will always return the same object, unless the underlying connection or load
3626 * balancer is manually destroyed.
3628 * Note 2: use $this->getDB() in maintenance scripts that may be invoked by
3629 * updater to ensure that a proper database is being updated.
3631 * @return DatabaseBase
3633 function &wfGetDB( $db, $groups = array(), $wiki = false ) {
3634 return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
3638 * Get a load balancer object.
3640 * @param string|bool $wiki Wiki ID, or false for the current wiki
3641 * @return LoadBalancer
3643 function wfGetLB( $wiki = false ) {
3644 return wfGetLBFactory()->getMainLB( $wiki );
3648 * Get the load balancer factory object
3652 function &wfGetLBFactory() {
3653 return LBFactory
::singleton();
3658 * Shortcut for RepoGroup::singleton()->findFile()
3660 * @param string $title String or Title object
3661 * @param array $options Associative array of options:
3662 * time: requested time for an archived image, or false for the
3663 * current version. An image object will be returned which was
3664 * created at the specified time.
3666 * ignoreRedirect: If true, do not follow file redirects
3668 * private: If true, return restricted (deleted) files if the current
3669 * user is allowed to view them. Otherwise, such files will not
3672 * bypassCache: If true, do not use the process-local cache of File objects
3674 * @return File|bool File, or false if the file does not exist
3676 function wfFindFile( $title, $options = array() ) {
3677 return RepoGroup
::singleton()->findFile( $title, $options );
3681 * Get an object referring to a locally registered file.
3682 * Returns a valid placeholder object if the file does not exist.
3684 * @param Title|string $title
3685 * @return LocalFile|null A File, or null if passed an invalid Title
3687 function wfLocalFile( $title ) {
3688 return RepoGroup
::singleton()->getLocalRepo()->newFile( $title );
3692 * Should low-performance queries be disabled?
3695 * @codeCoverageIgnore
3697 function wfQueriesMustScale() {
3698 global $wgMiserMode;
3700 ||
( SiteStats
::pages() > 100000
3701 && SiteStats
::edits() > 1000000
3702 && SiteStats
::users() > 10000 );
3706 * Get the path to a specified script file, respecting file
3707 * extensions; this is a wrapper around $wgScriptExtension etc.
3708 * except for 'index' and 'load' which use $wgScript/$wgLoadScript
3710 * @param string $script Script filename, sans extension
3713 function wfScript( $script = 'index' ) {
3714 global $wgScriptPath, $wgScriptExtension, $wgScript, $wgLoadScript;
3715 if ( $script === 'index' ) {
3717 } elseif ( $script === 'load' ) {
3718 return $wgLoadScript;
3720 return "{$wgScriptPath}/{$script}{$wgScriptExtension}";
3725 * Get the script URL.
3727 * @return string Script URL
3729 function wfGetScriptUrl() {
3730 if ( isset( $_SERVER['SCRIPT_NAME'] ) ) {
3732 # as it was called, minus the query string.
3734 # Some sites use Apache rewrite rules to handle subdomains,
3735 # and have PHP set up in a weird way that causes PHP_SELF
3736 # to contain the rewritten URL instead of the one that the
3737 # outside world sees.
3739 # If in this mode, use SCRIPT_URL instead, which mod_rewrite
3740 # provides containing the "before" URL.
3741 return $_SERVER['SCRIPT_NAME'];
3743 return $_SERVER['URL'];
3748 * Convenience function converts boolean values into "true"
3749 * or "false" (string) values
3751 * @param bool $value
3754 function wfBoolToStr( $value ) {
3755 return $value ?
'true' : 'false';
3759 * Get a platform-independent path to the null file, e.g. /dev/null
3763 function wfGetNull() {
3764 return wfIsWindows() ?
'NUL' : '/dev/null';
3768 * Modern version of wfWaitForSlaves(). Instead of looking at replication lag
3769 * and waiting for it to go down, this waits for the slaves to catch up to the
3770 * master position. Use this when updating very large numbers of rows, as
3771 * in maintenance scripts, to avoid causing too much lag. Of course, this is
3772 * a no-op if there are no slaves.
3774 * @param float|null $ifWritesSince Only wait if writes were done since this UNIX timestamp
3775 * @param string|bool $wiki Wiki identifier accepted by wfGetLB
3776 * @param string|bool $cluster Cluster name accepted by LBFactory. Default: false.
3777 * @param int|null $timeout Max wait time. Default: 1 day (cli), ~10 seconds (web)
3778 * @return bool Success (able to connect and no timeouts reached)
3780 function wfWaitForSlaves(
3781 $ifWritesSince = null, $wiki = false, $cluster = false, $timeout = null
3783 // B/C: first argument used to be "max seconds of lag"; ignore such values
3784 $ifWritesSince = ( $ifWritesSince > 1e9
) ?
$ifWritesSince : null;
3786 if ( $timeout === null ) {
3787 $timeout = ( PHP_SAPI
=== 'cli' ) ?
86400 : 10;
3790 if ( $cluster !== false ) {
3791 $lb = wfGetLBFactory()->getExternalLB( $cluster );
3793 $lb = wfGetLB( $wiki );
3796 // bug 27975 - Don't try to wait for slaves if there are none
3797 // Prevents permission error when getting master position
3798 if ( $lb->getServerCount() > 1 ) {
3799 if ( $ifWritesSince && !$lb->hasMasterConnection() ) {
3800 return true; // assume no writes done
3802 $dbw = $lb->getConnection( DB_MASTER
, array(), $wiki );
3803 if ( $ifWritesSince && $dbw->lastDoneWrites() < $ifWritesSince ) {
3804 return true; // no writes since the last wait
3806 $pos = $dbw->getMasterPos();
3807 // The DBMS may not support getMasterPos() or the whole
3808 // load balancer might be fake (e.g. $wgAllDBsAreLocalhost).
3809 if ( $pos !== false ) {
3810 return $lb->waitForAll( $pos, $timeout );
3818 * Count down from $seconds to zero on the terminal, with a one-second pause
3819 * between showing each number. For use in command-line scripts.
3821 * @codeCoverageIgnore
3822 * @param int $seconds
3824 function wfCountDown( $seconds ) {
3825 for ( $i = $seconds; $i >= 0; $i-- ) {
3826 if ( $i != $seconds ) {
3827 echo str_repeat( "\x08", strlen( $i +
1 ) );
3839 * Replace all invalid characters with -
3840 * Additional characters can be defined in $wgIllegalFileChars (see bug 20489)
3841 * By default, $wgIllegalFileChars = ':'
3843 * @param string $name Filename to process
3846 function wfStripIllegalFilenameChars( $name ) {
3847 global $wgIllegalFileChars;
3848 $illegalFileChars = $wgIllegalFileChars ?
"|[" . $wgIllegalFileChars . "]" : '';
3849 $name = wfBaseName( $name );
3850 $name = preg_replace(
3851 "/[^" . Title
::legalChars() . "]" . $illegalFileChars . "/",
3859 * Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit;
3861 * @return int Value the memory limit was set to.
3863 function wfMemoryLimit() {
3864 global $wgMemoryLimit;
3865 $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
3866 if ( $memlimit != -1 ) {
3867 $conflimit = wfShorthandToInteger( $wgMemoryLimit );
3868 if ( $conflimit == -1 ) {
3869 wfDebug( "Removing PHP's memory limit\n" );
3870 wfSuppressWarnings();
3871 ini_set( 'memory_limit', $conflimit );
3872 wfRestoreWarnings();
3874 } elseif ( $conflimit > $memlimit ) {
3875 wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
3876 wfSuppressWarnings();
3877 ini_set( 'memory_limit', $conflimit );
3878 wfRestoreWarnings();
3886 * Converts shorthand byte notation to integer form
3888 * @param string $string
3891 function wfShorthandToInteger( $string = '' ) {
3892 $string = trim( $string );
3893 if ( $string === '' ) {
3896 $last = $string[strlen( $string ) - 1];
3897 $val = intval( $string );
3902 // break intentionally missing
3906 // break intentionally missing
3916 * Get the normalised IETF language tag
3917 * See unit test for examples.
3919 * @param string $code The language code.
3920 * @return string The language code which complying with BCP 47 standards.
3922 function wfBCP47( $code ) {
3923 $codeSegment = explode( '-', $code );
3925 foreach ( $codeSegment as $segNo => $seg ) {
3926 // when previous segment is x, it is a private segment and should be lc
3927 if ( $segNo > 0 && strtolower( $codeSegment[( $segNo - 1 )] ) == 'x' ) {
3928 $codeBCP[$segNo] = strtolower( $seg );
3929 // ISO 3166 country code
3930 } elseif ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) {
3931 $codeBCP[$segNo] = strtoupper( $seg );
3932 // ISO 15924 script code
3933 } elseif ( ( strlen( $seg ) == 4 ) && ( $segNo > 0 ) ) {
3934 $codeBCP[$segNo] = ucfirst( strtolower( $seg ) );
3935 // Use lowercase for other cases
3937 $codeBCP[$segNo] = strtolower( $seg );
3940 $langCode = implode( '-', $codeBCP );
3945 * Get a cache object.
3947 * @param int $inputType Cache type, one the the CACHE_* constants.
3950 function wfGetCache( $inputType ) {
3951 return ObjectCache
::getInstance( $inputType );
3955 * Get the main cache object
3959 function wfGetMainCache() {
3960 global $wgMainCacheType;
3961 return ObjectCache
::getInstance( $wgMainCacheType );
3965 * Get the cache object used by the message cache
3969 function wfGetMessageCacheStorage() {
3970 global $wgMessageCacheType;
3971 return ObjectCache
::getInstance( $wgMessageCacheType );
3975 * Get the cache object used by the parser cache
3979 function wfGetParserCacheStorage() {
3980 global $wgParserCacheType;
3981 return ObjectCache
::getInstance( $wgParserCacheType );
3985 * Get the cache object used by the language converter
3989 function wfGetLangConverterCacheStorage() {
3990 global $wgLanguageConverterCacheType;
3991 return ObjectCache
::getInstance( $wgLanguageConverterCacheType );
3995 * Call hook functions defined in $wgHooks
3997 * @param string $event Event name
3998 * @param array $args Parameters passed to hook functions
3999 * @param string|null $deprecatedVersion Optionally mark hook as deprecated with version number
4001 * @return bool True if no handler aborted the hook
4003 function wfRunHooks( $event, array $args = array(), $deprecatedVersion = null ) {
4004 return Hooks
::run( $event, $args, $deprecatedVersion );
4008 * Wrapper around php's unpack.
4010 * @param string $format The format string (See php's docs)
4011 * @param string $data A binary string of binary data
4012 * @param int|bool $length The minimum length of $data or false. This is to
4013 * prevent reading beyond the end of $data. false to disable the check.
4015 * Also be careful when using this function to read unsigned 32 bit integer
4016 * because php might make it negative.
4018 * @throws MWException If $data not long enough, or if unpack fails
4019 * @return array Associative array of the extracted data
4021 function wfUnpack( $format, $data, $length = false ) {
4022 if ( $length !== false ) {
4023 $realLen = strlen( $data );
4024 if ( $realLen < $length ) {
4025 throw new MWException( "Tried to use wfUnpack on a "
4026 . "string of length $realLen, but needed one "
4027 . "of at least length $length."
4032 wfSuppressWarnings();
4033 $result = unpack( $format, $data );
4034 wfRestoreWarnings();
4036 if ( $result === false ) {
4037 // If it cannot extract the packed data.
4038 throw new MWException( "unpack could not unpack binary data" );
4044 * Determine if an image exists on the 'bad image list'.
4046 * The format of MediaWiki:Bad_image_list is as follows:
4047 * * Only list items (lines starting with "*") are considered
4048 * * The first link on a line must be a link to a bad image
4049 * * Any subsequent links on the same line are considered to be exceptions,
4050 * i.e. articles where the image may occur inline.
4052 * @param string $name The image name to check
4053 * @param Title|bool $contextTitle The page on which the image occurs, if known
4054 * @param string $blacklist Wikitext of a file blacklist
4057 function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
4058 static $badImageCache = null; // based on bad_image_list msg
4059 wfProfileIn( __METHOD__
);
4062 $redirectTitle = RepoGroup
::singleton()->checkRedirect( Title
::makeTitle( NS_FILE
, $name ) );
4063 if ( $redirectTitle ) {
4064 $name = $redirectTitle->getDBkey();
4067 # Run the extension hook
4069 if ( !wfRunHooks( 'BadImage', array( $name, &$bad ) ) ) {
4070 wfProfileOut( __METHOD__
);
4074 $cacheable = ( $blacklist === null );
4075 if ( $cacheable && $badImageCache !== null ) {
4076 $badImages = $badImageCache;
4077 } else { // cache miss
4078 if ( $blacklist === null ) {
4079 $blacklist = wfMessage( 'bad_image_list' )->inContentLanguage()->plain(); // site list
4081 # Build the list now
4082 $badImages = array();
4083 $lines = explode( "\n", $blacklist );
4084 foreach ( $lines as $line ) {
4086 if ( substr( $line, 0, 1 ) !== '*' ) {
4092 if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
4096 $exceptions = array();
4097 $imageDBkey = false;
4098 foreach ( $m[1] as $i => $titleText ) {
4099 $title = Title
::newFromText( $titleText );
4100 if ( !is_null( $title ) ) {
4102 $imageDBkey = $title->getDBkey();
4104 $exceptions[$title->getPrefixedDBkey()] = true;
4109 if ( $imageDBkey !== false ) {
4110 $badImages[$imageDBkey] = $exceptions;
4114 $badImageCache = $badImages;
4118 $contextKey = $contextTitle ?
$contextTitle->getPrefixedDBkey() : false;
4119 $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
4120 wfProfileOut( __METHOD__
);
4125 * Determine whether the client at a given source IP is likely to be able to
4126 * access the wiki via HTTPS.
4128 * @param string $ip The IPv4/6 address in the normal human-readable form
4131 function wfCanIPUseHTTPS( $ip ) {
4133 wfRunHooks( 'CanIPUseHTTPS', array( $ip, &$canDo ) );
4138 * Work out the IP address based on various globals
4139 * For trusted proxies, use the XFF client IP (first of the chain)
4141 * @deprecated since 1.19; call $wgRequest->getIP() directly.
4144 function wfGetIP() {
4145 wfDeprecated( __METHOD__
, '1.19' );
4147 return $wgRequest->getIP();
4151 * Checks if an IP is a trusted proxy provider.
4152 * Useful to tell if X-Forwarded-For data is possibly bogus.
4153 * Squid cache servers for the site are whitelisted.
4154 * @deprecated Since 1.24, use IP::isTrustedProxy()
4159 function wfIsTrustedProxy( $ip ) {
4160 return IP
::isTrustedProxy( $ip );
4164 * Checks if an IP matches a proxy we've configured.
4165 * @deprecated Since 1.24, use IP::isConfiguredProxy()
4169 * @since 1.23 Supports CIDR ranges in $wgSquidServersNoPurge
4171 function wfIsConfiguredProxy( $ip ) {
4172 return IP
::isConfiguredProxy( $ip );