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 $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 // Prepend elapsed request time and real memory usage to each line
978 $text = preg_replace( '/[^\n]/', $timer . '\0', $text, 1 );
981 if ( $dest === 'all' ) {
982 MWDebug
::debugMsg( $text );
986 if ( $wgDebugLogPrefix !== '' ) {
987 $ctx['prefix'] = $wgDebugLogPrefix;
990 $logger = MWLogger
::getInstance( 'wfDebug' );
991 $logger->debug( rtrim( $text, "\n" ), $ctx );
995 * Returns true if debug logging should be suppressed if $wgDebugRawPage = false
998 function wfIsDebugRawPage() {
1000 if ( $cache !== null ) {
1003 # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
1004 if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
1006 isset( $_SERVER['SCRIPT_NAME'] )
1007 && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
1018 * Get microsecond timestamps for debug logs
1022 function wfDebugTimer() {
1023 global $wgDebugTimestamps, $wgRequestTime;
1025 if ( !$wgDebugTimestamps ) {
1029 $prefix = sprintf( "%6.4f", microtime( true ) - $wgRequestTime );
1030 $mem = sprintf( "%5.1fM", ( memory_get_usage( true ) / ( 1024 * 1024 ) ) );
1031 return "$prefix $mem ";
1035 * Send a line giving PHP memory usage.
1037 * @param bool $exact Print exact byte values instead of kibibytes (default: false)
1039 function wfDebugMem( $exact = false ) {
1040 $mem = memory_get_usage();
1042 $mem = floor( $mem / 1024 ) . ' KiB';
1046 wfDebug( "Memory usage: $mem\n" );
1050 * Send a line to a supplementary debug log file, if configured, or main debug log if not.
1051 * To configure a supplementary log file, set $wgDebugLogGroups[$logGroup] to a string
1052 * filename or an associative array mapping 'destination' to the desired filename. The
1053 * associative array may also contain a 'sample' key with an integer value, specifying
1054 * a sampling factor.
1056 * @since 1.23 support for sampling log messages via $wgDebugLogGroups.
1058 * @param string $logGroup
1059 * @param string $text
1060 * @param string|bool $dest Destination of the message:
1061 * - 'all': both to the log and HTML (debug toolbar or HTML comments)
1062 * - 'log': only to the log and not in HTML
1063 * - 'private': only to the specifc log if set in $wgDebugLogGroups and
1064 * discarded otherwise
1065 * For backward compatibility, it can also take a boolean:
1066 * - true: same as 'all'
1067 * - false: same as 'private'
1069 function wfDebugLog( $logGroup, $text, $dest = 'all' ) {
1070 global $wgDebugLogGroups;
1072 // Turn $dest into a string if it's a boolean (for b/c)
1073 if ( $dest === true ) {
1075 } elseif ( $dest === false ) {
1079 $text = trim( $text );
1081 if ( $dest === 'all' ) {
1082 MWDebug
::debugMsg( "[{$logGroup}] {$text}\n" );
1085 $logger = MWLogger
::getInstance( $logGroup );
1086 $logger->debug( $text, array(
1087 'private' => ( $dest === 'private' ),
1092 * Log for database errors
1094 * @param string $text Database error message.
1096 function wfLogDBError( $text ) {
1097 $logger = MWLogger
::getInstance( 'wfLogDBError' );
1098 $logger->error( trim( $text ) );
1102 * Throws a warning that $function is deprecated
1104 * @param string $function
1105 * @param string|bool $version Version of MediaWiki that the function
1106 * was deprecated in (Added in 1.19).
1107 * @param string|bool $component Added in 1.19.
1108 * @param int $callerOffset How far up the call stack is the original
1109 * caller. 2 = function that called the function that called
1110 * wfDeprecated (Added in 1.20)
1114 function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) {
1115 MWDebug
::deprecated( $function, $version, $component, $callerOffset +
1 );
1119 * Send a warning either to the debug log or in a PHP error depending on
1120 * $wgDevelopmentWarnings. To log warnings in production, use wfLogWarning() instead.
1122 * @param string $msg Message to send
1123 * @param int $callerOffset Number of items to go back in the backtrace to
1124 * find the correct caller (1 = function calling wfWarn, ...)
1125 * @param int $level PHP error level; defaults to E_USER_NOTICE;
1126 * only used when $wgDevelopmentWarnings is true
1128 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE
) {
1129 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'auto' );
1133 * Send a warning as a PHP error and the debug log. This is intended for logging
1134 * warnings in production. For logging development warnings, use WfWarn instead.
1136 * @param string $msg Message to send
1137 * @param int $callerOffset Number of items to go back in the backtrace to
1138 * find the correct caller (1 = function calling wfLogWarning, ...)
1139 * @param int $level PHP error level; defaults to E_USER_WARNING
1141 function wfLogWarning( $msg, $callerOffset = 1, $level = E_USER_WARNING
) {
1142 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'production' );
1146 * Log to a file without getting "file size exceeded" signals.
1148 * Can also log to TCP or UDP with the syntax udp://host:port/prefix. This will
1149 * send lines to the specified port, prefixed by the specified prefix and a space.
1151 * @param string $text
1152 * @param string $file Filename
1153 * @throws MWException
1155 function wfErrorLog( $text, $file ) {
1156 $logger = MWLogger
::getInstance( 'wfErrorLog' );
1157 $logger->info( trim( $text ), array(
1158 'destination' => $file,
1165 function wfLogProfilingData() {
1166 global $wgRequestTime, $wgDebugLogFile, $wgDebugLogGroups, $wgDebugRawPage;
1167 global $wgProfileLimit, $wgUser, $wgRequest;
1169 StatCounter
::singleton()->flush();
1171 $profiler = Profiler
::instance();
1173 # Profiling must actually be enabled...
1174 if ( $profiler->isStub() ) {
1178 // Get total page request time and only show pages that longer than
1179 // $wgProfileLimit time (default is 0)
1180 $elapsed = microtime( true ) - $wgRequestTime;
1181 if ( $elapsed <= $wgProfileLimit ) {
1185 $profiler->logData();
1187 if ( isset( $wgDebugLogGroups['profileoutput'] )
1188 && $wgDebugLogGroups['profileoutput'] === false
1190 // Explicitly disabled
1193 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1197 $ctx = array( 'elapsed' => $elapsed );
1198 if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1199 $ctx['forwarded_for'] = $_SERVER['HTTP_X_FORWARDED_FOR'];
1201 if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1202 $ctx['client_ip'] = $_SERVER['HTTP_CLIENT_IP'];
1204 if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1205 $ctx['from'] = $_SERVER['HTTP_FROM'];
1207 if ( isset( $ctx['forwarded_for'] ) ||
1208 isset( $ctx['client_ip'] ) ||
1209 isset( $ctx['from'] ) ) {
1210 $ctx['proxy'] = $_SERVER['REMOTE_ADDR'];
1213 // Don't load $wgUser at this late stage just for statistics purposes
1214 // @todo FIXME: We can detect some anons even if it is not loaded.
1215 // See User::getId()
1216 if ( $wgUser->isItemLoaded( 'id' ) && $wgUser->isAnon() ) {
1217 $ctx['anon'] = true;
1219 $ctx['anon'] = false;
1222 // Command line script uses a FauxRequest object which does not have
1223 // any knowledge about an URL and throw an exception instead.
1225 $ctx['url'] = urldecode( $wgRequest->getRequestURL() );
1226 } catch ( MWException
$ignored ) {
1230 $ctx['output'] = $profiler->getOutput();
1231 $ctx['profile'] = $profiler->getRawData();
1233 $log = MWLogger
::getInstance( 'profileoutput' );
1234 $log->info( 'Elapsed: {elapsed}', $ctx );
1238 * Increment a statistics counter
1240 * @param string $key
1244 function wfIncrStats( $key, $count = 1 ) {
1245 StatCounter
::singleton()->incr( $key, $count );
1249 * Check whether the wiki is in read-only mode.
1253 function wfReadOnly() {
1254 return wfReadOnlyReason() !== false;
1258 * Get the value of $wgReadOnly or the contents of $wgReadOnlyFile.
1260 * @return string|bool String when in read-only mode; false otherwise
1262 function wfReadOnlyReason() {
1263 global $wgReadOnly, $wgReadOnlyFile;
1265 if ( $wgReadOnly === null ) {
1266 // Set $wgReadOnly for faster access next time
1267 if ( is_file( $wgReadOnlyFile ) && filesize( $wgReadOnlyFile ) > 0 ) {
1268 $wgReadOnly = file_get_contents( $wgReadOnlyFile );
1270 $wgReadOnly = false;
1278 * Return a Language object from $langcode
1280 * @param Language|string|bool $langcode Either:
1281 * - a Language object
1282 * - code of the language to get the message for, if it is
1283 * a valid code create a language for that language, if
1284 * it is a string but not a valid code then make a basic
1286 * - a boolean: if it's false then use the global object for
1287 * the current user's language (as a fallback for the old parameter
1288 * functionality), or if it is true then use global object
1289 * for the wiki's content language.
1292 function wfGetLangObj( $langcode = false ) {
1293 # Identify which language to get or create a language object for.
1294 # Using is_object here due to Stub objects.
1295 if ( is_object( $langcode ) ) {
1296 # Great, we already have the object (hopefully)!
1300 global $wgContLang, $wgLanguageCode;
1301 if ( $langcode === true ||
$langcode === $wgLanguageCode ) {
1302 # $langcode is the language code of the wikis content language object.
1303 # or it is a boolean and value is true
1308 if ( $langcode === false ||
$langcode === $wgLang->getCode() ) {
1309 # $langcode is the language code of user language object.
1310 # or it was a boolean and value is false
1314 $validCodes = array_keys( Language
::fetchLanguageNames() );
1315 if ( in_array( $langcode, $validCodes ) ) {
1316 # $langcode corresponds to a valid language.
1317 return Language
::factory( $langcode );
1320 # $langcode is a string, but not a valid language code; use content language.
1321 wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1326 * This is the function for getting translated interface messages.
1328 * @see Message class for documentation how to use them.
1329 * @see https://www.mediawiki.org/wiki/Manual:Messages_API
1331 * This function replaces all old wfMsg* functions.
1333 * @param string|string[] $key Message key, or array of keys
1334 * @param mixed $params,... Normal message parameters
1339 * @see Message::__construct
1341 function wfMessage( $key /*...*/ ) {
1342 $params = func_get_args();
1343 array_shift( $params );
1344 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
1345 $params = $params[0];
1347 return new Message( $key, $params );
1351 * This function accepts multiple message keys and returns a message instance
1352 * for the first message which is non-empty. If all messages are empty then an
1353 * instance of the first message key is returned.
1355 * @param string|string[] $keys,... Message keys
1360 * @see Message::newFallbackSequence
1362 function wfMessageFallback( /*...*/ ) {
1363 $args = func_get_args();
1364 return call_user_func_array( 'Message::newFallbackSequence', $args );
1368 * Get a message from anywhere, for the current user language.
1370 * Use wfMsgForContent() instead if the message should NOT
1371 * change depending on the user preferences.
1373 * @deprecated since 1.18
1375 * @param string $key Lookup key for the message, usually
1376 * defined in languages/Language.php
1378 * Parameters to the message, which can be used to insert variable text into
1379 * it, can be passed to this function in the following formats:
1380 * - One per argument, starting at the second parameter
1381 * - As an array in the second parameter
1382 * These are not shown in the function definition.
1386 function wfMsg( $key ) {
1387 wfDeprecated( __METHOD__
, '1.21' );
1389 $args = func_get_args();
1390 array_shift( $args );
1391 return wfMsgReal( $key, $args );
1395 * Same as above except doesn't transform the message
1397 * @deprecated since 1.18
1399 * @param string $key
1402 function wfMsgNoTrans( $key ) {
1403 wfDeprecated( __METHOD__
, '1.21' );
1405 $args = func_get_args();
1406 array_shift( $args );
1407 return wfMsgReal( $key, $args, true, false, false );
1411 * Get a message from anywhere, for the current global language
1412 * set with $wgLanguageCode.
1414 * Use this if the message should NOT change dependent on the
1415 * language set in the user's preferences. This is the case for
1416 * most text written into logs, as well as link targets (such as
1417 * the name of the copyright policy page). Link titles, on the
1418 * other hand, should be shown in the UI language.
1420 * Note that MediaWiki allows users to change the user interface
1421 * language in their preferences, but a single installation
1422 * typically only contains content in one language.
1424 * Be wary of this distinction: If you use wfMsg() where you should
1425 * use wfMsgForContent(), a user of the software may have to
1426 * customize potentially hundreds of messages in
1427 * order to, e.g., fix a link in every possible language.
1429 * @deprecated since 1.18
1431 * @param string $key Lookup key for the message, usually
1432 * defined in languages/Language.php
1435 function wfMsgForContent( $key ) {
1436 wfDeprecated( __METHOD__
, '1.21' );
1438 global $wgForceUIMsgAsContentMsg;
1439 $args = func_get_args();
1440 array_shift( $args );
1442 if ( is_array( $wgForceUIMsgAsContentMsg )
1443 && in_array( $key, $wgForceUIMsgAsContentMsg )
1445 $forcontent = false;
1447 return wfMsgReal( $key, $args, true, $forcontent );
1451 * Same as above except doesn't transform the message
1453 * @deprecated since 1.18
1455 * @param string $key
1458 function wfMsgForContentNoTrans( $key ) {
1459 wfDeprecated( __METHOD__
, '1.21' );
1461 global $wgForceUIMsgAsContentMsg;
1462 $args = func_get_args();
1463 array_shift( $args );
1465 if ( is_array( $wgForceUIMsgAsContentMsg )
1466 && in_array( $key, $wgForceUIMsgAsContentMsg )
1468 $forcontent = false;
1470 return wfMsgReal( $key, $args, true, $forcontent, false );
1474 * Really get a message
1476 * @deprecated since 1.18
1478 * @param string $key Key to get.
1479 * @param array $args
1480 * @param bool $useDB
1481 * @param string|bool $forContent Language code, or false for user lang, true for content lang.
1482 * @param bool $transform Whether or not to transform the message.
1483 * @return string The requested message.
1485 function wfMsgReal( $key, $args, $useDB = true, $forContent = false, $transform = true ) {
1486 wfDeprecated( __METHOD__
, '1.21' );
1488 wfProfileIn( __METHOD__
);
1489 $message = wfMsgGetKey( $key, $useDB, $forContent, $transform );
1490 $message = wfMsgReplaceArgs( $message, $args );
1491 wfProfileOut( __METHOD__
);
1496 * Fetch a message string value, but don't replace any keys yet.
1498 * @deprecated since 1.18
1500 * @param string $key
1501 * @param bool $useDB
1502 * @param string|bool $langCode Code of the language to get the message for, or
1503 * behaves as a content language switch if it is a boolean.
1504 * @param bool $transform Whether to parse magic words, etc.
1507 function wfMsgGetKey( $key, $useDB = true, $langCode = false, $transform = true ) {
1508 wfDeprecated( __METHOD__
, '1.21' );
1510 wfRunHooks( 'NormalizeMessageKey', array( &$key, &$useDB, &$langCode, &$transform ) );
1512 $cache = MessageCache
::singleton();
1513 $message = $cache->get( $key, $useDB, $langCode );
1514 if ( $message === false ) {
1515 $message = '<' . htmlspecialchars( $key ) . '>';
1516 } elseif ( $transform ) {
1517 $message = $cache->transform( $message );
1523 * Replace message parameter keys on the given formatted output.
1525 * @param string $message
1526 * @param array $args
1530 function wfMsgReplaceArgs( $message, $args ) {
1531 # Fix windows line-endings
1532 # Some messages are split with explode("\n", $msg)
1533 $message = str_replace( "\r", '', $message );
1535 // Replace arguments
1536 if ( count( $args ) ) {
1537 if ( is_array( $args[0] ) ) {
1538 $args = array_values( $args[0] );
1540 $replacementKeys = array();
1541 foreach ( $args as $n => $param ) {
1542 $replacementKeys['$' . ( $n +
1 )] = $param;
1544 $message = strtr( $message, $replacementKeys );
1551 * Return an HTML-escaped version of a message.
1552 * Parameter replacements, if any, are done *after* the HTML-escaping,
1553 * so parameters may contain HTML (eg links or form controls). Be sure
1554 * to pre-escape them if you really do want plaintext, or just wrap
1555 * the whole thing in htmlspecialchars().
1557 * @deprecated since 1.18
1559 * @param string $key
1560 * @param string $args,... Parameters
1563 function wfMsgHtml( $key ) {
1564 wfDeprecated( __METHOD__
, '1.21' );
1566 $args = func_get_args();
1567 array_shift( $args );
1568 return wfMsgReplaceArgs( htmlspecialchars( wfMsgGetKey( $key ) ), $args );
1572 * Return an HTML version of message
1573 * Parameter replacements, if any, are done *after* parsing the wiki-text message,
1574 * so parameters may contain HTML (eg links or form controls). Be sure
1575 * to pre-escape them if you really do want plaintext, or just wrap
1576 * the whole thing in htmlspecialchars().
1578 * @deprecated since 1.18
1580 * @param string $key
1581 * @param string $args,... Parameters
1584 function wfMsgWikiHtml( $key ) {
1585 wfDeprecated( __METHOD__
, '1.21' );
1587 $args = func_get_args();
1588 array_shift( $args );
1589 return wfMsgReplaceArgs(
1590 MessageCache
::singleton()->parse( wfMsgGetKey( $key ), null,
1591 /* can't be set to false */ true, /* interface */ true )->getText(),
1596 * Returns message in the requested format
1598 * @deprecated since 1.18
1600 * @param string $key Key of the message
1601 * @param array $options Processing rules.
1602 * Can take the following options:
1603 * parse: parses wikitext to HTML
1604 * parseinline: parses wikitext to HTML and removes the surrounding
1605 * p's added by parser or tidy
1606 * escape: filters message through htmlspecialchars
1607 * escapenoentities: same, but allows entity references like   through
1608 * replaceafter: parameters are substituted after parsing or escaping
1609 * parsemag: transform the message using magic phrases
1610 * content: fetch message for content language instead of interface
1611 * Also can accept a single associative argument, of the form 'language' => 'xx':
1612 * language: Language object or language code to fetch message for
1613 * (overridden by content).
1614 * Behavior for conflicting options (e.g., parse+parseinline) is undefined.
1618 function wfMsgExt( $key, $options ) {
1619 wfDeprecated( __METHOD__
, '1.21' );
1621 $args = func_get_args();
1622 array_shift( $args );
1623 array_shift( $args );
1624 $options = (array)$options;
1626 foreach ( $options as $arrayKey => $option ) {
1627 if ( !preg_match( '/^[0-9]+|language$/', $arrayKey ) ) {
1628 # An unknown index, neither numeric nor "language"
1629 wfWarn( "wfMsgExt called with incorrect parameter key $arrayKey", 1, E_USER_WARNING
);
1630 } elseif ( preg_match( '/^[0-9]+$/', $arrayKey ) && !in_array( $option,
1631 array( 'parse', 'parseinline', 'escape', 'escapenoentities',
1632 'replaceafter', 'parsemag', 'content' ) ) ) {
1633 # A numeric index with unknown value
1634 wfWarn( "wfMsgExt called with incorrect parameter $option", 1, E_USER_WARNING
);
1638 if ( in_array( 'content', $options, true ) ) {
1641 $langCodeObj = null;
1642 } elseif ( array_key_exists( 'language', $options ) ) {
1643 $forContent = false;
1644 $langCode = wfGetLangObj( $options['language'] );
1645 $langCodeObj = $langCode;
1647 $forContent = false;
1649 $langCodeObj = null;
1652 $string = wfMsgGetKey( $key, /*DB*/true, $langCode, /*Transform*/false );
1654 if ( !in_array( 'replaceafter', $options, true ) ) {
1655 $string = wfMsgReplaceArgs( $string, $args );
1658 $messageCache = MessageCache
::singleton();
1659 $parseInline = in_array( 'parseinline', $options, true );
1660 if ( in_array( 'parse', $options, true ) ||
$parseInline ) {
1661 $string = $messageCache->parse( $string, null, true, !$forContent, $langCodeObj );
1662 if ( $string instanceof ParserOutput
) {
1663 $string = $string->getText();
1666 if ( $parseInline ) {
1667 $string = Parser
::stripOuterParagraph( $string );
1669 } elseif ( in_array( 'parsemag', $options, true ) ) {
1670 $string = $messageCache->transform( $string,
1671 !$forContent, $langCodeObj );
1674 if ( in_array( 'escape', $options, true ) ) {
1675 $string = htmlspecialchars ( $string );
1676 } elseif ( in_array( 'escapenoentities', $options, true ) ) {
1677 $string = Sanitizer
::escapeHtmlAllowEntities( $string );
1680 if ( in_array( 'replaceafter', $options, true ) ) {
1681 $string = wfMsgReplaceArgs( $string, $args );
1688 * Since wfMsg() and co suck, they don't return false if the message key they
1689 * looked up didn't exist but instead the key wrapped in <>'s, this function checks for the
1690 * nonexistence of messages by checking the MessageCache::get() result directly.
1692 * @deprecated since 1.18. Use Message::isDisabled().
1694 * @param string $key The message key looked up
1695 * @return bool True if the message *doesn't* exist.
1697 function wfEmptyMsg( $key ) {
1698 wfDeprecated( __METHOD__
, '1.21' );
1700 return MessageCache
::singleton()->get( $key, /*useDB*/true, /*content*/false ) === false;
1704 * Fetch server name for use in error reporting etc.
1705 * Use real server name if available, so we know which machine
1706 * in a server farm generated the current page.
1710 function wfHostname() {
1712 if ( is_null( $host ) ) {
1714 # Hostname overriding
1715 global $wgOverrideHostname;
1716 if ( $wgOverrideHostname !== false ) {
1717 # Set static and skip any detection
1718 $host = $wgOverrideHostname;
1722 if ( function_exists( 'posix_uname' ) ) {
1723 // This function not present on Windows
1724 $uname = posix_uname();
1728 if ( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1729 $host = $uname['nodename'];
1730 } elseif ( getenv( 'COMPUTERNAME' ) ) {
1731 # Windows computer name
1732 $host = getenv( 'COMPUTERNAME' );
1734 # This may be a virtual server.
1735 $host = $_SERVER['SERVER_NAME'];
1742 * Returns a script tag that stores the amount of time it took MediaWiki to
1743 * handle the request in milliseconds as 'wgBackendResponseTime'.
1745 * If $wgShowHostnames is true, the script will also set 'wgHostname' to the
1746 * hostname of the server handling the request.
1750 function wfReportTime() {
1751 global $wgRequestTime, $wgShowHostnames;
1753 $responseTime = round( ( microtime( true ) - $wgRequestTime ) * 1000 );
1754 $reportVars = array( 'wgBackendResponseTime' => $responseTime );
1755 if ( $wgShowHostnames ) {
1756 $reportVars['wgHostname'] = wfHostname();
1758 return Skin
::makeVariablesScript( $reportVars );
1762 * Safety wrapper for debug_backtrace().
1764 * Will return an empty array if debug_backtrace is disabled, otherwise
1765 * the output from debug_backtrace() (trimmed).
1767 * @param int $limit This parameter can be used to limit the number of stack frames returned
1769 * @return array Array of backtrace information
1771 function wfDebugBacktrace( $limit = 0 ) {
1772 static $disabled = null;
1774 if ( is_null( $disabled ) ) {
1775 $disabled = !function_exists( 'debug_backtrace' );
1777 wfDebug( "debug_backtrace() is disabled\n" );
1784 if ( $limit && version_compare( PHP_VERSION
, '5.4.0', '>=' ) ) {
1785 return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT
, $limit +
1 ), 1 );
1787 return array_slice( debug_backtrace(), 1 );
1792 * Get a debug backtrace as a string
1796 function wfBacktrace() {
1797 global $wgCommandLineMode;
1799 if ( $wgCommandLineMode ) {
1804 $backtrace = wfDebugBacktrace();
1805 foreach ( $backtrace as $call ) {
1806 if ( isset( $call['file'] ) ) {
1807 $f = explode( DIRECTORY_SEPARATOR
, $call['file'] );
1808 $file = $f[count( $f ) - 1];
1812 if ( isset( $call['line'] ) ) {
1813 $line = $call['line'];
1817 if ( $wgCommandLineMode ) {
1818 $msg .= "$file line $line calls ";
1820 $msg .= '<li>' . $file . ' line ' . $line . ' calls ';
1822 if ( !empty( $call['class'] ) ) {
1823 $msg .= $call['class'] . $call['type'];
1825 $msg .= $call['function'] . '()';
1827 if ( $wgCommandLineMode ) {
1833 if ( $wgCommandLineMode ) {
1843 * Get the name of the function which called this function
1844 * wfGetCaller( 1 ) is the function with the wfGetCaller() call (ie. __FUNCTION__)
1845 * wfGetCaller( 2 ) [default] is the caller of the function running wfGetCaller()
1846 * wfGetCaller( 3 ) is the parent of that.
1851 function wfGetCaller( $level = 2 ) {
1852 $backtrace = wfDebugBacktrace( $level +
1 );
1853 if ( isset( $backtrace[$level] ) ) {
1854 return wfFormatStackFrame( $backtrace[$level] );
1861 * Return a string consisting of callers in the stack. Useful sometimes
1862 * for profiling specific points.
1864 * @param int $limit The maximum depth of the stack frame to return, or false for the entire stack.
1867 function wfGetAllCallers( $limit = 3 ) {
1868 $trace = array_reverse( wfDebugBacktrace() );
1869 if ( !$limit ||
$limit > count( $trace ) - 1 ) {
1870 $limit = count( $trace ) - 1;
1872 $trace = array_slice( $trace, -$limit - 1, $limit );
1873 return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1877 * Return a string representation of frame
1879 * @param array $frame
1882 function wfFormatStackFrame( $frame ) {
1883 return isset( $frame['class'] ) ?
1884 $frame['class'] . '::' . $frame['function'] :
1888 /* Some generic result counters, pulled out of SearchEngine */
1893 * @param int $offset
1897 function wfShowingResults( $offset, $limit ) {
1898 return wfMessage( 'showingresults' )->numParams( $limit, $offset +
1 )->parse();
1903 * @todo FIXME: We may want to blacklist some broken browsers
1905 * @param bool $force
1906 * @return bool Whereas client accept gzip compression
1908 function wfClientAcceptsGzip( $force = false ) {
1909 static $result = null;
1910 if ( $result === null ||
$force ) {
1912 if ( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
1913 # @todo FIXME: We may want to blacklist some broken browsers
1916 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
1917 $_SERVER['HTTP_ACCEPT_ENCODING'],
1921 if ( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
1925 wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
1934 * Obtain the offset and limit values from the request string;
1935 * used in special pages
1937 * @param int $deflimit Default limit if none supplied
1938 * @param string $optionname Name of a user preference to check against
1940 * @deprecated since 1.24, just call WebRequest::getLimitOffset() directly
1942 function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
1944 wfDeprecated( __METHOD__
, '1.24' );
1945 return $wgRequest->getLimitOffset( $deflimit, $optionname );
1949 * Escapes the given text so that it may be output using addWikiText()
1950 * without any linking, formatting, etc. making its way through. This
1951 * is achieved by substituting certain characters with HTML entities.
1952 * As required by the callers, "<nowiki>" is not used.
1954 * @param string $text Text to be escaped
1957 function wfEscapeWikiText( $text ) {
1958 static $repl = null, $repl2 = null;
1959 if ( $repl === null ) {
1961 '"' => '"', '&' => '&', "'" => ''', '<' => '<',
1962 '=' => '=', '>' => '>', '[' => '[', ']' => ']',
1963 '{' => '{', '|' => '|', '}' => '}', ';' => ';',
1964 "\n#" => "\n#", "\r#" => "\r#",
1965 "\n*" => "\n*", "\r*" => "\r*",
1966 "\n:" => "\n:", "\r:" => "\r:",
1967 "\n " => "\n ", "\r " => "\r ",
1968 "\n\n" => "\n ", "\r\n" => " \n",
1969 "\n\r" => "\n ", "\r\r" => "\r ",
1970 "\n\t" => "\n	", "\r\t" => "\r	", // "\n\t\n" is treated like "\n\n"
1971 "\n----" => "\n----", "\r----" => "\r----",
1972 '__' => '__', '://' => '://',
1975 // We have to catch everything "\s" matches in PCRE
1976 foreach ( array( 'ISBN', 'RFC', 'PMID' ) as $magic ) {
1977 $repl["$magic "] = "$magic ";
1978 $repl["$magic\t"] = "$magic	";
1979 $repl["$magic\r"] = "$magic ";
1980 $repl["$magic\n"] = "$magic ";
1981 $repl["$magic\f"] = "$magic";
1984 // And handle protocols that don't use "://"
1985 global $wgUrlProtocols;
1987 foreach ( $wgUrlProtocols as $prot ) {
1988 if ( substr( $prot, -1 ) === ':' ) {
1989 $repl2[] = preg_quote( substr( $prot, 0, -1 ), '/' );
1992 $repl2 = $repl2 ?
'/\b(' . join( '|', $repl2 ) . '):/i' : '/^(?!)/';
1994 $text = substr( strtr( "\n$text", $repl ), 1 );
1995 $text = preg_replace( $repl2, '$1:', $text );
2000 * Sets dest to source and returns the original value of dest
2001 * If source is NULL, it just returns the value, it doesn't set the variable
2002 * If force is true, it will set the value even if source is NULL
2004 * @param mixed $dest
2005 * @param mixed $source
2006 * @param bool $force
2009 function wfSetVar( &$dest, $source, $force = false ) {
2011 if ( !is_null( $source ) ||
$force ) {
2018 * As for wfSetVar except setting a bit
2022 * @param bool $state
2026 function wfSetBit( &$dest, $bit, $state = true ) {
2027 $temp = (bool)( $dest & $bit );
2028 if ( !is_null( $state ) ) {
2039 * A wrapper around the PHP function var_export().
2040 * Either print it or add it to the regular output ($wgOut).
2042 * @param mixed $var A PHP variable to dump.
2044 function wfVarDump( $var ) {
2046 $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
2047 if ( headers_sent() ||
!isset( $wgOut ) ||
!is_object( $wgOut ) ) {
2050 $wgOut->addHTML( $s );
2055 * Provide a simple HTTP error.
2057 * @param int|string $code
2058 * @param string $label
2059 * @param string $desc
2061 function wfHttpError( $code, $label, $desc ) {
2064 header( "HTTP/1.0 $code $label" );
2065 header( "Status: $code $label" );
2066 $wgOut->sendCacheControl();
2068 header( 'Content-type: text/html; charset=utf-8' );
2069 print "<!doctype html>" .
2070 '<html><head><title>' .
2071 htmlspecialchars( $label ) .
2072 '</title></head><body><h1>' .
2073 htmlspecialchars( $label ) .
2075 nl2br( htmlspecialchars( $desc ) ) .
2076 "</p></body></html>\n";
2080 * Clear away any user-level output buffers, discarding contents.
2082 * Suitable for 'starting afresh', for instance when streaming
2083 * relatively large amounts of data without buffering, or wanting to
2084 * output image files without ob_gzhandler's compression.
2086 * The optional $resetGzipEncoding parameter controls suppression of
2087 * the Content-Encoding header sent by ob_gzhandler; by default it
2088 * is left. See comments for wfClearOutputBuffers() for why it would
2091 * Note that some PHP configuration options may add output buffer
2092 * layers which cannot be removed; these are left in place.
2094 * @param bool $resetGzipEncoding
2096 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
2097 if ( $resetGzipEncoding ) {
2098 // Suppress Content-Encoding and Content-Length
2099 // headers from 1.10+s wfOutputHandler
2100 global $wgDisableOutputCompression;
2101 $wgDisableOutputCompression = true;
2103 while ( $status = ob_get_status() ) {
2104 if ( $status['type'] == 0 /* PHP_OUTPUT_HANDLER_INTERNAL */ ) {
2105 // Probably from zlib.output_compression or other
2106 // PHP-internal setting which can't be removed.
2108 // Give up, and hope the result doesn't break
2112 if ( !ob_end_clean() ) {
2113 // Could not remove output buffer handler; abort now
2114 // to avoid getting in some kind of infinite loop.
2117 if ( $resetGzipEncoding ) {
2118 if ( $status['name'] == 'ob_gzhandler' ) {
2119 // Reset the 'Content-Encoding' field set by this handler
2120 // so we can start fresh.
2121 header_remove( 'Content-Encoding' );
2129 * More legible than passing a 'false' parameter to wfResetOutputBuffers():
2131 * Clear away output buffers, but keep the Content-Encoding header
2132 * produced by ob_gzhandler, if any.
2134 * This should be used for HTTP 304 responses, where you need to
2135 * preserve the Content-Encoding header of the real result, but
2136 * also need to suppress the output of ob_gzhandler to keep to spec
2137 * and avoid breaking Firefox in rare cases where the headers and
2138 * body are broken over two packets.
2140 function wfClearOutputBuffers() {
2141 wfResetOutputBuffers( false );
2145 * Converts an Accept-* header into an array mapping string values to quality
2148 * @param string $accept
2149 * @param string $def Default
2150 * @return float[] Associative array of string => float pairs
2152 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
2153 # No arg means accept anything (per HTTP spec)
2155 return array( $def => 1.0 );
2160 $parts = explode( ',', $accept );
2162 foreach ( $parts as $part ) {
2163 # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
2164 $values = explode( ';', trim( $part ) );
2166 if ( count( $values ) == 1 ) {
2167 $prefs[$values[0]] = 1.0;
2168 } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
2169 $prefs[$values[0]] = floatval( $match[1] );
2177 * Checks if a given MIME type matches any of the keys in the given
2178 * array. Basic wildcards are accepted in the array keys.
2180 * Returns the matching MIME type (or wildcard) if a match, otherwise
2183 * @param string $type
2184 * @param array $avail
2188 function mimeTypeMatch( $type, $avail ) {
2189 if ( array_key_exists( $type, $avail ) ) {
2192 $parts = explode( '/', $type );
2193 if ( array_key_exists( $parts[0] . '/*', $avail ) ) {
2194 return $parts[0] . '/*';
2195 } elseif ( array_key_exists( '*/*', $avail ) ) {
2204 * Returns the 'best' match between a client's requested internet media types
2205 * and the server's list of available types. Each list should be an associative
2206 * array of type to preference (preference is a float between 0.0 and 1.0).
2207 * Wildcards in the types are acceptable.
2209 * @param array $cprefs Client's acceptable type list
2210 * @param array $sprefs Server's offered types
2213 * @todo FIXME: Doesn't handle params like 'text/plain; charset=UTF-8'
2214 * XXX: generalize to negotiate other stuff
2216 function wfNegotiateType( $cprefs, $sprefs ) {
2219 foreach ( array_keys( $sprefs ) as $type ) {
2220 $parts = explode( '/', $type );
2221 if ( $parts[1] != '*' ) {
2222 $ckey = mimeTypeMatch( $type, $cprefs );
2224 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
2229 foreach ( array_keys( $cprefs ) as $type ) {
2230 $parts = explode( '/', $type );
2231 if ( $parts[1] != '*' && !array_key_exists( $type, $sprefs ) ) {
2232 $skey = mimeTypeMatch( $type, $sprefs );
2234 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
2242 foreach ( array_keys( $combine ) as $type ) {
2243 if ( $combine[$type] > $bestq ) {
2245 $bestq = $combine[$type];
2253 * Reference-counted warning suppression
2257 function wfSuppressWarnings( $end = false ) {
2258 static $suppressCount = 0;
2259 static $originalLevel = false;
2262 if ( $suppressCount ) {
2264 if ( !$suppressCount ) {
2265 error_reporting( $originalLevel );
2269 if ( !$suppressCount ) {
2270 $originalLevel = error_reporting( E_ALL
& ~
(
2285 * Restore error level to previous value
2287 function wfRestoreWarnings() {
2288 wfSuppressWarnings( true );
2291 # Autodetect, convert and provide timestamps of various types
2294 * Unix time - the number of seconds since 1970-01-01 00:00:00 UTC
2296 define( 'TS_UNIX', 0 );
2299 * MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
2301 define( 'TS_MW', 1 );
2304 * MySQL DATETIME (YYYY-MM-DD HH:MM:SS)
2306 define( 'TS_DB', 2 );
2309 * RFC 2822 format, for E-mail and HTTP headers
2311 define( 'TS_RFC2822', 3 );
2314 * ISO 8601 format with no timezone: 1986-02-09T20:00:00Z
2316 * This is used by Special:Export
2318 define( 'TS_ISO_8601', 4 );
2321 * An Exif timestamp (YYYY:MM:DD HH:MM:SS)
2323 * @see http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the
2324 * DateTime tag and page 36 for the DateTimeOriginal and
2325 * DateTimeDigitized tags.
2327 define( 'TS_EXIF', 5 );
2330 * Oracle format time.
2332 define( 'TS_ORACLE', 6 );
2335 * Postgres format time.
2337 define( 'TS_POSTGRES', 7 );
2340 * ISO 8601 basic format with no timezone: 19860209T200000Z. This is used by ResourceLoader
2342 define( 'TS_ISO_8601_BASIC', 9 );
2345 * Get a timestamp string in one of various formats
2347 * @param mixed $outputtype A timestamp in one of the supported formats, the
2348 * function will autodetect which format is supplied and act accordingly.
2349 * @param mixed $ts Optional timestamp to convert, default 0 for the current time
2350 * @return string|bool String / false The same date in the format specified in $outputtype or false
2352 function wfTimestamp( $outputtype = TS_UNIX
, $ts = 0 ) {
2354 $timestamp = new MWTimestamp( $ts );
2355 return $timestamp->getTimestamp( $outputtype );
2356 } catch ( TimestampException
$e ) {
2357 wfDebug( "wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n" );
2363 * Return a formatted timestamp, or null if input is null.
2364 * For dealing with nullable timestamp columns in the database.
2366 * @param int $outputtype
2370 function wfTimestampOrNull( $outputtype = TS_UNIX
, $ts = null ) {
2371 if ( is_null( $ts ) ) {
2374 return wfTimestamp( $outputtype, $ts );
2379 * Convenience function; returns MediaWiki timestamp for the present time.
2383 function wfTimestampNow() {
2385 return wfTimestamp( TS_MW
, time() );
2389 * Check if the operating system is Windows
2391 * @return bool True if it's Windows, false otherwise.
2393 function wfIsWindows() {
2394 static $isWindows = null;
2395 if ( $isWindows === null ) {
2396 $isWindows = substr( php_uname(), 0, 7 ) == 'Windows';
2402 * Check if we are running under HHVM
2406 function wfIsHHVM() {
2407 return defined( 'HHVM_VERSION' );
2411 * Swap two variables
2413 * @deprecated since 1.24
2417 function swap( &$x, &$y ) {
2418 wfDeprecated( __FUNCTION__
, '1.24' );
2425 * Tries to get the system directory for temporary files. First
2426 * $wgTmpDirectory is checked, and then the TMPDIR, TMP, and TEMP
2427 * environment variables are then checked in sequence, and if none are
2428 * set try sys_get_temp_dir().
2430 * NOTE: When possible, use instead the tmpfile() function to create
2431 * temporary files to avoid race conditions on file creation, etc.
2435 function wfTempDir() {
2436 global $wgTmpDirectory;
2438 if ( $wgTmpDirectory !== false ) {
2439 return $wgTmpDirectory;
2442 $tmpDir = array_map( "getenv", array( 'TMPDIR', 'TMP', 'TEMP' ) );
2444 foreach ( $tmpDir as $tmp ) {
2445 if ( $tmp && file_exists( $tmp ) && is_dir( $tmp ) && is_writable( $tmp ) ) {
2449 return sys_get_temp_dir();
2453 * Make directory, and make all parent directories if they don't exist
2455 * @param string $dir Full path to directory to create
2456 * @param int $mode Chmod value to use, default is $wgDirectoryMode
2457 * @param string $caller Optional caller param for debugging.
2458 * @throws MWException
2461 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2462 global $wgDirectoryMode;
2464 if ( FileBackend
::isStoragePath( $dir ) ) { // sanity
2465 throw new MWException( __FUNCTION__
. " given storage path '$dir'." );
2468 if ( !is_null( $caller ) ) {
2469 wfDebug( "$caller: called wfMkdirParents($dir)\n" );
2472 if ( strval( $dir ) === '' ||
( file_exists( $dir ) && is_dir( $dir ) ) ) {
2476 $dir = str_replace( array( '\\', '/' ), DIRECTORY_SEPARATOR
, $dir );
2478 if ( is_null( $mode ) ) {
2479 $mode = $wgDirectoryMode;
2482 // Turn off the normal warning, we're doing our own below
2483 wfSuppressWarnings();
2484 $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2485 wfRestoreWarnings();
2488 //directory may have been created on another request since we last checked
2489 if ( is_dir( $dir ) ) {
2493 // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2494 wfLogWarning( sprintf( "failed to mkdir \"%s\" mode 0%o", $dir, $mode ) );
2500 * Remove a directory and all its content.
2501 * Does not hide error.
2502 * @param string $dir
2504 function wfRecursiveRemoveDir( $dir ) {
2505 wfDebug( __FUNCTION__
. "( $dir )\n" );
2506 // taken from http://de3.php.net/manual/en/function.rmdir.php#98622
2507 if ( is_dir( $dir ) ) {
2508 $objects = scandir( $dir );
2509 foreach ( $objects as $object ) {
2510 if ( $object != "." && $object != ".." ) {
2511 if ( filetype( $dir . '/' . $object ) == "dir" ) {
2512 wfRecursiveRemoveDir( $dir . '/' . $object );
2514 unlink( $dir . '/' . $object );
2524 * @param int $nr The number to format
2525 * @param int $acc The number of digits after the decimal point, default 2
2526 * @param bool $round Whether or not to round the value, default true
2529 function wfPercent( $nr, $acc = 2, $round = true ) {
2530 $ret = sprintf( "%.${acc}f", $nr );
2531 return $round ?
round( $ret, $acc ) . '%' : "$ret%";
2535 * Safety wrapper around ini_get() for boolean settings.
2536 * The values returned from ini_get() are pre-normalized for settings
2537 * set via php.ini or php_flag/php_admin_flag... but *not*
2538 * for those set via php_value/php_admin_value.
2540 * It's fairly common for people to use php_value instead of php_flag,
2541 * which can leave you with an 'off' setting giving a false positive
2542 * for code that just takes the ini_get() return value as a boolean.
2544 * To make things extra interesting, setting via php_value accepts
2545 * "true" and "yes" as true, but php.ini and php_flag consider them false. :)
2546 * Unrecognized values go false... again opposite PHP's own coercion
2547 * from string to bool.
2549 * Luckily, 'properly' set settings will always come back as '0' or '1',
2550 * so we only have to worry about them and the 'improper' settings.
2552 * I frickin' hate PHP... :P
2554 * @param string $setting
2557 function wfIniGetBool( $setting ) {
2558 $val = strtolower( ini_get( $setting ) );
2559 // 'on' and 'true' can't have whitespace around them, but '1' can.
2563 ||
preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2567 * Windows-compatible version of escapeshellarg()
2568 * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
2569 * function puts single quotes in regardless of OS.
2571 * Also fixes the locale problems on Linux in PHP 5.2.6+ (bug backported to
2572 * earlier distro releases of PHP)
2574 * @param string $args,...
2577 function wfEscapeShellArg( /*...*/ ) {
2578 wfInitShellLocale();
2580 $args = func_get_args();
2583 foreach ( $args as $arg ) {
2590 if ( wfIsWindows() ) {
2591 // Escaping for an MSVC-style command line parser and CMD.EXE
2592 // @codingStandardsIgnoreStart For long URLs
2594 // * http://web.archive.org/web/20020708081031/http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
2595 // * http://technet.microsoft.com/en-us/library/cc723564.aspx
2598 // Double the backslashes before any double quotes. Escape the double quotes.
2599 // @codingStandardsIgnoreEnd
2600 $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE
);
2603 foreach ( $tokens as $token ) {
2604 if ( $iteration %
2 == 1 ) {
2605 // Delimiter, a double quote preceded by zero or more slashes
2606 $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
2607 } elseif ( $iteration %
4 == 2 ) {
2608 // ^ in $token will be outside quotes, need to be escaped
2609 $arg .= str_replace( '^', '^^', $token );
2610 } else { // $iteration % 4 == 0
2611 // ^ in $token will appear inside double quotes, so leave as is
2616 // Double the backslashes before the end of the string, because
2617 // we will soon add a quote
2619 if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
2620 $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
2623 // Add surrounding quotes
2624 $retVal .= '"' . $arg . '"';
2626 $retVal .= escapeshellarg( $arg );
2633 * Check if wfShellExec() is effectively disabled via php.ini config
2635 * @return bool|string False or one of (safemode,disabled)
2638 function wfShellExecDisabled() {
2639 static $disabled = null;
2640 if ( is_null( $disabled ) ) {
2641 if ( wfIniGetBool( 'safe_mode' ) ) {
2642 wfDebug( "wfShellExec can't run in safe_mode, PHP's exec functions are too broken.\n" );
2643 $disabled = 'safemode';
2644 } elseif ( !function_exists( 'proc_open' ) ) {
2645 wfDebug( "proc_open() is disabled\n" );
2646 $disabled = 'disabled';
2655 * Execute a shell command, with time and memory limits mirrored from the PHP
2656 * configuration if supported.
2658 * @param string|string[] $cmd If string, a properly shell-escaped command line,
2659 * or an array of unescaped arguments, in which case each value will be escaped
2660 * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
2661 * @param null|mixed &$retval Optional, will receive the program's exit code.
2662 * (non-zero is usually failure). If there is an error from
2663 * read, select, or proc_open(), this will be set to -1.
2664 * @param array $environ Optional environment variables which should be
2665 * added to the executed command environment.
2666 * @param array $limits Optional array with limits(filesize, memory, time, walltime)
2667 * this overwrites the global wgMaxShell* limits.
2668 * @param array $options Array of options:
2669 * - duplicateStderr: Set this to true to duplicate stderr to stdout,
2670 * including errors from limit.sh
2672 * @return string Collected stdout as a string
2674 function wfShellExec( $cmd, &$retval = null, $environ = array(),
2675 $limits = array(), $options = array()
2677 global $IP, $wgMaxShellMemory, $wgMaxShellFileSize, $wgMaxShellTime,
2678 $wgMaxShellWallClockTime, $wgShellCgroup;
2680 $disabled = wfShellExecDisabled();
2683 return $disabled == 'safemode' ?
2684 'Unable to run external programs in safe mode.' :
2685 'Unable to run external programs, proc_open() is disabled.';
2688 $includeStderr = isset( $options['duplicateStderr'] ) && $options['duplicateStderr'];
2690 wfInitShellLocale();
2693 foreach ( $environ as $k => $v ) {
2694 if ( wfIsWindows() ) {
2695 /* Surrounding a set in quotes (method used by wfEscapeShellArg) makes the quotes themselves
2696 * appear in the environment variable, so we must use carat escaping as documented in
2697 * http://technet.microsoft.com/en-us/library/cc723564.aspx
2698 * Note however that the quote isn't listed there, but is needed, and the parentheses
2699 * are listed there but doesn't appear to need it.
2701 $envcmd .= "set $k=" . preg_replace( '/([&|()<>^"])/', '^\\1', $v ) . '&& ';
2703 /* Assume this is a POSIX shell, thus required to accept variable assignments before the command
2704 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_09_01
2706 $envcmd .= "$k=" . escapeshellarg( $v ) . ' ';
2709 if ( is_array( $cmd ) ) {
2710 // Command line may be given as an array, escape each value and glue them together with a space
2712 foreach ( $cmd as $val ) {
2713 $cmdVals[] = wfEscapeShellArg( $val );
2715 $cmd = implode( ' ', $cmdVals );
2718 $cmd = $envcmd . $cmd;
2720 $useLogPipe = false;
2721 if ( is_executable( '/bin/bash' ) ) {
2722 $time = intval ( isset( $limits['time'] ) ?
$limits['time'] : $wgMaxShellTime );
2723 if ( isset( $limits['walltime'] ) ) {
2724 $wallTime = intval( $limits['walltime'] );
2725 } elseif ( isset( $limits['time'] ) ) {
2728 $wallTime = intval( $wgMaxShellWallClockTime );
2730 $mem = intval ( isset( $limits['memory'] ) ?
$limits['memory'] : $wgMaxShellMemory );
2731 $filesize = intval ( isset( $limits['filesize'] ) ?
$limits['filesize'] : $wgMaxShellFileSize );
2733 if ( $time > 0 ||
$mem > 0 ||
$filesize > 0 ||
$wallTime > 0 ) {
2734 $cmd = '/bin/bash ' . escapeshellarg( "$IP/includes/limit.sh" ) . ' ' .
2735 escapeshellarg( $cmd ) . ' ' .
2737 "MW_INCLUDE_STDERR=" . ( $includeStderr ?
'1' : '' ) . ';' .
2738 "MW_CPU_LIMIT=$time; " .
2739 'MW_CGROUP=' . escapeshellarg( $wgShellCgroup ) . '; ' .
2740 "MW_MEM_LIMIT=$mem; " .
2741 "MW_FILE_SIZE_LIMIT=$filesize; " .
2742 "MW_WALL_CLOCK_LIMIT=$wallTime; " .
2743 "MW_USE_LOG_PIPE=yes"
2746 } elseif ( $includeStderr ) {
2749 } elseif ( $includeStderr ) {
2752 wfDebug( "wfShellExec: $cmd\n" );
2755 0 => array( 'file', 'php://stdin', 'r' ),
2756 1 => array( 'pipe', 'w' ),
2757 2 => array( 'file', 'php://stderr', 'w' ) );
2758 if ( $useLogPipe ) {
2759 $desc[3] = array( 'pipe', 'w' );
2762 $proc = proc_open( $cmd, $desc, $pipes );
2764 wfDebugLog( 'exec', "proc_open() failed: $cmd" );
2768 $outBuffer = $logBuffer = '';
2769 $emptyArray = array();
2773 // According to the documentation, it is possible for stream_select()
2774 // to fail due to EINTR. I haven't managed to induce this in testing
2775 // despite sending various signals. If it did happen, the error
2776 // message would take the form:
2778 // stream_select(): unable to select [4]: Interrupted system call (max_fd=5)
2780 // where [4] is the value of the macro EINTR and "Interrupted system
2781 // call" is string which according to the Linux manual is "possibly"
2782 // localised according to LC_MESSAGES.
2783 $eintr = defined( 'SOCKET_EINTR' ) ? SOCKET_EINTR
: 4;
2784 $eintrMessage = "stream_select(): unable to select [$eintr]";
2786 // Build a table mapping resource IDs to pipe FDs to work around a
2787 // PHP 5.3 issue in which stream_select() does not preserve array keys
2788 // <https://bugs.php.net/bug.php?id=53427>.
2790 foreach ( $pipes as $fd => $pipe ) {
2791 $fds[(int)$pipe] = $fd;
2798 while ( $running === true ||
$numReadyPipes !== 0 ) {
2800 $status = proc_get_status( $proc );
2801 // If the process has terminated, switch to nonblocking selects
2802 // for getting any data still waiting to be read.
2803 if ( !$status['running'] ) {
2809 $readyPipes = $pipes;
2812 // @codingStandardsIgnoreStart Generic.PHP.NoSilencedErrors.Discouraged
2813 @trigger_error
( '' );
2814 $numReadyPipes = @stream_select
( $readyPipes, $emptyArray, $emptyArray, $timeout );
2815 if ( $numReadyPipes === false ) {
2816 // @codingStandardsIgnoreEnd
2817 $error = error_get_last();
2818 if ( strncmp( $error['message'], $eintrMessage, strlen( $eintrMessage ) ) == 0 ) {
2821 trigger_error( $error['message'], E_USER_WARNING
);
2822 $logMsg = $error['message'];
2826 foreach ( $readyPipes as $pipe ) {
2827 $block = fread( $pipe, 65536 );
2828 $fd = $fds[(int)$pipe];
2829 if ( $block === '' ) {
2831 fclose( $pipes[$fd] );
2832 unset( $pipes[$fd] );
2836 } elseif ( $block === false ) {
2838 $logMsg = "Error reading from pipe";
2840 } elseif ( $fd == 1 ) {
2842 $outBuffer .= $block;
2843 } elseif ( $fd == 3 ) {
2845 $logBuffer .= $block;
2846 if ( strpos( $block, "\n" ) !== false ) {
2847 $lines = explode( "\n", $logBuffer );
2848 $logBuffer = array_pop( $lines );
2849 foreach ( $lines as $line ) {
2850 wfDebugLog( 'exec', $line );
2857 foreach ( $pipes as $pipe ) {
2861 // Use the status previously collected if possible, since proc_get_status()
2862 // just calls waitpid() which will not return anything useful the second time.
2864 $status = proc_get_status( $proc );
2867 if ( $logMsg !== false ) {
2868 // Read/select error
2870 proc_close( $proc );
2871 } elseif ( $status['signaled'] ) {
2872 $logMsg = "Exited with signal {$status['termsig']}";
2873 $retval = 128 +
$status['termsig'];
2874 proc_close( $proc );
2876 if ( $status['running'] ) {
2877 $retval = proc_close( $proc );
2879 $retval = $status['exitcode'];
2880 proc_close( $proc );
2882 if ( $retval == 127 ) {
2883 $logMsg = "Possibly missing executable file";
2884 } elseif ( $retval >= 129 && $retval <= 192 ) {
2885 $logMsg = "Probably exited with signal " . ( $retval - 128 );
2889 if ( $logMsg !== false ) {
2890 wfDebugLog( 'exec', "$logMsg: $cmd" );
2897 * Execute a shell command, returning both stdout and stderr. Convenience
2898 * function, as all the arguments to wfShellExec can become unwieldy.
2900 * @note This also includes errors from limit.sh, e.g. if $wgMaxShellFileSize is exceeded.
2901 * @param string|string[] $cmd If string, a properly shell-escaped command line,
2902 * or an array of unescaped arguments, in which case each value will be escaped
2903 * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
2904 * @param null|mixed &$retval Optional, will receive the program's exit code.
2905 * (non-zero is usually failure)
2906 * @param array $environ Optional environment variables which should be
2907 * added to the executed command environment.
2908 * @param array $limits Optional array with limits(filesize, memory, time, walltime)
2909 * this overwrites the global wgMaxShell* limits.
2910 * @return string Collected stdout and stderr as a string
2912 function wfShellExecWithStderr( $cmd, &$retval = null, $environ = array(), $limits = array() ) {
2913 return wfShellExec( $cmd, $retval, $environ, $limits, array( 'duplicateStderr' => true ) );
2917 * Workaround for http://bugs.php.net/bug.php?id=45132
2918 * escapeshellarg() destroys non-ASCII characters if LANG is not a UTF-8 locale
2920 function wfInitShellLocale() {
2921 static $done = false;
2926 global $wgShellLocale;
2927 if ( !wfIniGetBool( 'safe_mode' ) ) {
2928 putenv( "LC_CTYPE=$wgShellLocale" );
2929 setlocale( LC_CTYPE
, $wgShellLocale );
2934 * Alias to wfShellWikiCmd()
2936 * @see wfShellWikiCmd()
2938 function wfShellMaintenanceCmd( $script, array $parameters = array(), array $options = array() ) {
2939 return wfShellWikiCmd( $script, $parameters, $options );
2943 * Generate a shell-escaped command line string to run a MediaWiki cli script.
2944 * Note that $parameters should be a flat array and an option with an argument
2945 * should consist of two consecutive items in the array (do not use "--option value").
2947 * @param string $script MediaWiki cli script path
2948 * @param array $parameters Arguments and options to the script
2949 * @param array $options Associative array of options:
2950 * 'php': The path to the php executable
2951 * 'wrapper': Path to a PHP wrapper to handle the maintenance script
2954 function wfShellWikiCmd( $script, array $parameters = array(), array $options = array() ) {
2956 // Give site config file a chance to run the script in a wrapper.
2957 // The caller may likely want to call wfBasename() on $script.
2958 wfRunHooks( 'wfShellWikiCmd', array( &$script, &$parameters, &$options ) );
2959 $cmd = isset( $options['php'] ) ?
array( $options['php'] ) : array( $wgPhpCli );
2960 if ( isset( $options['wrapper'] ) ) {
2961 $cmd[] = $options['wrapper'];
2964 // Escape each parameter for shell
2965 return implode( " ", array_map( 'wfEscapeShellArg', array_merge( $cmd, $parameters ) ) );
2969 * wfMerge attempts to merge differences between three texts.
2970 * Returns true for a clean merge and false for failure or a conflict.
2972 * @param string $old
2973 * @param string $mine
2974 * @param string $yours
2975 * @param string $result
2978 function wfMerge( $old, $mine, $yours, &$result ) {
2981 # This check may also protect against code injection in
2982 # case of broken installations.
2983 wfSuppressWarnings();
2984 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
2985 wfRestoreWarnings();
2987 if ( !$haveDiff3 ) {
2988 wfDebug( "diff3 not found\n" );
2992 # Make temporary files
2994 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2995 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
2996 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
2998 # NOTE: diff3 issues a warning to stderr if any of the files does not end with
2999 # a newline character. To avoid this, we normalize the trailing whitespace before
3000 # creating the diff.
3002 fwrite( $oldtextFile, rtrim( $old ) . "\n" );
3003 fclose( $oldtextFile );
3004 fwrite( $mytextFile, rtrim( $mine ) . "\n" );
3005 fclose( $mytextFile );
3006 fwrite( $yourtextFile, rtrim( $yours ) . "\n" );
3007 fclose( $yourtextFile );
3009 # Check for a conflict
3010 $cmd = wfEscapeShellArg( $wgDiff3 ) . ' -a --overlap-only ' .
3011 wfEscapeShellArg( $mytextName ) . ' ' .
3012 wfEscapeShellArg( $oldtextName ) . ' ' .
3013 wfEscapeShellArg( $yourtextName );
3014 $handle = popen( $cmd, 'r' );
3016 if ( fgets( $handle, 1024 ) ) {
3024 $cmd = wfEscapeShellArg( $wgDiff3 ) . ' -a -e --merge ' .
3025 wfEscapeShellArg( $mytextName, $oldtextName, $yourtextName );
3026 $handle = popen( $cmd, 'r' );
3029 $data = fread( $handle, 8192 );
3030 if ( strlen( $data ) == 0 ) {
3036 unlink( $mytextName );
3037 unlink( $oldtextName );
3038 unlink( $yourtextName );
3040 if ( $result === '' && $old !== '' && !$conflict ) {
3041 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
3048 * Returns unified plain-text diff of two texts.
3049 * Useful for machine processing of diffs.
3051 * @param string $before The text before the changes.
3052 * @param string $after The text after the changes.
3053 * @param string $params Command-line options for the diff command.
3054 * @return string Unified diff of $before and $after
3056 function wfDiff( $before, $after, $params = '-u' ) {
3057 if ( $before == $after ) {
3062 wfSuppressWarnings();
3063 $haveDiff = $wgDiff && file_exists( $wgDiff );
3064 wfRestoreWarnings();
3066 # This check may also protect against code injection in
3067 # case of broken installations.
3069 wfDebug( "diff executable not found\n" );
3070 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
3071 $format = new UnifiedDiffFormatter();
3072 return $format->format( $diffs );
3075 # Make temporary files
3077 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
3078 $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
3080 fwrite( $oldtextFile, $before );
3081 fclose( $oldtextFile );
3082 fwrite( $newtextFile, $after );
3083 fclose( $newtextFile );
3085 // Get the diff of the two files
3086 $cmd = "$wgDiff " . $params . ' ' . wfEscapeShellArg( $oldtextName, $newtextName );
3088 $h = popen( $cmd, 'r' );
3093 $data = fread( $h, 8192 );
3094 if ( strlen( $data ) == 0 ) {
3102 unlink( $oldtextName );
3103 unlink( $newtextName );
3105 // Kill the --- and +++ lines. They're not useful.
3106 $diff_lines = explode( "\n", $diff );
3107 if ( isset( $diff_lines[0] ) && strpos( $diff_lines[0], '---' ) === 0 ) {
3108 unset( $diff_lines[0] );
3110 if ( isset( $diff_lines[1] ) && strpos( $diff_lines[1], '+++' ) === 0 ) {
3111 unset( $diff_lines[1] );
3114 $diff = implode( "\n", $diff_lines );
3120 * This function works like "use VERSION" in Perl, the program will die with a
3121 * backtrace if the current version of PHP is less than the version provided
3123 * This is useful for extensions which due to their nature are not kept in sync
3124 * with releases, and might depend on other versions of PHP than the main code
3126 * Note: PHP might die due to parsing errors in some cases before it ever
3127 * manages to call this function, such is life
3129 * @see perldoc -f use
3131 * @param string|int|float $req_ver The version to check, can be a string, an integer, or a float
3132 * @throws MWException
3134 function wfUsePHP( $req_ver ) {
3135 $php_ver = PHP_VERSION
;
3137 if ( version_compare( $php_ver, (string)$req_ver, '<' ) ) {
3138 throw new MWException( "PHP $req_ver required--this is only $php_ver" );
3143 * This function works like "use VERSION" in Perl except it checks the version
3144 * of MediaWiki, the program will die with a backtrace if the current version
3145 * of MediaWiki is less than the version provided.
3147 * This is useful for extensions which due to their nature are not kept in sync
3150 * Note: Due to the behavior of PHP's version_compare() which is used in this
3151 * function, if you want to allow the 'wmf' development versions add a 'c' (or
3152 * any single letter other than 'a', 'b' or 'p') as a post-fix to your
3153 * targeted version number. For example if you wanted to allow any variation
3154 * of 1.22 use `wfUseMW( '1.22c' )`. Using an 'a' or 'b' instead of 'c' will
3155 * not result in the same comparison due to the internal logic of
3156 * version_compare().
3158 * @see perldoc -f use
3160 * @param string|int|float $req_ver The version to check, can be a string, an integer, or a float
3161 * @throws MWException
3163 function wfUseMW( $req_ver ) {
3166 if ( version_compare( $wgVersion, (string)$req_ver, '<' ) ) {
3167 throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
3172 * Return the final portion of a pathname.
3173 * Reimplemented because PHP5's "basename()" is buggy with multibyte text.
3174 * http://bugs.php.net/bug.php?id=33898
3176 * PHP's basename() only considers '\' a pathchar on Windows and Netware.
3177 * We'll consider it so always, as we don't want '\s' in our Unix paths either.
3179 * @param string $path
3180 * @param string $suffix String to remove if present
3183 function wfBaseName( $path, $suffix = '' ) {
3184 if ( $suffix == '' ) {
3187 $encSuffix = '(?:' . preg_quote( $suffix, '#' ) . ')?';
3191 if ( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
3199 * Generate a relative path name to the given file.
3200 * May explode on non-matching case-insensitive paths,
3201 * funky symlinks, etc.
3203 * @param string $path Absolute destination path including target filename
3204 * @param string $from Absolute source path, directory only
3207 function wfRelativePath( $path, $from ) {
3208 // Normalize mixed input on Windows...
3209 $path = str_replace( '/', DIRECTORY_SEPARATOR
, $path );
3210 $from = str_replace( '/', DIRECTORY_SEPARATOR
, $from );
3212 // Trim trailing slashes -- fix for drive root
3213 $path = rtrim( $path, DIRECTORY_SEPARATOR
);
3214 $from = rtrim( $from, DIRECTORY_SEPARATOR
);
3216 $pieces = explode( DIRECTORY_SEPARATOR
, dirname( $path ) );
3217 $against = explode( DIRECTORY_SEPARATOR
, $from );
3219 if ( $pieces[0] !== $against[0] ) {
3220 // Non-matching Windows drive letters?
3221 // Return a full path.
3225 // Trim off common prefix
3226 while ( count( $pieces ) && count( $against )
3227 && $pieces[0] == $against[0] ) {
3228 array_shift( $pieces );
3229 array_shift( $against );
3232 // relative dots to bump us to the parent
3233 while ( count( $against ) ) {
3234 array_unshift( $pieces, '..' );
3235 array_shift( $against );
3238 array_push( $pieces, wfBaseName( $path ) );
3240 return implode( DIRECTORY_SEPARATOR
, $pieces );
3244 * Convert an arbitrarily-long digit string from one numeric base
3245 * to another, optionally zero-padding to a minimum column width.
3247 * Supports base 2 through 36; digit values 10-36 are represented
3248 * as lowercase letters a-z. Input is case-insensitive.
3250 * @param string $input Input number
3251 * @param int $sourceBase Base of the input number
3252 * @param int $destBase Desired base of the output
3253 * @param int $pad Minimum number of digits in the output (pad with zeroes)
3254 * @param bool $lowercase Whether to output in lowercase or uppercase
3255 * @param string $engine Either "gmp", "bcmath", or "php"
3256 * @return string|bool The output number as a string, or false on error
3258 function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1,
3259 $lowercase = true, $engine = 'auto'
3261 $input = (string)$input;
3267 $sourceBase != (int)$sourceBase ||
3268 $destBase != (int)$destBase ||
3269 $pad != (int)$pad ||
3271 "/^[" . substr( '0123456789abcdefghijklmnopqrstuvwxyz', 0, $sourceBase ) . "]+$/i",
3278 static $baseChars = array(
3279 10 => 'a', 11 => 'b', 12 => 'c', 13 => 'd', 14 => 'e', 15 => 'f',
3280 16 => 'g', 17 => 'h', 18 => 'i', 19 => 'j', 20 => 'k', 21 => 'l',
3281 22 => 'm', 23 => 'n', 24 => 'o', 25 => 'p', 26 => 'q', 27 => 'r',
3282 28 => 's', 29 => 't', 30 => 'u', 31 => 'v', 32 => 'w', 33 => 'x',
3283 34 => 'y', 35 => 'z',
3285 '0' => 0, '1' => 1, '2' => 2, '3' => 3, '4' => 4, '5' => 5,
3286 '6' => 6, '7' => 7, '8' => 8, '9' => 9, 'a' => 10, 'b' => 11,
3287 'c' => 12, 'd' => 13, 'e' => 14, 'f' => 15, 'g' => 16, 'h' => 17,
3288 'i' => 18, 'j' => 19, 'k' => 20, 'l' => 21, 'm' => 22, 'n' => 23,
3289 'o' => 24, 'p' => 25, 'q' => 26, 'r' => 27, 's' => 28, 't' => 29,
3290 'u' => 30, 'v' => 31, 'w' => 32, 'x' => 33, 'y' => 34, 'z' => 35
3293 if ( extension_loaded( 'gmp' ) && ( $engine == 'auto' ||
$engine == 'gmp' ) ) {
3294 // Removing leading zeros works around broken base detection code in
3295 // some PHP versions (see <https://bugs.php.net/bug.php?id=50175> and
3296 // <https://bugs.php.net/bug.php?id=55398>).
3297 $result = gmp_strval( gmp_init( ltrim( $input, '0' ), $sourceBase ), $destBase );
3298 } elseif ( extension_loaded( 'bcmath' ) && ( $engine == 'auto' ||
$engine == 'bcmath' ) ) {
3300 foreach ( str_split( strtolower( $input ) ) as $char ) {
3301 $decimal = bcmul( $decimal, $sourceBase );
3302 $decimal = bcadd( $decimal, $baseChars[$char] );
3305 // @codingStandardsIgnoreStart Generic.CodeAnalysis.ForLoopWithTestFunctionCall.NotAllowed
3306 for ( $result = ''; bccomp( $decimal, 0 ); $decimal = bcdiv( $decimal, $destBase, 0 ) ) {
3307 $result .= $baseChars[bcmod( $decimal, $destBase )];
3309 // @codingStandardsIgnoreEnd
3311 $result = strrev( $result );
3313 $inDigits = array();
3314 foreach ( str_split( strtolower( $input ) ) as $char ) {
3315 $inDigits[] = $baseChars[$char];
3318 // Iterate over the input, modulo-ing out an output digit
3319 // at a time until input is gone.
3321 while ( $inDigits ) {
3323 $workDigits = array();
3326 foreach ( $inDigits as $digit ) {
3327 $work *= $sourceBase;
3330 if ( $workDigits ||
$work >= $destBase ) {
3331 $workDigits[] = (int)( $work / $destBase );
3336 // All that division leaves us with a remainder,
3337 // which is conveniently our next output digit.
3338 $result .= $baseChars[$work];
3341 $inDigits = $workDigits;
3344 $result = strrev( $result );
3347 if ( !$lowercase ) {
3348 $result = strtoupper( $result );
3351 return str_pad( $result, $pad, '0', STR_PAD_LEFT
);
3355 * Check if there is sufficient entropy in php's built-in session generation
3357 * @return bool True = there is sufficient entropy
3359 function wfCheckEntropy() {
3361 ( wfIsWindows() && version_compare( PHP_VERSION
, '5.3.3', '>=' ) )
3362 ||
ini_get( 'session.entropy_file' )
3364 && intval( ini_get( 'session.entropy_length' ) ) >= 32;
3368 * Override session_id before session startup if php's built-in
3369 * session generation code is not secure.
3371 function wfFixSessionID() {
3372 // If the cookie or session id is already set we already have a session and should abort
3373 if ( isset( $_COOKIE[session_name()] ) ||
session_id() ) {
3377 // PHP's built-in session entropy is enabled if:
3378 // - entropy_file is set or you're on Windows with php 5.3.3+
3379 // - AND entropy_length is > 0
3380 // We treat it as disabled if it doesn't have an entropy length of at least 32
3381 $entropyEnabled = wfCheckEntropy();
3383 // If built-in entropy is not enabled or not sufficient override PHP's
3384 // built in session id generation code
3385 if ( !$entropyEnabled ) {
3386 wfDebug( __METHOD__
. ": PHP's built in entropy is disabled or not sufficient, " .
3387 "overriding session id generation using our cryptrand source.\n" );
3388 session_id( MWCryptRand
::generateHex( 32 ) );
3393 * Reset the session_id
3397 function wfResetSessionID() {
3398 global $wgCookieSecure;
3399 $oldSessionId = session_id();
3400 $cookieParams = session_get_cookie_params();
3401 if ( wfCheckEntropy() && $wgCookieSecure == $cookieParams['secure'] ) {
3402 session_regenerate_id( false );
3406 wfSetupSession( MWCryptRand
::generateHex( 32 ) );
3409 $newSessionId = session_id();
3410 wfRunHooks( 'ResetSessionID', array( $oldSessionId, $newSessionId ) );
3414 * Initialise php session
3416 * @param bool $sessionId
3418 function wfSetupSession( $sessionId = false ) {
3419 global $wgSessionsInMemcached, $wgSessionsInObjectCache, $wgCookiePath, $wgCookieDomain,
3420 $wgCookieSecure, $wgCookieHttpOnly, $wgSessionHandler;
3421 if ( $wgSessionsInObjectCache ||
$wgSessionsInMemcached ) {
3422 ObjectCacheSessionHandler
::install();
3423 } elseif ( $wgSessionHandler && $wgSessionHandler != ini_get( 'session.save_handler' ) ) {
3424 # Only set this if $wgSessionHandler isn't null and session.save_handler
3425 # hasn't already been set to the desired value (that causes errors)
3426 ini_set( 'session.save_handler', $wgSessionHandler );
3428 session_set_cookie_params(
3429 0, $wgCookiePath, $wgCookieDomain, $wgCookieSecure, $wgCookieHttpOnly );
3430 session_cache_limiter( 'private, must-revalidate' );
3432 session_id( $sessionId );
3436 wfSuppressWarnings();
3438 wfRestoreWarnings();
3442 * Get an object from the precompiled serialized directory
3444 * @param string $name
3445 * @return mixed The variable on success, false on failure
3447 function wfGetPrecompiledData( $name ) {
3450 $file = "$IP/serialized/$name";
3451 if ( file_exists( $file ) ) {
3452 $blob = file_get_contents( $file );
3454 return unserialize( $blob );
3463 * @param string $args,...
3466 function wfMemcKey( /*...*/ ) {
3467 global $wgCachePrefix;
3468 $prefix = $wgCachePrefix === false ?
wfWikiID() : $wgCachePrefix;
3469 $args = func_get_args();
3470 $key = $prefix . ':' . implode( ':', $args );
3471 $key = str_replace( ' ', '_', $key );
3476 * Get a cache key for a foreign DB
3479 * @param string $prefix
3480 * @param string $args,...
3483 function wfForeignMemcKey( $db, $prefix /*...*/ ) {
3484 $args = array_slice( func_get_args(), 2 );
3486 $key = "$db-$prefix:" . implode( ':', $args );
3488 $key = $db . ':' . implode( ':', $args );
3490 return str_replace( ' ', '_', $key );
3494 * Get an ASCII string identifying this wiki
3495 * This is used as a prefix in memcached keys
3499 function wfWikiID() {
3500 global $wgDBprefix, $wgDBname;
3501 if ( $wgDBprefix ) {
3502 return "$wgDBname-$wgDBprefix";
3509 * Split a wiki ID into DB name and table prefix
3511 * @param string $wiki
3515 function wfSplitWikiID( $wiki ) {
3516 $bits = explode( '-', $wiki, 2 );
3517 if ( count( $bits ) < 2 ) {
3524 * Get a Database object.
3526 * @param int $db Index of the connection to get. May be DB_MASTER for the
3527 * master (for write queries), DB_SLAVE for potentially lagged read
3528 * queries, or an integer >= 0 for a particular server.
3530 * @param string|string[] $groups Query groups. An array of group names that this query
3531 * belongs to. May contain a single string if the query is only
3534 * @param string|bool $wiki The wiki ID, or false for the current wiki
3536 * Note: multiple calls to wfGetDB(DB_SLAVE) during the course of one request
3537 * will always return the same object, unless the underlying connection or load
3538 * balancer is manually destroyed.
3540 * Note 2: use $this->getDB() in maintenance scripts that may be invoked by
3541 * updater to ensure that a proper database is being updated.
3543 * @return DatabaseBase
3545 function &wfGetDB( $db, $groups = array(), $wiki = false ) {
3546 return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
3550 * Get a load balancer object.
3552 * @param string|bool $wiki Wiki ID, or false for the current wiki
3553 * @return LoadBalancer
3555 function wfGetLB( $wiki = false ) {
3556 return wfGetLBFactory()->getMainLB( $wiki );
3560 * Get the load balancer factory object
3564 function &wfGetLBFactory() {
3565 return LBFactory
::singleton();
3570 * Shortcut for RepoGroup::singleton()->findFile()
3572 * @param string $title String or Title object
3573 * @param array $options Associative array of options:
3574 * time: requested time for an archived image, or false for the
3575 * current version. An image object will be returned which was
3576 * created at the specified time.
3578 * ignoreRedirect: If true, do not follow file redirects
3580 * private: If true, return restricted (deleted) files if the current
3581 * user is allowed to view them. Otherwise, such files will not
3584 * bypassCache: If true, do not use the process-local cache of File objects
3586 * @return File|bool File, or false if the file does not exist
3588 function wfFindFile( $title, $options = array() ) {
3589 return RepoGroup
::singleton()->findFile( $title, $options );
3593 * Get an object referring to a locally registered file.
3594 * Returns a valid placeholder object if the file does not exist.
3596 * @param Title|string $title
3597 * @return LocalFile|null A File, or null if passed an invalid Title
3599 function wfLocalFile( $title ) {
3600 return RepoGroup
::singleton()->getLocalRepo()->newFile( $title );
3604 * Should low-performance queries be disabled?
3607 * @codeCoverageIgnore
3609 function wfQueriesMustScale() {
3610 global $wgMiserMode;
3612 ||
( SiteStats
::pages() > 100000
3613 && SiteStats
::edits() > 1000000
3614 && SiteStats
::users() > 10000 );
3618 * Get the path to a specified script file, respecting file
3619 * extensions; this is a wrapper around $wgScriptExtension etc.
3620 * except for 'index' and 'load' which use $wgScript/$wgLoadScript
3622 * @param string $script Script filename, sans extension
3625 function wfScript( $script = 'index' ) {
3626 global $wgScriptPath, $wgScriptExtension, $wgScript, $wgLoadScript;
3627 if ( $script === 'index' ) {
3629 } elseif ( $script === 'load' ) {
3630 return $wgLoadScript;
3632 return "{$wgScriptPath}/{$script}{$wgScriptExtension}";
3637 * Get the script URL.
3639 * @return string Script URL
3641 function wfGetScriptUrl() {
3642 if ( isset( $_SERVER['SCRIPT_NAME'] ) ) {
3644 # as it was called, minus the query string.
3646 # Some sites use Apache rewrite rules to handle subdomains,
3647 # and have PHP set up in a weird way that causes PHP_SELF
3648 # to contain the rewritten URL instead of the one that the
3649 # outside world sees.
3651 # If in this mode, use SCRIPT_URL instead, which mod_rewrite
3652 # provides containing the "before" URL.
3653 return $_SERVER['SCRIPT_NAME'];
3655 return $_SERVER['URL'];
3660 * Convenience function converts boolean values into "true"
3661 * or "false" (string) values
3663 * @param bool $value
3666 function wfBoolToStr( $value ) {
3667 return $value ?
'true' : 'false';
3671 * Get a platform-independent path to the null file, e.g. /dev/null
3675 function wfGetNull() {
3676 return wfIsWindows() ?
'NUL' : '/dev/null';
3680 * Waits for the slaves to catch up to the master position
3682 * Use this when updating very large numbers of rows, as in maintenance scripts,
3683 * to avoid causing too much lag. Of course, this is a no-op if there are no slaves.
3685 * By default this waits on the main DB cluster of the current wiki.
3686 * If $cluster is set to "*" it will wait on all DB clusters, including
3687 * external ones. If the lag being waiting on is caused by the code that
3688 * does this check, it makes since to use $ifWritesSince, particularly if
3689 * cluster is "*", to avoid excess overhead.
3691 * Never call this function after a big DB write that is still in a transaction.
3692 * This only makes sense after the possible lag inducing changes were committed.
3694 * @param float|null $ifWritesSince Only wait if writes were done since this UNIX timestamp
3695 * @param string|bool $wiki Wiki identifier accepted by wfGetLB
3696 * @param string|bool $cluster Cluster name accepted by LBFactory. Default: false.
3697 * @param int|null $timeout Max wait time. Default: 1 day (cli), ~10 seconds (web)
3698 * @return bool Success (able to connect and no timeouts reached)
3700 function wfWaitForSlaves(
3701 $ifWritesSince = null, $wiki = false, $cluster = false, $timeout = null
3703 // B/C: first argument used to be "max seconds of lag"; ignore such values
3704 $ifWritesSince = ( $ifWritesSince > 1e9
) ?
$ifWritesSince : null;
3706 if ( $timeout === null ) {
3707 $timeout = ( PHP_SAPI
=== 'cli' ) ?
86400 : 10;
3710 // Figure out which clusters need to be checked
3712 if ( $cluster === '*' ) {
3713 wfGetLBFactory()->forEachLB( function( LoadBalancer
$lb ) use ( &$lbs ) {
3716 } elseif ( $cluster !== false ) {
3717 $lbs[] = wfGetLBFactory()->getExternalLB( $cluster );
3719 $lbs[] = wfGetLB( $wiki );
3722 // Get all the master positions of applicable DBs right now.
3723 // This can be faster since waiting on one cluster reduces the
3724 // time needed to wait on the next clusters.
3725 $masterPositions = array_fill( 0, count( $lbs ), false );
3726 foreach ( $lbs as $i => $lb ) {
3727 // bug 27975 - Don't try to wait for slaves if there are none
3728 // Prevents permission error when getting master position
3729 if ( $lb->getServerCount() > 1 ) {
3730 if ( $ifWritesSince && !$lb->hasMasterConnection() ) {
3731 continue; // assume no writes done
3733 $dbw = $lb->getConnection( DB_MASTER
, array(), $wiki );
3734 if ( $ifWritesSince && $dbw->lastDoneWrites() < $ifWritesSince ) {
3735 continue; // no writes since the last wait
3737 $masterPositions[$i] = $dbw->getMasterPos();
3742 foreach ( $lbs as $i => $lb ) {
3743 if ( $masterPositions[$i] ) {
3744 // The DBMS may not support getMasterPos() or the whole
3745 // load balancer might be fake (e.g. $wgAllDBsAreLocalhost).
3746 $ok = $lb->waitForAll( $masterPositions[$i], $timeout ) && $ok;
3754 * Count down from $seconds to zero on the terminal, with a one-second pause
3755 * between showing each number. For use in command-line scripts.
3757 * @codeCoverageIgnore
3758 * @param int $seconds
3760 function wfCountDown( $seconds ) {
3761 for ( $i = $seconds; $i >= 0; $i-- ) {
3762 if ( $i != $seconds ) {
3763 echo str_repeat( "\x08", strlen( $i +
1 ) );
3775 * Replace all invalid characters with -
3776 * Additional characters can be defined in $wgIllegalFileChars (see bug 20489)
3777 * By default, $wgIllegalFileChars = ':'
3779 * @param string $name Filename to process
3782 function wfStripIllegalFilenameChars( $name ) {
3783 global $wgIllegalFileChars;
3784 $illegalFileChars = $wgIllegalFileChars ?
"|[" . $wgIllegalFileChars . "]" : '';
3785 $name = wfBaseName( $name );
3786 $name = preg_replace(
3787 "/[^" . Title
::legalChars() . "]" . $illegalFileChars . "/",
3795 * Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit;
3797 * @return int Value the memory limit was set to.
3799 function wfMemoryLimit() {
3800 global $wgMemoryLimit;
3801 $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
3802 if ( $memlimit != -1 ) {
3803 $conflimit = wfShorthandToInteger( $wgMemoryLimit );
3804 if ( $conflimit == -1 ) {
3805 wfDebug( "Removing PHP's memory limit\n" );
3806 wfSuppressWarnings();
3807 ini_set( 'memory_limit', $conflimit );
3808 wfRestoreWarnings();
3810 } elseif ( $conflimit > $memlimit ) {
3811 wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
3812 wfSuppressWarnings();
3813 ini_set( 'memory_limit', $conflimit );
3814 wfRestoreWarnings();
3822 * Converts shorthand byte notation to integer form
3824 * @param string $string
3827 function wfShorthandToInteger( $string = '' ) {
3828 $string = trim( $string );
3829 if ( $string === '' ) {
3832 $last = $string[strlen( $string ) - 1];
3833 $val = intval( $string );
3838 // break intentionally missing
3842 // break intentionally missing
3852 * Get the normalised IETF language tag
3853 * See unit test for examples.
3855 * @param string $code The language code.
3856 * @return string The language code which complying with BCP 47 standards.
3858 function wfBCP47( $code ) {
3859 $codeSegment = explode( '-', $code );
3861 foreach ( $codeSegment as $segNo => $seg ) {
3862 // when previous segment is x, it is a private segment and should be lc
3863 if ( $segNo > 0 && strtolower( $codeSegment[( $segNo - 1 )] ) == 'x' ) {
3864 $codeBCP[$segNo] = strtolower( $seg );
3865 // ISO 3166 country code
3866 } elseif ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) {
3867 $codeBCP[$segNo] = strtoupper( $seg );
3868 // ISO 15924 script code
3869 } elseif ( ( strlen( $seg ) == 4 ) && ( $segNo > 0 ) ) {
3870 $codeBCP[$segNo] = ucfirst( strtolower( $seg ) );
3871 // Use lowercase for other cases
3873 $codeBCP[$segNo] = strtolower( $seg );
3876 $langCode = implode( '-', $codeBCP );
3881 * Get a cache object.
3883 * @param int $inputType Cache type, one the the CACHE_* constants.
3886 function wfGetCache( $inputType ) {
3887 return ObjectCache
::getInstance( $inputType );
3891 * Get the main cache object
3895 function wfGetMainCache() {
3896 global $wgMainCacheType;
3897 return ObjectCache
::getInstance( $wgMainCacheType );
3901 * Get the cache object used by the message cache
3905 function wfGetMessageCacheStorage() {
3906 global $wgMessageCacheType;
3907 return ObjectCache
::getInstance( $wgMessageCacheType );
3911 * Get the cache object used by the parser cache
3915 function wfGetParserCacheStorage() {
3916 global $wgParserCacheType;
3917 return ObjectCache
::getInstance( $wgParserCacheType );
3921 * Get the cache object used by the language converter
3925 function wfGetLangConverterCacheStorage() {
3926 global $wgLanguageConverterCacheType;
3927 return ObjectCache
::getInstance( $wgLanguageConverterCacheType );
3931 * Call hook functions defined in $wgHooks
3933 * @param string $event Event name
3934 * @param array $args Parameters passed to hook functions
3935 * @param string|null $deprecatedVersion Optionally mark hook as deprecated with version number
3937 * @return bool True if no handler aborted the hook
3939 function wfRunHooks( $event, array $args = array(), $deprecatedVersion = null ) {
3940 return Hooks
::run( $event, $args, $deprecatedVersion );
3944 * Wrapper around php's unpack.
3946 * @param string $format The format string (See php's docs)
3947 * @param string $data A binary string of binary data
3948 * @param int|bool $length The minimum length of $data or false. This is to
3949 * prevent reading beyond the end of $data. false to disable the check.
3951 * Also be careful when using this function to read unsigned 32 bit integer
3952 * because php might make it negative.
3954 * @throws MWException If $data not long enough, or if unpack fails
3955 * @return array Associative array of the extracted data
3957 function wfUnpack( $format, $data, $length = false ) {
3958 if ( $length !== false ) {
3959 $realLen = strlen( $data );
3960 if ( $realLen < $length ) {
3961 throw new MWException( "Tried to use wfUnpack on a "
3962 . "string of length $realLen, but needed one "
3963 . "of at least length $length."
3968 wfSuppressWarnings();
3969 $result = unpack( $format, $data );
3970 wfRestoreWarnings();
3972 if ( $result === false ) {
3973 // If it cannot extract the packed data.
3974 throw new MWException( "unpack could not unpack binary data" );
3980 * Determine if an image exists on the 'bad image list'.
3982 * The format of MediaWiki:Bad_image_list is as follows:
3983 * * Only list items (lines starting with "*") are considered
3984 * * The first link on a line must be a link to a bad image
3985 * * Any subsequent links on the same line are considered to be exceptions,
3986 * i.e. articles where the image may occur inline.
3988 * @param string $name The image name to check
3989 * @param Title|bool $contextTitle The page on which the image occurs, if known
3990 * @param string $blacklist Wikitext of a file blacklist
3993 function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
3994 static $badImageCache = null; // based on bad_image_list msg
3995 wfProfileIn( __METHOD__
);
3998 $redirectTitle = RepoGroup
::singleton()->checkRedirect( Title
::makeTitle( NS_FILE
, $name ) );
3999 if ( $redirectTitle ) {
4000 $name = $redirectTitle->getDBkey();
4003 # Run the extension hook
4005 if ( !wfRunHooks( 'BadImage', array( $name, &$bad ) ) ) {
4006 wfProfileOut( __METHOD__
);
4010 $cacheable = ( $blacklist === null );
4011 if ( $cacheable && $badImageCache !== null ) {
4012 $badImages = $badImageCache;
4013 } else { // cache miss
4014 if ( $blacklist === null ) {
4015 $blacklist = wfMessage( 'bad_image_list' )->inContentLanguage()->plain(); // site list
4017 # Build the list now
4018 $badImages = array();
4019 $lines = explode( "\n", $blacklist );
4020 foreach ( $lines as $line ) {
4022 if ( substr( $line, 0, 1 ) !== '*' ) {
4028 if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
4032 $exceptions = array();
4033 $imageDBkey = false;
4034 foreach ( $m[1] as $i => $titleText ) {
4035 $title = Title
::newFromText( $titleText );
4036 if ( !is_null( $title ) ) {
4038 $imageDBkey = $title->getDBkey();
4040 $exceptions[$title->getPrefixedDBkey()] = true;
4045 if ( $imageDBkey !== false ) {
4046 $badImages[$imageDBkey] = $exceptions;
4050 $badImageCache = $badImages;
4054 $contextKey = $contextTitle ?
$contextTitle->getPrefixedDBkey() : false;
4055 $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
4056 wfProfileOut( __METHOD__
);
4061 * Determine whether the client at a given source IP is likely to be able to
4062 * access the wiki via HTTPS.
4064 * @param string $ip The IPv4/6 address in the normal human-readable form
4067 function wfCanIPUseHTTPS( $ip ) {
4069 wfRunHooks( 'CanIPUseHTTPS', array( $ip, &$canDo ) );
4074 * Work out the IP address based on various globals
4075 * For trusted proxies, use the XFF client IP (first of the chain)
4077 * @deprecated since 1.19; call $wgRequest->getIP() directly.
4080 function wfGetIP() {
4081 wfDeprecated( __METHOD__
, '1.19' );
4083 return $wgRequest->getIP();
4087 * Checks if an IP is a trusted proxy provider.
4088 * Useful to tell if X-Forwarded-For data is possibly bogus.
4089 * Squid cache servers for the site are whitelisted.
4090 * @deprecated Since 1.24, use IP::isTrustedProxy()
4095 function wfIsTrustedProxy( $ip ) {
4096 return IP
::isTrustedProxy( $ip );
4100 * Checks if an IP matches a proxy we've configured.
4101 * @deprecated Since 1.24, use IP::isConfiguredProxy()
4105 * @since 1.23 Supports CIDR ranges in $wgSquidServersNoPurge
4107 function wfIsConfiguredProxy( $ip ) {
4108 return IP
::isConfiguredProxy( $ip );