3 * Global functions used everywhere.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 if ( !defined( 'MEDIAWIKI' ) ) {
24 die( "This file is part of MediaWiki, it is not a valid entry point" );
27 use Liuggio\StatsdClient\StatsdClient
;
28 use Liuggio\StatsdClient\Sender\SocketSender
;
30 // Hide compatibility functions from Doxygen
34 * Compatibility functions
36 * We support PHP 5.3.3 and up.
37 * Re-implementations of newer functions or functions in non-standard
38 * PHP extensions may be included here.
41 if ( !function_exists( 'mb_substr' ) ) {
44 * @see Fallback::mb_substr
47 function mb_substr( $str, $start, $count = 'end' ) {
48 return Fallback
::mb_substr( $str, $start, $count );
53 * @see Fallback::mb_substr_split_unicode
56 function mb_substr_split_unicode( $str, $splitPos ) {
57 return Fallback
::mb_substr_split_unicode( $str, $splitPos );
61 if ( !function_exists( 'mb_strlen' ) ) {
64 * @see Fallback::mb_strlen
67 function mb_strlen( $str, $enc = '' ) {
68 return Fallback
::mb_strlen( $str, $enc );
72 if ( !function_exists( 'mb_strpos' ) ) {
75 * @see Fallback::mb_strpos
78 function mb_strpos( $haystack, $needle, $offset = 0, $encoding = '' ) {
79 return Fallback
::mb_strpos( $haystack, $needle, $offset, $encoding );
83 if ( !function_exists( 'mb_strrpos' ) ) {
86 * @see Fallback::mb_strrpos
89 function mb_strrpos( $haystack, $needle, $offset = 0, $encoding = '' ) {
90 return Fallback
::mb_strrpos( $haystack, $needle, $offset, $encoding );
94 // gzdecode function only exists in PHP >= 5.4.0
95 // http://php.net/gzdecode
96 if ( !function_exists( 'gzdecode' ) ) {
102 function gzdecode( $data ) {
103 return gzinflate( substr( $data, 10, -8 ) );
107 // hash_equals function only exists in PHP >= 5.6.0
108 // http://php.net/hash_equals
109 if ( !function_exists( 'hash_equals' ) ) {
111 * Check whether a user-provided string is equal to a fixed-length secret string
112 * without revealing bytes of the secret string through timing differences.
114 * The usual way to compare strings (PHP's === operator or the underlying memcmp()
115 * function in C) is to compare corresponding bytes and stop at the first difference,
116 * which would take longer for a partial match than for a complete mismatch. This
117 * is not secure when one of the strings (e.g. an HMAC or token) must remain secret
118 * and the other may come from an attacker. Statistical analysis of timing measurements
119 * over many requests may allow the attacker to guess the string's bytes one at a time
120 * (and check his guesses) even if the timing differences are extremely small.
122 * When making such a security-sensitive comparison, it is essential that the sequence
123 * in which instructions are executed and memory locations are accessed not depend on
124 * the secret string's value. HOWEVER, for simplicity, we do not attempt to minimize
125 * the inevitable leakage of the string's length. That is generally known anyway as
126 * a chararacteristic of the hash function used to compute the secret value.
128 * Longer explanation: http://www.emerose.com/timing-attacks-explained
130 * @codeCoverageIgnore
131 * @param string $known_string Fixed-length secret string to compare against
132 * @param string $user_string User-provided string
133 * @return bool True if the strings are the same, false otherwise
135 function hash_equals( $known_string, $user_string ) {
136 // Strict type checking as in PHP's native implementation
137 if ( !is_string( $known_string ) ) {
138 trigger_error( 'hash_equals(): Expected known_string to be a string, ' .
139 gettype( $known_string ) . ' given', E_USER_WARNING
);
144 if ( !is_string( $user_string ) ) {
145 trigger_error( 'hash_equals(): Expected user_string to be a string, ' .
146 gettype( $user_string ) . ' given', E_USER_WARNING
);
151 $known_string_len = strlen( $known_string );
152 if ( $known_string_len !== strlen( $user_string ) ) {
157 for ( $i = 0; $i < $known_string_len; $i++
) {
158 $result |
= ord( $known_string[$i] ) ^
ord( $user_string[$i] );
161 return ( $result === 0 );
169 * This queues an extension to be loaded through
170 * the ExtensionRegistry system.
172 * @param string $name Name of the extension to load
173 * @param string|null $path Absolute path of where to find the extension.json file
175 function wfLoadExtension( $name, $path = null ) {
178 $path = "$IP/extensions/$name/extension.json";
180 ExtensionRegistry
::getInstance()->queue( $path );
184 * Load multiple extensions at once
186 * Same as wfLoadExtension, but more efficient if you
187 * are loading multiple extensions.
189 * If you want to specify custom paths, you should interact with
190 * ExtensionRegistry directly.
192 * @see wfLoadExtension
193 * @param string[] $exts Array of extension names to load
195 function wfLoadExtensions( array $exts ) {
197 $registry = ExtensionRegistry
::getInstance();
198 foreach ( $exts as $ext ) {
199 $registry->queue( "$IP/extensions/$ext/extension.json" );
206 * @see wfLoadExtension
207 * @param string $name Name of the extension to load
208 * @param string|null $path Absolute path of where to find the skin.json file
210 function wfLoadSkin( $name, $path = null ) {
213 $path = "$IP/skins/$name/skin.json";
215 ExtensionRegistry
::getInstance()->queue( $path );
219 * Load multiple skins at once
221 * @see wfLoadExtensions
222 * @param string[] $skins Array of extension names to load
224 function wfLoadSkins( array $skins ) {
226 $registry = ExtensionRegistry
::getInstance();
227 foreach ( $skins as $skin ) {
228 $registry->queue( "$IP/skins/$skin/skin.json" );
233 * Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
238 function wfArrayDiff2( $a, $b ) {
239 return array_udiff( $a, $b, 'wfArrayDiff2_cmp' );
243 * @param array|string $a
244 * @param array|string $b
247 function wfArrayDiff2_cmp( $a, $b ) {
248 if ( is_string( $a ) && is_string( $b ) ) {
249 return strcmp( $a, $b );
250 } elseif ( count( $a ) !== count( $b ) ) {
251 return count( $a ) < count( $b ) ?
-1 : 1;
255 while ( ( list( , $valueA ) = each( $a ) ) && ( list( , $valueB ) = each( $b ) ) ) {
256 $cmp = strcmp( $valueA, $valueB );
266 * Appends to second array if $value differs from that in $default
268 * @param string|int $key
269 * @param mixed $value
270 * @param mixed $default
271 * @param array $changed Array to alter
272 * @throws MWException
274 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
275 if ( is_null( $changed ) ) {
276 throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' );
278 if ( $default[$key] !== $value ) {
279 $changed[$key] = $value;
284 * Merge arrays in the style of getUserPermissionsErrors, with duplicate removal
286 * wfMergeErrorArrays(
287 * array( array( 'x' ) ),
288 * array( array( 'x', '2' ) ),
289 * array( array( 'x' ) ),
290 * array( array( 'y' ) )
299 * @param array $array1,...
302 function wfMergeErrorArrays( /*...*/ ) {
303 $args = func_get_args();
305 foreach ( $args as $errors ) {
306 foreach ( $errors as $params ) {
307 # @todo FIXME: Sometimes get nested arrays for $params,
308 # which leads to E_NOTICEs
309 $spec = implode( "\t", $params );
310 $out[$spec] = $params;
313 return array_values( $out );
317 * Insert array into another array after the specified *KEY*
319 * @param array $array The array.
320 * @param array $insert The array to insert.
321 * @param mixed $after The key to insert after
324 function wfArrayInsertAfter( array $array, array $insert, $after ) {
325 // Find the offset of the element to insert after.
326 $keys = array_keys( $array );
327 $offsetByKey = array_flip( $keys );
329 $offset = $offsetByKey[$after];
331 // Insert at the specified offset
332 $before = array_slice( $array, 0, $offset +
1, true );
333 $after = array_slice( $array, $offset +
1, count( $array ) - $offset, true );
335 $output = $before +
$insert +
$after;
341 * Recursively converts the parameter (an object) to an array with the same data
343 * @param object|array $objOrArray
344 * @param bool $recursive
347 function wfObjectToArray( $objOrArray, $recursive = true ) {
349 if ( is_object( $objOrArray ) ) {
350 $objOrArray = get_object_vars( $objOrArray );
352 foreach ( $objOrArray as $key => $value ) {
353 if ( $recursive && ( is_object( $value ) ||
is_array( $value ) ) ) {
354 $value = wfObjectToArray( $value );
357 $array[$key] = $value;
364 * Get a random decimal value between 0 and 1, in a way
365 * not likely to give duplicate values for any realistic
366 * number of articles.
370 function wfRandom() {
371 # The maximum random value is "only" 2^31-1, so get two random
372 # values to reduce the chance of dupes
373 $max = mt_getrandmax() +
1;
374 $rand = number_format( ( mt_rand() * $max +
mt_rand() ) / $max / $max, 12, '.', '' );
380 * Get a random string containing a number of pseudo-random hex
382 * @note This is not secure, if you are trying to generate some sort
383 * of token please use MWCryptRand instead.
385 * @param int $length The length of the string to generate
389 function wfRandomString( $length = 32 ) {
391 for ( $n = 0; $n < $length; $n +
= 7 ) {
392 $str .= sprintf( '%07x', mt_rand() & 0xfffffff );
394 return substr( $str, 0, $length );
398 * We want some things to be included as literal characters in our title URLs
399 * for prettiness, which urlencode encodes by default. According to RFC 1738,
400 * all of the following should be safe:
404 * But + is not safe because it's used to indicate a space; &= are only safe in
405 * paths and not in queries (and we don't distinguish here); ' seems kind of
406 * scary; and urlencode() doesn't touch -_. to begin with. Plus, although /
407 * is reserved, we don't care. So the list we unescape is:
411 * However, IIS7 redirects fail when the url contains a colon (Bug 22709),
412 * so no fancy : for IIS7.
414 * %2F in the page titles seems to fatally break for some reason.
419 function wfUrlencode( $s ) {
422 if ( is_null( $s ) ) {
427 if ( is_null( $needle ) ) {
428 $needle = array( '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F' );
429 if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) ||
430 ( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false )
436 $s = urlencode( $s );
439 array( ';', '@', '$', '!', '*', '(', ')', ',', '/', ':' ),
447 * This function takes two arrays as input, and returns a CGI-style string, e.g.
448 * "days=7&limit=100". Options in the first array override options in the second.
449 * Options set to null or false will not be output.
451 * @param array $array1 ( String|Array )
452 * @param array $array2 ( String|Array )
453 * @param string $prefix
456 function wfArrayToCgi( $array1, $array2 = null, $prefix = '' ) {
457 if ( !is_null( $array2 ) ) {
458 $array1 = $array1 +
$array2;
462 foreach ( $array1 as $key => $value ) {
463 if ( !is_null( $value ) && $value !== false ) {
467 if ( $prefix !== '' ) {
468 $key = $prefix . "[$key]";
470 if ( is_array( $value ) ) {
472 foreach ( $value as $k => $v ) {
473 $cgi .= $firstTime ?
'' : '&';
474 if ( is_array( $v ) ) {
475 $cgi .= wfArrayToCgi( $v, null, $key . "[$k]" );
477 $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v );
482 if ( is_object( $value ) ) {
483 $value = $value->__toString();
485 $cgi .= urlencode( $key ) . '=' . urlencode( $value );
493 * This is the logical opposite of wfArrayToCgi(): it accepts a query string as
494 * its argument and returns the same string in array form. This allows compatibility
495 * with legacy functions that accept raw query strings instead of nice
496 * arrays. Of course, keys and values are urldecode()d.
498 * @param string $query Query string
499 * @return string[] Array version of input
501 function wfCgiToArray( $query ) {
502 if ( isset( $query[0] ) && $query[0] == '?' ) {
503 $query = substr( $query, 1 );
505 $bits = explode( '&', $query );
507 foreach ( $bits as $bit ) {
511 if ( strpos( $bit, '=' ) === false ) {
512 // Pieces like &qwerty become 'qwerty' => '' (at least this is what php does)
516 list( $key, $value ) = explode( '=', $bit );
518 $key = urldecode( $key );
519 $value = urldecode( $value );
520 if ( strpos( $key, '[' ) !== false ) {
521 $keys = array_reverse( explode( '[', $key ) );
522 $key = array_pop( $keys );
524 foreach ( $keys as $k ) {
525 $k = substr( $k, 0, -1 );
526 $temp = array( $k => $temp );
528 if ( isset( $ret[$key] ) ) {
529 $ret[$key] = array_merge( $ret[$key], $temp );
541 * Append a query string to an existing URL, which may or may not already
542 * have query string parameters already. If so, they will be combined.
545 * @param string|string[] $query String or associative array
548 function wfAppendQuery( $url, $query ) {
549 if ( is_array( $query ) ) {
550 $query = wfArrayToCgi( $query );
552 if ( $query != '' ) {
553 if ( false === strpos( $url, '?' ) ) {
564 * Expand a potentially local URL to a fully-qualified URL. Assumes $wgServer
567 * The meaning of the PROTO_* constants is as follows:
568 * PROTO_HTTP: Output a URL starting with http://
569 * PROTO_HTTPS: Output a URL starting with https://
570 * PROTO_RELATIVE: Output a URL starting with // (protocol-relative URL)
571 * PROTO_CURRENT: Output a URL starting with either http:// or https:// , depending
572 * on which protocol was used for the current incoming request
573 * PROTO_CANONICAL: For URLs without a domain, like /w/index.php , use $wgCanonicalServer.
574 * For protocol-relative URLs, use the protocol of $wgCanonicalServer
575 * PROTO_INTERNAL: Like PROTO_CANONICAL, but uses $wgInternalServer instead of $wgCanonicalServer
577 * @todo this won't work with current-path-relative URLs
578 * like "subdir/foo.html", etc.
580 * @param string $url Either fully-qualified or a local path + query
581 * @param string $defaultProto One of the PROTO_* constants. Determines the
582 * protocol to use if $url or $wgServer is protocol-relative
583 * @return string Fully-qualified URL, current-path-relative URL or false if
584 * no valid URL can be constructed
586 function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT
) {
587 global $wgServer, $wgCanonicalServer, $wgInternalServer, $wgRequest,
589 if ( $defaultProto === PROTO_CANONICAL
) {
590 $serverUrl = $wgCanonicalServer;
591 } elseif ( $defaultProto === PROTO_INTERNAL
&& $wgInternalServer !== false ) {
592 // Make $wgInternalServer fall back to $wgServer if not set
593 $serverUrl = $wgInternalServer;
595 $serverUrl = $wgServer;
596 if ( $defaultProto === PROTO_CURRENT
) {
597 $defaultProto = $wgRequest->getProtocol() . '://';
601 // Analyze $serverUrl to obtain its protocol
602 $bits = wfParseUrl( $serverUrl );
603 $serverHasProto = $bits && $bits['scheme'] != '';
605 if ( $defaultProto === PROTO_CANONICAL ||
$defaultProto === PROTO_INTERNAL
) {
606 if ( $serverHasProto ) {
607 $defaultProto = $bits['scheme'] . '://';
609 // $wgCanonicalServer or $wgInternalServer doesn't have a protocol.
610 // This really isn't supposed to happen. Fall back to HTTP in this
612 $defaultProto = PROTO_HTTP
;
616 $defaultProtoWithoutSlashes = substr( $defaultProto, 0, -2 );
618 if ( substr( $url, 0, 2 ) == '//' ) {
619 $url = $defaultProtoWithoutSlashes . $url;
620 } elseif ( substr( $url, 0, 1 ) == '/' ) {
621 // If $serverUrl is protocol-relative, prepend $defaultProtoWithoutSlashes,
622 // otherwise leave it alone.
623 $url = ( $serverHasProto ?
'' : $defaultProtoWithoutSlashes ) . $serverUrl . $url;
626 $bits = wfParseUrl( $url );
628 // ensure proper port for HTTPS arrives in URL
629 // https://bugzilla.wikimedia.org/show_bug.cgi?id=65184
630 if ( $defaultProto === PROTO_HTTPS
&& $wgHttpsPort != 443 ) {
631 $bits['port'] = $wgHttpsPort;
634 if ( $bits && isset( $bits['path'] ) ) {
635 $bits['path'] = wfRemoveDotSegments( $bits['path'] );
636 return wfAssembleUrl( $bits );
640 } elseif ( substr( $url, 0, 1 ) != '/' ) {
641 # URL is a relative path
642 return wfRemoveDotSegments( $url );
645 # Expanded URL is not valid.
650 * This function will reassemble a URL parsed with wfParseURL. This is useful
651 * if you need to edit part of a URL and put it back together.
653 * This is the basic structure used (brackets contain keys for $urlParts):
654 * [scheme][delimiter][user]:[pass]@[host]:[port][path]?[query]#[fragment]
656 * @todo Need to integrate this into wfExpandUrl (bug 32168)
659 * @param array $urlParts URL parts, as output from wfParseUrl
660 * @return string URL assembled from its component parts
662 function wfAssembleUrl( $urlParts ) {
665 if ( isset( $urlParts['delimiter'] ) ) {
666 if ( isset( $urlParts['scheme'] ) ) {
667 $result .= $urlParts['scheme'];
670 $result .= $urlParts['delimiter'];
673 if ( isset( $urlParts['host'] ) ) {
674 if ( isset( $urlParts['user'] ) ) {
675 $result .= $urlParts['user'];
676 if ( isset( $urlParts['pass'] ) ) {
677 $result .= ':' . $urlParts['pass'];
682 $result .= $urlParts['host'];
684 if ( isset( $urlParts['port'] ) ) {
685 $result .= ':' . $urlParts['port'];
689 if ( isset( $urlParts['path'] ) ) {
690 $result .= $urlParts['path'];
693 if ( isset( $urlParts['query'] ) ) {
694 $result .= '?' . $urlParts['query'];
697 if ( isset( $urlParts['fragment'] ) ) {
698 $result .= '#' . $urlParts['fragment'];
705 * Remove all dot-segments in the provided URL path. For example,
706 * '/a/./b/../c/' becomes '/a/c/'. For details on the algorithm, please see
707 * RFC3986 section 5.2.4.
709 * @todo Need to integrate this into wfExpandUrl (bug 32168)
711 * @param string $urlPath URL path, potentially containing dot-segments
712 * @return string URL path with all dot-segments removed
714 function wfRemoveDotSegments( $urlPath ) {
717 $inputLength = strlen( $urlPath );
719 while ( $inputOffset < $inputLength ) {
720 $prefixLengthOne = substr( $urlPath, $inputOffset, 1 );
721 $prefixLengthTwo = substr( $urlPath, $inputOffset, 2 );
722 $prefixLengthThree = substr( $urlPath, $inputOffset, 3 );
723 $prefixLengthFour = substr( $urlPath, $inputOffset, 4 );
726 if ( $prefixLengthTwo == './' ) {
727 # Step A, remove leading "./"
729 } elseif ( $prefixLengthThree == '../' ) {
730 # Step A, remove leading "../"
732 } elseif ( ( $prefixLengthTwo == '/.' ) && ( $inputOffset +
2 == $inputLength ) ) {
733 # Step B, replace leading "/.$" with "/"
735 $urlPath[$inputOffset] = '/';
736 } elseif ( $prefixLengthThree == '/./' ) {
737 # Step B, replace leading "/./" with "/"
739 } elseif ( $prefixLengthThree == '/..' && ( $inputOffset +
3 == $inputLength ) ) {
740 # Step C, replace leading "/..$" with "/" and
741 # remove last path component in output
743 $urlPath[$inputOffset] = '/';
745 } elseif ( $prefixLengthFour == '/../' ) {
746 # Step C, replace leading "/../" with "/" and
747 # remove last path component in output
750 } elseif ( ( $prefixLengthOne == '.' ) && ( $inputOffset +
1 == $inputLength ) ) {
751 # Step D, remove "^.$"
753 } elseif ( ( $prefixLengthTwo == '..' ) && ( $inputOffset +
2 == $inputLength ) ) {
754 # Step D, remove "^..$"
757 # Step E, move leading path segment to output
758 if ( $prefixLengthOne == '/' ) {
759 $slashPos = strpos( $urlPath, '/', $inputOffset +
1 );
761 $slashPos = strpos( $urlPath, '/', $inputOffset );
763 if ( $slashPos === false ) {
764 $output .= substr( $urlPath, $inputOffset );
765 $inputOffset = $inputLength;
767 $output .= substr( $urlPath, $inputOffset, $slashPos - $inputOffset );
768 $inputOffset +
= $slashPos - $inputOffset;
773 $slashPos = strrpos( $output, '/' );
774 if ( $slashPos === false ) {
777 $output = substr( $output, 0, $slashPos );
786 * Returns a regular expression of url protocols
788 * @param bool $includeProtocolRelative If false, remove '//' from the returned protocol list.
789 * DO NOT USE this directly, use wfUrlProtocolsWithoutProtRel() instead
792 function wfUrlProtocols( $includeProtocolRelative = true ) {
793 global $wgUrlProtocols;
795 // Cache return values separately based on $includeProtocolRelative
796 static $withProtRel = null, $withoutProtRel = null;
797 $cachedValue = $includeProtocolRelative ?
$withProtRel : $withoutProtRel;
798 if ( !is_null( $cachedValue ) ) {
802 // Support old-style $wgUrlProtocols strings, for backwards compatibility
803 // with LocalSettings files from 1.5
804 if ( is_array( $wgUrlProtocols ) ) {
805 $protocols = array();
806 foreach ( $wgUrlProtocols as $protocol ) {
807 // Filter out '//' if !$includeProtocolRelative
808 if ( $includeProtocolRelative ||
$protocol !== '//' ) {
809 $protocols[] = preg_quote( $protocol, '/' );
813 $retval = implode( '|', $protocols );
815 // Ignore $includeProtocolRelative in this case
816 // This case exists for pre-1.6 compatibility, and we can safely assume
817 // that '//' won't appear in a pre-1.6 config because protocol-relative
818 // URLs weren't supported until 1.18
819 $retval = $wgUrlProtocols;
822 // Cache return value
823 if ( $includeProtocolRelative ) {
824 $withProtRel = $retval;
826 $withoutProtRel = $retval;
832 * Like wfUrlProtocols(), but excludes '//' from the protocol list. Use this if
833 * you need a regex that matches all URL protocols but does not match protocol-
837 function wfUrlProtocolsWithoutProtRel() {
838 return wfUrlProtocols( false );
842 * parse_url() work-alike, but non-broken. Differences:
844 * 1) Does not raise warnings on bad URLs (just returns false).
845 * 2) Handles protocols that don't use :// (e.g., mailto: and news:, as well as
846 * protocol-relative URLs) correctly.
847 * 3) Adds a "delimiter" element to the array, either '://', ':' or '//' (see (2)).
849 * @param string $url A URL to parse
850 * @return string[] Bits of the URL in an associative array, per PHP docs
852 function wfParseUrl( $url ) {
853 global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
855 // Protocol-relative URLs are handled really badly by parse_url(). It's so
856 // bad that the easiest way to handle them is to just prepend 'http:' and
857 // strip the protocol out later.
858 $wasRelative = substr( $url, 0, 2 ) == '//';
859 if ( $wasRelative ) {
862 wfSuppressWarnings();
863 $bits = parse_url( $url );
865 // parse_url() returns an array without scheme for some invalid URLs, e.g.
866 // parse_url("%0Ahttp://example.com") == array( 'host' => '%0Ahttp', 'path' => 'example.com' )
867 if ( !$bits ||
!isset( $bits['scheme'] ) ) {
871 // parse_url() incorrectly handles schemes case-sensitively. Convert it to lowercase.
872 $bits['scheme'] = strtolower( $bits['scheme'] );
874 // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
875 if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
876 $bits['delimiter'] = '://';
877 } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
878 $bits['delimiter'] = ':';
879 // parse_url detects for news: and mailto: the host part of an url as path
880 // We have to correct this wrong detection
881 if ( isset( $bits['path'] ) ) {
882 $bits['host'] = $bits['path'];
889 /* Provide an empty host for eg. file:/// urls (see bug 28627) */
890 if ( !isset( $bits['host'] ) ) {
894 if ( isset( $bits['path'] ) ) {
895 /* parse_url loses the third / for file:///c:/ urls (but not on variants) */
896 if ( substr( $bits['path'], 0, 1 ) !== '/' ) {
897 $bits['path'] = '/' . $bits['path'];
904 // If the URL was protocol-relative, fix scheme and delimiter
905 if ( $wasRelative ) {
906 $bits['scheme'] = '';
907 $bits['delimiter'] = '//';
913 * Take a URL, make sure it's expanded to fully qualified, and replace any
914 * encoded non-ASCII Unicode characters with their UTF-8 original forms
915 * for more compact display and legibility for local audiences.
917 * @todo handle punycode domains too
922 function wfExpandIRI( $url ) {
923 return preg_replace_callback(
924 '/((?:%[89A-F][0-9A-F])+)/i',
925 'wfExpandIRI_callback',
931 * Private callback for wfExpandIRI
932 * @param array $matches
935 function wfExpandIRI_callback( $matches ) {
936 return urldecode( $matches[1] );
940 * Make URL indexes, appropriate for the el_index field of externallinks.
945 function wfMakeUrlIndexes( $url ) {
946 $bits = wfParseUrl( $url );
948 // Reverse the labels in the hostname, convert to lower case
949 // For emails reverse domainpart only
950 if ( $bits['scheme'] == 'mailto' ) {
951 $mailparts = explode( '@', $bits['host'], 2 );
952 if ( count( $mailparts ) === 2 ) {
953 $domainpart = strtolower( implode( '.', array_reverse( explode( '.', $mailparts[1] ) ) ) );
955 // No domain specified, don't mangle it
958 $reversedHost = $domainpart . '@' . $mailparts[0];
960 $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) );
962 // Add an extra dot to the end
963 // Why? Is it in wrong place in mailto links?
964 if ( substr( $reversedHost, -1, 1 ) !== '.' ) {
965 $reversedHost .= '.';
967 // Reconstruct the pseudo-URL
968 $prot = $bits['scheme'];
969 $index = $prot . $bits['delimiter'] . $reversedHost;
970 // Leave out user and password. Add the port, path, query and fragment
971 if ( isset( $bits['port'] ) ) {
972 $index .= ':' . $bits['port'];
974 if ( isset( $bits['path'] ) ) {
975 $index .= $bits['path'];
979 if ( isset( $bits['query'] ) ) {
980 $index .= '?' . $bits['query'];
982 if ( isset( $bits['fragment'] ) ) {
983 $index .= '#' . $bits['fragment'];
987 return array( "http:$index", "https:$index" );
989 return array( $index );
994 * Check whether a given URL has a domain that occurs in a given set of domains
995 * @param string $url URL
996 * @param array $domains Array of domains (strings)
997 * @return bool True if the host part of $url ends in one of the strings in $domains
999 function wfMatchesDomainList( $url, $domains ) {
1000 $bits = wfParseUrl( $url );
1001 if ( is_array( $bits ) && isset( $bits['host'] ) ) {
1002 $host = '.' . $bits['host'];
1003 foreach ( (array)$domains as $domain ) {
1004 $domain = '.' . $domain;
1005 if ( substr( $host, -strlen( $domain ) ) === $domain ) {
1014 * Sends a line to the debug log if enabled or, optionally, to a comment in output.
1015 * In normal operation this is a NOP.
1017 * Controlling globals:
1018 * $wgDebugLogFile - points to the log file
1019 * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
1020 * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
1022 * @since 1.25 support for additional context data
1024 * @param string $text
1025 * @param string|bool $dest Unused
1026 * @param array $context Additional logging context data
1028 function wfDebug( $text, $dest = 'all', array $context = array() ) {
1029 global $wgDebugRawPage, $wgDebugLogPrefix;
1030 global $wgDebugTimestamps, $wgRequestTime;
1032 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1036 $text = trim( $text );
1038 // Inline logic from deprecated wfDebugTimer()
1039 if ( $wgDebugTimestamps ) {
1040 $context['seconds_elapsed'] = sprintf(
1042 microtime( true ) - $wgRequestTime
1044 $context['memory_used'] = sprintf(
1046 ( memory_get_usage( true ) / ( 1024 * 1024 ) )
1050 if ( $wgDebugLogPrefix !== '' ) {
1051 $context['prefix'] = $wgDebugLogPrefix;
1054 $logger = MWLoggerFactory
::getInstance( 'wfDebug' );
1055 $logger->debug( $text, $context );
1059 * Returns true if debug logging should be suppressed if $wgDebugRawPage = false
1062 function wfIsDebugRawPage() {
1064 if ( $cache !== null ) {
1067 # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
1068 if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
1070 isset( $_SERVER['SCRIPT_NAME'] )
1071 && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
1082 * Get microsecond timestamps for debug logs
1084 * @deprecated since 1.25
1087 function wfDebugTimer() {
1088 global $wgDebugTimestamps, $wgRequestTime;
1090 wfDeprecated( __METHOD__
, '1.25' );
1092 if ( !$wgDebugTimestamps ) {
1096 $prefix = sprintf( "%6.4f", microtime( true ) - $wgRequestTime );
1097 $mem = sprintf( "%5.1fM", ( memory_get_usage( true ) / ( 1024 * 1024 ) ) );
1098 return "$prefix $mem ";
1102 * Send a line giving PHP memory usage.
1104 * @param bool $exact Print exact byte values instead of kibibytes (default: false)
1106 function wfDebugMem( $exact = false ) {
1107 $mem = memory_get_usage();
1109 $mem = floor( $mem / 1024 ) . ' KiB';
1113 wfDebug( "Memory usage: $mem\n" );
1117 * Send a line to a supplementary debug log file, if configured, or main debug
1120 * To configure a supplementary log file, set $wgDebugLogGroups[$logGroup] to
1121 * a string filename or an associative array mapping 'destination' to the
1122 * desired filename. The associative array may also contain a 'sample' key
1123 * with an integer value, specifying a sampling factor. Sampled log events
1124 * will be emitted with a 1 in N random chance.
1126 * @since 1.23 support for sampling log messages via $wgDebugLogGroups.
1127 * @since 1.25 support for additional context data
1128 * @since 1.25 sample behavior dependent on configured $wgMWLoggerDefaultSpi
1130 * @param string $logGroup
1131 * @param string $text
1132 * @param string|bool $dest Destination of the message:
1133 * - 'all': both to the log and HTML (debug toolbar or HTML comments)
1134 * - 'log': only to the log and not in HTML
1135 * - 'private': only to the specific log if set in $wgDebugLogGroups and
1136 * discarded otherwise
1137 * For backward compatibility, it can also take a boolean:
1138 * - true: same as 'all'
1139 * - false: same as 'private'
1140 * @param array $context Additional logging context data
1142 function wfDebugLog(
1143 $logGroup, $text, $dest = 'all', array $context = array()
1145 // Turn $dest into a string if it's a boolean (for b/c)
1146 if ( $dest === true ) {
1148 } elseif ( $dest === false ) {
1152 $text = trim( $text );
1154 $logger = MWLoggerFactory
::getInstance( $logGroup );
1155 $context['private'] = ( $dest === 'private' );
1156 $logger->info( $text, $context );
1160 * Log for database errors
1162 * @since 1.25 support for additional context data
1164 * @param string $text Database error message.
1165 * @param array $context Additional logging context data
1167 function wfLogDBError( $text, array $context = array() ) {
1168 $logger = MWLoggerFactory
::getInstance( 'wfLogDBError' );
1169 $logger->error( trim( $text ), $context );
1173 * Throws a warning that $function is deprecated
1175 * @param string $function
1176 * @param string|bool $version Version of MediaWiki that the function
1177 * was deprecated in (Added in 1.19).
1178 * @param string|bool $component Added in 1.19.
1179 * @param int $callerOffset How far up the call stack is the original
1180 * caller. 2 = function that called the function that called
1181 * wfDeprecated (Added in 1.20)
1185 function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) {
1186 MWDebug
::deprecated( $function, $version, $component, $callerOffset +
1 );
1190 * Send a warning either to the debug log or in a PHP error depending on
1191 * $wgDevelopmentWarnings. To log warnings in production, use wfLogWarning() instead.
1193 * @param string $msg Message to send
1194 * @param int $callerOffset Number of items to go back in the backtrace to
1195 * find the correct caller (1 = function calling wfWarn, ...)
1196 * @param int $level PHP error level; defaults to E_USER_NOTICE;
1197 * only used when $wgDevelopmentWarnings is true
1199 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE
) {
1200 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'auto' );
1204 * Send a warning as a PHP error and the debug log. This is intended for logging
1205 * warnings in production. For logging development warnings, use WfWarn instead.
1207 * @param string $msg Message to send
1208 * @param int $callerOffset Number of items to go back in the backtrace to
1209 * find the correct caller (1 = function calling wfLogWarning, ...)
1210 * @param int $level PHP error level; defaults to E_USER_WARNING
1212 function wfLogWarning( $msg, $callerOffset = 1, $level = E_USER_WARNING
) {
1213 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'production' );
1217 * Log to a file without getting "file size exceeded" signals.
1219 * Can also log to TCP or UDP with the syntax udp://host:port/prefix. This will
1220 * send lines to the specified port, prefixed by the specified prefix and a space.
1221 * @since 1.25 support for additional context data
1223 * @param string $text
1224 * @param string $file Filename
1225 * @param array $context Additional logging context data
1226 * @throws MWException
1227 * @deprecated since 1.25 Use MWLoggerLegacyLogger::emit or UDPTransport
1229 function wfErrorLog( $text, $file, array $context = array() ) {
1230 wfDeprecated( __METHOD__
, '1.25' );
1231 $logger = MWLoggerFactory
::getInstance( 'wfErrorLog' );
1232 $context['destination'] = $file;
1233 $logger->info( trim( $text ), $context );
1239 function wfLogProfilingData() {
1240 global $wgRequestTime, $wgDebugLogGroups, $wgDebugRawPage;
1241 global $wgProfileLimit, $wgUser, $wgRequest;
1243 $context = RequestContext
::getMain();
1244 $config = $context->getConfig();
1245 if ( $config->has( 'StatsdServer' ) ) {
1246 $statsdServer = explode( ':', $config->get( 'StatsdServer' ) );
1247 $statsdHost = $statsdServer[0];
1248 $statsdPort = isset( $statsdServer[1] ) ?
$statsdServer[1] : 8125;
1249 $statsdSender = new SocketSender( $statsdHost, $statsdPort );
1250 $statsdClient = new StatsdClient( $statsdSender );
1251 $statsdClient->send( $context->getStats()->getBuffer() );
1254 $profiler = Profiler
::instance();
1256 # Profiling must actually be enabled...
1257 if ( $profiler instanceof ProfilerStub
) {
1261 // Get total page request time and only show pages that longer than
1262 // $wgProfileLimit time (default is 0)
1263 $elapsed = microtime( true ) - $wgRequestTime;
1264 if ( $elapsed <= $wgProfileLimit ) {
1268 $profiler->logData();
1270 if ( isset( $wgDebugLogGroups['profileoutput'] )
1271 && $wgDebugLogGroups['profileoutput'] === false
1273 // Explicitly disabled
1276 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1280 $ctx = array( 'elapsed' => $elapsed );
1281 if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1282 $ctx['forwarded_for'] = $_SERVER['HTTP_X_FORWARDED_FOR'];
1284 if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1285 $ctx['client_ip'] = $_SERVER['HTTP_CLIENT_IP'];
1287 if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1288 $ctx['from'] = $_SERVER['HTTP_FROM'];
1290 if ( isset( $ctx['forwarded_for'] ) ||
1291 isset( $ctx['client_ip'] ) ||
1292 isset( $ctx['from'] ) ) {
1293 $ctx['proxy'] = $_SERVER['REMOTE_ADDR'];
1296 // Don't load $wgUser at this late stage just for statistics purposes
1297 // @todo FIXME: We can detect some anons even if it is not loaded.
1298 // See User::getId()
1299 if ( $wgUser->isItemLoaded( 'id' ) && $wgUser->isAnon() ) {
1300 $ctx['anon'] = true;
1302 $ctx['anon'] = false;
1305 // Command line script uses a FauxRequest object which does not have
1306 // any knowledge about an URL and throw an exception instead.
1308 $ctx['url'] = urldecode( $wgRequest->getRequestURL() );
1309 } catch ( Exception
$ignored ) {
1313 $ctx['output'] = $profiler->getOutput();
1315 $log = MWLoggerFactory
::getInstance( 'profileoutput' );
1316 $log->info( "Elapsed: {elapsed}; URL: <{url}>\n{output}", $ctx );
1320 * Increment a statistics counter
1322 * @param string $key
1326 function wfIncrStats( $key, $count = 1 ) {
1327 $stats = RequestContext
::getMain()->getStats();
1328 $stats->updateCount( $key, $count );
1332 * Check whether the wiki is in read-only mode.
1336 function wfReadOnly() {
1337 return wfReadOnlyReason() !== false;
1341 * Get the value of $wgReadOnly or the contents of $wgReadOnlyFile.
1343 * @return string|bool String when in read-only mode; false otherwise
1345 function wfReadOnlyReason() {
1346 global $wgReadOnly, $wgReadOnlyFile;
1348 if ( $wgReadOnly === null ) {
1349 // Set $wgReadOnly for faster access next time
1350 if ( is_file( $wgReadOnlyFile ) && filesize( $wgReadOnlyFile ) > 0 ) {
1351 $wgReadOnly = file_get_contents( $wgReadOnlyFile );
1353 $wgReadOnly = false;
1361 * Return a Language object from $langcode
1363 * @param Language|string|bool $langcode Either:
1364 * - a Language object
1365 * - code of the language to get the message for, if it is
1366 * a valid code create a language for that language, if
1367 * it is a string but not a valid code then make a basic
1369 * - a boolean: if it's false then use the global object for
1370 * the current user's language (as a fallback for the old parameter
1371 * functionality), or if it is true then use global object
1372 * for the wiki's content language.
1375 function wfGetLangObj( $langcode = false ) {
1376 # Identify which language to get or create a language object for.
1377 # Using is_object here due to Stub objects.
1378 if ( is_object( $langcode ) ) {
1379 # Great, we already have the object (hopefully)!
1383 global $wgContLang, $wgLanguageCode;
1384 if ( $langcode === true ||
$langcode === $wgLanguageCode ) {
1385 # $langcode is the language code of the wikis content language object.
1386 # or it is a boolean and value is true
1391 if ( $langcode === false ||
$langcode === $wgLang->getCode() ) {
1392 # $langcode is the language code of user language object.
1393 # or it was a boolean and value is false
1397 $validCodes = array_keys( Language
::fetchLanguageNames() );
1398 if ( in_array( $langcode, $validCodes ) ) {
1399 # $langcode corresponds to a valid language.
1400 return Language
::factory( $langcode );
1403 # $langcode is a string, but not a valid language code; use content language.
1404 wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1409 * This is the function for getting translated interface messages.
1411 * @see Message class for documentation how to use them.
1412 * @see https://www.mediawiki.org/wiki/Manual:Messages_API
1414 * This function replaces all old wfMsg* functions.
1416 * @param string|string[] $key Message key, or array of keys
1417 * @param mixed $params,... Normal message parameters
1422 * @see Message::__construct
1424 function wfMessage( $key /*...*/ ) {
1425 $params = func_get_args();
1426 array_shift( $params );
1427 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
1428 $params = $params[0];
1430 return new Message( $key, $params );
1434 * This function accepts multiple message keys and returns a message instance
1435 * for the first message which is non-empty. If all messages are empty then an
1436 * instance of the first message key is returned.
1438 * @param string|string[] $keys,... Message keys
1443 * @see Message::newFallbackSequence
1445 function wfMessageFallback( /*...*/ ) {
1446 $args = func_get_args();
1447 return call_user_func_array( 'Message::newFallbackSequence', $args );
1451 * Get a message from anywhere, for the current user language.
1453 * Use wfMsgForContent() instead if the message should NOT
1454 * change depending on the user preferences.
1456 * @deprecated since 1.18
1458 * @param string $key Lookup key for the message, usually
1459 * defined in languages/Language.php
1461 * Parameters to the message, which can be used to insert variable text into
1462 * it, can be passed to this function in the following formats:
1463 * - One per argument, starting at the second parameter
1464 * - As an array in the second parameter
1465 * These are not shown in the function definition.
1469 function wfMsg( $key ) {
1470 wfDeprecated( __METHOD__
, '1.21' );
1472 $args = func_get_args();
1473 array_shift( $args );
1474 return wfMsgReal( $key, $args );
1478 * Same as above except doesn't transform the message
1480 * @deprecated since 1.18
1482 * @param string $key
1485 function wfMsgNoTrans( $key ) {
1486 wfDeprecated( __METHOD__
, '1.21' );
1488 $args = func_get_args();
1489 array_shift( $args );
1490 return wfMsgReal( $key, $args, true, false, false );
1494 * Get a message from anywhere, for the current global language
1495 * set with $wgLanguageCode.
1497 * Use this if the message should NOT change dependent on the
1498 * language set in the user's preferences. This is the case for
1499 * most text written into logs, as well as link targets (such as
1500 * the name of the copyright policy page). Link titles, on the
1501 * other hand, should be shown in the UI language.
1503 * Note that MediaWiki allows users to change the user interface
1504 * language in their preferences, but a single installation
1505 * typically only contains content in one language.
1507 * Be wary of this distinction: If you use wfMsg() where you should
1508 * use wfMsgForContent(), a user of the software may have to
1509 * customize potentially hundreds of messages in
1510 * order to, e.g., fix a link in every possible language.
1512 * @deprecated since 1.18
1514 * @param string $key Lookup key for the message, usually
1515 * defined in languages/Language.php
1518 function wfMsgForContent( $key ) {
1519 wfDeprecated( __METHOD__
, '1.21' );
1521 global $wgForceUIMsgAsContentMsg;
1522 $args = func_get_args();
1523 array_shift( $args );
1525 if ( is_array( $wgForceUIMsgAsContentMsg )
1526 && in_array( $key, $wgForceUIMsgAsContentMsg )
1528 $forcontent = false;
1530 return wfMsgReal( $key, $args, true, $forcontent );
1534 * Same as above except doesn't transform the message
1536 * @deprecated since 1.18
1538 * @param string $key
1541 function wfMsgForContentNoTrans( $key ) {
1542 wfDeprecated( __METHOD__
, '1.21' );
1544 global $wgForceUIMsgAsContentMsg;
1545 $args = func_get_args();
1546 array_shift( $args );
1548 if ( is_array( $wgForceUIMsgAsContentMsg )
1549 && in_array( $key, $wgForceUIMsgAsContentMsg )
1551 $forcontent = false;
1553 return wfMsgReal( $key, $args, true, $forcontent, false );
1557 * Really get a message
1559 * @deprecated since 1.18
1561 * @param string $key Key to get.
1562 * @param array $args
1563 * @param bool $useDB
1564 * @param string|bool $forContent Language code, or false for user lang, true for content lang.
1565 * @param bool $transform Whether or not to transform the message.
1566 * @return string The requested message.
1568 function wfMsgReal( $key, $args, $useDB = true, $forContent = false, $transform = true ) {
1569 wfDeprecated( __METHOD__
, '1.21' );
1571 $message = wfMsgGetKey( $key, $useDB, $forContent, $transform );
1572 $message = wfMsgReplaceArgs( $message, $args );
1577 * Fetch a message string value, but don't replace any keys yet.
1579 * @deprecated since 1.18
1581 * @param string $key
1582 * @param bool $useDB
1583 * @param string|bool $langCode Code of the language to get the message for, or
1584 * behaves as a content language switch if it is a boolean.
1585 * @param bool $transform Whether to parse magic words, etc.
1588 function wfMsgGetKey( $key, $useDB = true, $langCode = false, $transform = true ) {
1589 wfDeprecated( __METHOD__
, '1.21' );
1591 Hooks
::run( 'NormalizeMessageKey', array( &$key, &$useDB, &$langCode, &$transform ) );
1593 $cache = MessageCache
::singleton();
1594 $message = $cache->get( $key, $useDB, $langCode );
1595 if ( $message === false ) {
1596 $message = '<' . htmlspecialchars( $key ) . '>';
1597 } elseif ( $transform ) {
1598 $message = $cache->transform( $message );
1604 * Replace message parameter keys on the given formatted output.
1606 * @param string $message
1607 * @param array $args
1611 function wfMsgReplaceArgs( $message, $args ) {
1612 # Fix windows line-endings
1613 # Some messages are split with explode("\n", $msg)
1614 $message = str_replace( "\r", '', $message );
1616 // Replace arguments
1617 if ( count( $args ) ) {
1618 if ( is_array( $args[0] ) ) {
1619 $args = array_values( $args[0] );
1621 $replacementKeys = array();
1622 foreach ( $args as $n => $param ) {
1623 $replacementKeys['$' . ( $n +
1 )] = $param;
1625 $message = strtr( $message, $replacementKeys );
1632 * Return an HTML-escaped version of a message.
1633 * Parameter replacements, if any, are done *after* the HTML-escaping,
1634 * so parameters may contain HTML (eg links or form controls). Be sure
1635 * to pre-escape them if you really do want plaintext, or just wrap
1636 * the whole thing in htmlspecialchars().
1638 * @deprecated since 1.18
1640 * @param string $key
1641 * @param string $args,... Parameters
1644 function wfMsgHtml( $key ) {
1645 wfDeprecated( __METHOD__
, '1.21' );
1647 $args = func_get_args();
1648 array_shift( $args );
1649 return wfMsgReplaceArgs( htmlspecialchars( wfMsgGetKey( $key ) ), $args );
1653 * Return an HTML version of message
1654 * Parameter replacements, if any, are done *after* parsing the wiki-text message,
1655 * so parameters may contain HTML (eg links or form controls). Be sure
1656 * to pre-escape them if you really do want plaintext, or just wrap
1657 * the whole thing in htmlspecialchars().
1659 * @deprecated since 1.18
1661 * @param string $key
1662 * @param string $args,... Parameters
1665 function wfMsgWikiHtml( $key ) {
1666 wfDeprecated( __METHOD__
, '1.21' );
1668 $args = func_get_args();
1669 array_shift( $args );
1670 return wfMsgReplaceArgs(
1671 MessageCache
::singleton()->parse( wfMsgGetKey( $key ), null,
1672 /* can't be set to false */ true, /* interface */ true )->getText(),
1677 * Returns message in the requested format
1679 * @deprecated since 1.18
1681 * @param string $key Key of the message
1682 * @param array $options Processing rules.
1683 * Can take the following options:
1684 * parse: parses wikitext to HTML
1685 * parseinline: parses wikitext to HTML and removes the surrounding
1686 * p's added by parser or tidy
1687 * escape: filters message through htmlspecialchars
1688 * escapenoentities: same, but allows entity references like   through
1689 * replaceafter: parameters are substituted after parsing or escaping
1690 * parsemag: transform the message using magic phrases
1691 * content: fetch message for content language instead of interface
1692 * Also can accept a single associative argument, of the form 'language' => 'xx':
1693 * language: Language object or language code to fetch message for
1694 * (overridden by content).
1695 * Behavior for conflicting options (e.g., parse+parseinline) is undefined.
1699 function wfMsgExt( $key, $options ) {
1700 wfDeprecated( __METHOD__
, '1.21' );
1702 $args = func_get_args();
1703 array_shift( $args );
1704 array_shift( $args );
1705 $options = (array)$options;
1706 $validOptions = array( 'parse', 'parseinline', 'escape', 'escapenoentities', 'replaceafter',
1707 'parsemag', 'content' );
1709 foreach ( $options as $arrayKey => $option ) {
1710 if ( !preg_match( '/^[0-9]+|language$/', $arrayKey ) ) {
1711 // An unknown index, neither numeric nor "language"
1712 wfWarn( "wfMsgExt called with incorrect parameter key $arrayKey", 1, E_USER_WARNING
);
1713 } elseif ( preg_match( '/^[0-9]+$/', $arrayKey ) && !in_array( $option, $validOptions ) ) {
1714 // A numeric index with unknown value
1715 wfWarn( "wfMsgExt called with incorrect parameter $option", 1, E_USER_WARNING
);
1719 if ( in_array( 'content', $options, true ) ) {
1722 $langCodeObj = null;
1723 } elseif ( array_key_exists( 'language', $options ) ) {
1724 $forContent = false;
1725 $langCode = wfGetLangObj( $options['language'] );
1726 $langCodeObj = $langCode;
1728 $forContent = false;
1730 $langCodeObj = null;
1733 $string = wfMsgGetKey( $key, /*DB*/true, $langCode, /*Transform*/false );
1735 if ( !in_array( 'replaceafter', $options, true ) ) {
1736 $string = wfMsgReplaceArgs( $string, $args );
1739 $messageCache = MessageCache
::singleton();
1740 $parseInline = in_array( 'parseinline', $options, true );
1741 if ( in_array( 'parse', $options, true ) ||
$parseInline ) {
1742 $string = $messageCache->parse( $string, null, true, !$forContent, $langCodeObj );
1743 if ( $string instanceof ParserOutput
) {
1744 $string = $string->getText();
1747 if ( $parseInline ) {
1748 $string = Parser
::stripOuterParagraph( $string );
1750 } elseif ( in_array( 'parsemag', $options, true ) ) {
1751 $string = $messageCache->transform( $string,
1752 !$forContent, $langCodeObj );
1755 if ( in_array( 'escape', $options, true ) ) {
1756 $string = htmlspecialchars ( $string );
1757 } elseif ( in_array( 'escapenoentities', $options, true ) ) {
1758 $string = Sanitizer
::escapeHtmlAllowEntities( $string );
1761 if ( in_array( 'replaceafter', $options, true ) ) {
1762 $string = wfMsgReplaceArgs( $string, $args );
1769 * Since wfMsg() and co suck, they don't return false if the message key they
1770 * looked up didn't exist but instead the key wrapped in <>'s, this function checks for the
1771 * nonexistence of messages by checking the MessageCache::get() result directly.
1773 * @deprecated since 1.18. Use Message::isDisabled().
1775 * @param string $key The message key looked up
1776 * @return bool True if the message *doesn't* exist.
1778 function wfEmptyMsg( $key ) {
1779 wfDeprecated( __METHOD__
, '1.21' );
1781 return MessageCache
::singleton()->get( $key, /*useDB*/true, /*content*/false ) === false;
1785 * Fetch server name for use in error reporting etc.
1786 * Use real server name if available, so we know which machine
1787 * in a server farm generated the current page.
1791 function wfHostname() {
1793 if ( is_null( $host ) ) {
1795 # Hostname overriding
1796 global $wgOverrideHostname;
1797 if ( $wgOverrideHostname !== false ) {
1798 # Set static and skip any detection
1799 $host = $wgOverrideHostname;
1803 if ( function_exists( 'posix_uname' ) ) {
1804 // This function not present on Windows
1805 $uname = posix_uname();
1809 if ( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1810 $host = $uname['nodename'];
1811 } elseif ( getenv( 'COMPUTERNAME' ) ) {
1812 # Windows computer name
1813 $host = getenv( 'COMPUTERNAME' );
1815 # This may be a virtual server.
1816 $host = $_SERVER['SERVER_NAME'];
1823 * Returns a script tag that stores the amount of time it took MediaWiki to
1824 * handle the request in milliseconds as 'wgBackendResponseTime'.
1826 * If $wgShowHostnames is true, the script will also set 'wgHostname' to the
1827 * hostname of the server handling the request.
1831 function wfReportTime() {
1832 global $wgRequestTime, $wgShowHostnames;
1834 $responseTime = round( ( microtime( true ) - $wgRequestTime ) * 1000 );
1835 $reportVars = array( 'wgBackendResponseTime' => $responseTime );
1836 if ( $wgShowHostnames ) {
1837 $reportVars['wgHostname'] = wfHostname();
1839 return Skin
::makeVariablesScript( $reportVars );
1843 * Safety wrapper for debug_backtrace().
1845 * Will return an empty array if debug_backtrace is disabled, otherwise
1846 * the output from debug_backtrace() (trimmed).
1848 * @param int $limit This parameter can be used to limit the number of stack frames returned
1850 * @return array Array of backtrace information
1852 function wfDebugBacktrace( $limit = 0 ) {
1853 static $disabled = null;
1855 if ( is_null( $disabled ) ) {
1856 $disabled = !function_exists( 'debug_backtrace' );
1858 wfDebug( "debug_backtrace() is disabled\n" );
1865 if ( $limit && version_compare( PHP_VERSION
, '5.4.0', '>=' ) ) {
1866 return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT
, $limit +
1 ), 1 );
1868 return array_slice( debug_backtrace(), 1 );
1873 * Get a debug backtrace as a string
1875 * @param bool|null $raw If true, the return value is plain text. If false, HTML.
1876 * Defaults to $wgCommandLineMode if unset.
1878 * @since 1.25 Supports $raw parameter.
1880 function wfBacktrace( $raw = null ) {
1881 global $wgCommandLineMode;
1883 if ( $raw === null ) {
1884 $raw = $wgCommandLineMode;
1888 $frameFormat = "%s line %s calls %s()\n";
1889 $traceFormat = "%s";
1891 $frameFormat = "<li>%s line %s calls %s()</li>\n";
1892 $traceFormat = "<ul>\n%s</ul>\n";
1895 $frames = array_map( function ( $frame ) use ( $frameFormat ) {
1896 $file = !empty( $frame['file'] ) ?
basename( $frame['file'] ) : '-';
1897 $line = isset( $frame['line'] ) ?
$frame['line'] : '-';
1898 $call = $frame['function'];
1899 if ( !empty( $frame['class'] ) ) {
1900 $call = $frame['class'] . $frame['type'] . $call;
1902 return sprintf( $frameFormat, $file, $line, $call );
1903 }, wfDebugBacktrace() );
1905 return sprintf( $traceFormat, implode( '', $frames ) );
1909 * Get the name of the function which called this function
1910 * wfGetCaller( 1 ) is the function with the wfGetCaller() call (ie. __FUNCTION__)
1911 * wfGetCaller( 2 ) [default] is the caller of the function running wfGetCaller()
1912 * wfGetCaller( 3 ) is the parent of that.
1917 function wfGetCaller( $level = 2 ) {
1918 $backtrace = wfDebugBacktrace( $level +
1 );
1919 if ( isset( $backtrace[$level] ) ) {
1920 return wfFormatStackFrame( $backtrace[$level] );
1927 * Return a string consisting of callers in the stack. Useful sometimes
1928 * for profiling specific points.
1930 * @param int $limit The maximum depth of the stack frame to return, or false for the entire stack.
1933 function wfGetAllCallers( $limit = 3 ) {
1934 $trace = array_reverse( wfDebugBacktrace() );
1935 if ( !$limit ||
$limit > count( $trace ) - 1 ) {
1936 $limit = count( $trace ) - 1;
1938 $trace = array_slice( $trace, -$limit - 1, $limit );
1939 return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1943 * Return a string representation of frame
1945 * @param array $frame
1948 function wfFormatStackFrame( $frame ) {
1949 return isset( $frame['class'] ) ?
1950 $frame['class'] . '::' . $frame['function'] :
1954 /* Some generic result counters, pulled out of SearchEngine */
1959 * @param int $offset
1963 function wfShowingResults( $offset, $limit ) {
1964 return wfMessage( 'showingresults' )->numParams( $limit, $offset +
1 )->parse();
1969 * @todo FIXME: We may want to blacklist some broken browsers
1971 * @param bool $force
1972 * @return bool Whereas client accept gzip compression
1974 function wfClientAcceptsGzip( $force = false ) {
1975 static $result = null;
1976 if ( $result === null ||
$force ) {
1978 if ( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
1979 # @todo FIXME: We may want to blacklist some broken browsers
1982 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
1983 $_SERVER['HTTP_ACCEPT_ENCODING'],
1987 if ( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
1991 wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
2000 * Obtain the offset and limit values from the request string;
2001 * used in special pages
2003 * @param int $deflimit Default limit if none supplied
2004 * @param string $optionname Name of a user preference to check against
2006 * @deprecated since 1.24, just call WebRequest::getLimitOffset() directly
2008 function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
2010 wfDeprecated( __METHOD__
, '1.24' );
2011 return $wgRequest->getLimitOffset( $deflimit, $optionname );
2015 * Escapes the given text so that it may be output using addWikiText()
2016 * without any linking, formatting, etc. making its way through. This
2017 * is achieved by substituting certain characters with HTML entities.
2018 * As required by the callers, "<nowiki>" is not used.
2020 * @param string $text Text to be escaped
2023 function wfEscapeWikiText( $text ) {
2024 static $repl = null, $repl2 = null;
2025 if ( $repl === null ) {
2027 '"' => '"', '&' => '&', "'" => ''', '<' => '<',
2028 '=' => '=', '>' => '>', '[' => '[', ']' => ']',
2029 '{' => '{', '|' => '|', '}' => '}', ';' => ';',
2030 "\n#" => "\n#", "\r#" => "\r#",
2031 "\n*" => "\n*", "\r*" => "\r*",
2032 "\n:" => "\n:", "\r:" => "\r:",
2033 "\n " => "\n ", "\r " => "\r ",
2034 "\n\n" => "\n ", "\r\n" => " \n",
2035 "\n\r" => "\n ", "\r\r" => "\r ",
2036 "\n\t" => "\n	", "\r\t" => "\r	", // "\n\t\n" is treated like "\n\n"
2037 "\n----" => "\n----", "\r----" => "\r----",
2038 '__' => '__', '://' => '://',
2041 // We have to catch everything "\s" matches in PCRE
2042 foreach ( array( 'ISBN', 'RFC', 'PMID' ) as $magic ) {
2043 $repl["$magic "] = "$magic ";
2044 $repl["$magic\t"] = "$magic	";
2045 $repl["$magic\r"] = "$magic ";
2046 $repl["$magic\n"] = "$magic ";
2047 $repl["$magic\f"] = "$magic";
2050 // And handle protocols that don't use "://"
2051 global $wgUrlProtocols;
2053 foreach ( $wgUrlProtocols as $prot ) {
2054 if ( substr( $prot, -1 ) === ':' ) {
2055 $repl2[] = preg_quote( substr( $prot, 0, -1 ), '/' );
2058 $repl2 = $repl2 ?
'/\b(' . join( '|', $repl2 ) . '):/i' : '/^(?!)/';
2060 $text = substr( strtr( "\n$text", $repl ), 1 );
2061 $text = preg_replace( $repl2, '$1:', $text );
2066 * Sets dest to source and returns the original value of dest
2067 * If source is NULL, it just returns the value, it doesn't set the variable
2068 * If force is true, it will set the value even if source is NULL
2070 * @param mixed $dest
2071 * @param mixed $source
2072 * @param bool $force
2075 function wfSetVar( &$dest, $source, $force = false ) {
2077 if ( !is_null( $source ) ||
$force ) {
2084 * As for wfSetVar except setting a bit
2088 * @param bool $state
2092 function wfSetBit( &$dest, $bit, $state = true ) {
2093 $temp = (bool)( $dest & $bit );
2094 if ( !is_null( $state ) ) {
2105 * A wrapper around the PHP function var_export().
2106 * Either print it or add it to the regular output ($wgOut).
2108 * @param mixed $var A PHP variable to dump.
2110 function wfVarDump( $var ) {
2112 $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
2113 if ( headers_sent() ||
!isset( $wgOut ) ||
!is_object( $wgOut ) ) {
2116 $wgOut->addHTML( $s );
2121 * Provide a simple HTTP error.
2123 * @param int|string $code
2124 * @param string $label
2125 * @param string $desc
2127 function wfHttpError( $code, $label, $desc ) {
2129 header( "HTTP/1.0 $code $label" );
2130 header( "Status: $code $label" );
2133 $wgOut->sendCacheControl();
2136 header( 'Content-type: text/html; charset=utf-8' );
2137 print "<!doctype html>" .
2138 '<html><head><title>' .
2139 htmlspecialchars( $label ) .
2140 '</title></head><body><h1>' .
2141 htmlspecialchars( $label ) .
2143 nl2br( htmlspecialchars( $desc ) ) .
2144 "</p></body></html>\n";
2148 * Clear away any user-level output buffers, discarding contents.
2150 * Suitable for 'starting afresh', for instance when streaming
2151 * relatively large amounts of data without buffering, or wanting to
2152 * output image files without ob_gzhandler's compression.
2154 * The optional $resetGzipEncoding parameter controls suppression of
2155 * the Content-Encoding header sent by ob_gzhandler; by default it
2156 * is left. See comments for wfClearOutputBuffers() for why it would
2159 * Note that some PHP configuration options may add output buffer
2160 * layers which cannot be removed; these are left in place.
2162 * @param bool $resetGzipEncoding
2164 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
2165 if ( $resetGzipEncoding ) {
2166 // Suppress Content-Encoding and Content-Length
2167 // headers from 1.10+s wfOutputHandler
2168 global $wgDisableOutputCompression;
2169 $wgDisableOutputCompression = true;
2171 while ( $status = ob_get_status() ) {
2172 if ( $status['type'] == 0 /* PHP_OUTPUT_HANDLER_INTERNAL */ ) {
2173 // Probably from zlib.output_compression or other
2174 // PHP-internal setting which can't be removed.
2176 // Give up, and hope the result doesn't break
2180 if ( !ob_end_clean() ) {
2181 // Could not remove output buffer handler; abort now
2182 // to avoid getting in some kind of infinite loop.
2185 if ( $resetGzipEncoding ) {
2186 if ( $status['name'] == 'ob_gzhandler' ) {
2187 // Reset the 'Content-Encoding' field set by this handler
2188 // so we can start fresh.
2189 header_remove( 'Content-Encoding' );
2197 * More legible than passing a 'false' parameter to wfResetOutputBuffers():
2199 * Clear away output buffers, but keep the Content-Encoding header
2200 * produced by ob_gzhandler, if any.
2202 * This should be used for HTTP 304 responses, where you need to
2203 * preserve the Content-Encoding header of the real result, but
2204 * also need to suppress the output of ob_gzhandler to keep to spec
2205 * and avoid breaking Firefox in rare cases where the headers and
2206 * body are broken over two packets.
2208 function wfClearOutputBuffers() {
2209 wfResetOutputBuffers( false );
2213 * Converts an Accept-* header into an array mapping string values to quality
2216 * @param string $accept
2217 * @param string $def Default
2218 * @return float[] Associative array of string => float pairs
2220 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
2221 # No arg means accept anything (per HTTP spec)
2223 return array( $def => 1.0 );
2228 $parts = explode( ',', $accept );
2230 foreach ( $parts as $part ) {
2231 # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
2232 $values = explode( ';', trim( $part ) );
2234 if ( count( $values ) == 1 ) {
2235 $prefs[$values[0]] = 1.0;
2236 } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
2237 $prefs[$values[0]] = floatval( $match[1] );
2245 * Checks if a given MIME type matches any of the keys in the given
2246 * array. Basic wildcards are accepted in the array keys.
2248 * Returns the matching MIME type (or wildcard) if a match, otherwise
2251 * @param string $type
2252 * @param array $avail
2256 function mimeTypeMatch( $type, $avail ) {
2257 if ( array_key_exists( $type, $avail ) ) {
2260 $parts = explode( '/', $type );
2261 if ( array_key_exists( $parts[0] . '/*', $avail ) ) {
2262 return $parts[0] . '/*';
2263 } elseif ( array_key_exists( '*/*', $avail ) ) {
2272 * Returns the 'best' match between a client's requested internet media types
2273 * and the server's list of available types. Each list should be an associative
2274 * array of type to preference (preference is a float between 0.0 and 1.0).
2275 * Wildcards in the types are acceptable.
2277 * @param array $cprefs Client's acceptable type list
2278 * @param array $sprefs Server's offered types
2281 * @todo FIXME: Doesn't handle params like 'text/plain; charset=UTF-8'
2282 * XXX: generalize to negotiate other stuff
2284 function wfNegotiateType( $cprefs, $sprefs ) {
2287 foreach ( array_keys( $sprefs ) as $type ) {
2288 $parts = explode( '/', $type );
2289 if ( $parts[1] != '*' ) {
2290 $ckey = mimeTypeMatch( $type, $cprefs );
2292 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
2297 foreach ( array_keys( $cprefs ) as $type ) {
2298 $parts = explode( '/', $type );
2299 if ( $parts[1] != '*' && !array_key_exists( $type, $sprefs ) ) {
2300 $skey = mimeTypeMatch( $type, $sprefs );
2302 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
2310 foreach ( array_keys( $combine ) as $type ) {
2311 if ( $combine[$type] > $bestq ) {
2313 $bestq = $combine[$type];
2321 * Reference-counted warning suppression
2325 function wfSuppressWarnings( $end = false ) {
2326 static $suppressCount = 0;
2327 static $originalLevel = false;
2330 if ( $suppressCount ) {
2332 if ( !$suppressCount ) {
2333 error_reporting( $originalLevel );
2337 if ( !$suppressCount ) {
2338 $originalLevel = error_reporting( E_ALL
& ~
(
2353 * Restore error level to previous value
2355 function wfRestoreWarnings() {
2356 wfSuppressWarnings( true );
2359 # Autodetect, convert and provide timestamps of various types
2362 * Unix time - the number of seconds since 1970-01-01 00:00:00 UTC
2364 define( 'TS_UNIX', 0 );
2367 * MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
2369 define( 'TS_MW', 1 );
2372 * MySQL DATETIME (YYYY-MM-DD HH:MM:SS)
2374 define( 'TS_DB', 2 );
2377 * RFC 2822 format, for E-mail and HTTP headers
2379 define( 'TS_RFC2822', 3 );
2382 * ISO 8601 format with no timezone: 1986-02-09T20:00:00Z
2384 * This is used by Special:Export
2386 define( 'TS_ISO_8601', 4 );
2389 * An Exif timestamp (YYYY:MM:DD HH:MM:SS)
2391 * @see http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the
2392 * DateTime tag and page 36 for the DateTimeOriginal and
2393 * DateTimeDigitized tags.
2395 define( 'TS_EXIF', 5 );
2398 * Oracle format time.
2400 define( 'TS_ORACLE', 6 );
2403 * Postgres format time.
2405 define( 'TS_POSTGRES', 7 );
2408 * ISO 8601 basic format with no timezone: 19860209T200000Z. This is used by ResourceLoader
2410 define( 'TS_ISO_8601_BASIC', 9 );
2413 * Get a timestamp string in one of various formats
2415 * @param mixed $outputtype A timestamp in one of the supported formats, the
2416 * function will autodetect which format is supplied and act accordingly.
2417 * @param mixed $ts Optional timestamp to convert, default 0 for the current time
2418 * @return string|bool String / false The same date in the format specified in $outputtype or false
2420 function wfTimestamp( $outputtype = TS_UNIX
, $ts = 0 ) {
2422 $timestamp = new MWTimestamp( $ts );
2423 return $timestamp->getTimestamp( $outputtype );
2424 } catch ( TimestampException
$e ) {
2425 wfDebug( "wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n" );
2431 * Return a formatted timestamp, or null if input is null.
2432 * For dealing with nullable timestamp columns in the database.
2434 * @param int $outputtype
2438 function wfTimestampOrNull( $outputtype = TS_UNIX
, $ts = null ) {
2439 if ( is_null( $ts ) ) {
2442 return wfTimestamp( $outputtype, $ts );
2447 * Convenience function; returns MediaWiki timestamp for the present time.
2451 function wfTimestampNow() {
2453 return wfTimestamp( TS_MW
, time() );
2457 * Check if the operating system is Windows
2459 * @return bool True if it's Windows, false otherwise.
2461 function wfIsWindows() {
2462 static $isWindows = null;
2463 if ( $isWindows === null ) {
2464 $isWindows = substr( php_uname(), 0, 7 ) == 'Windows';
2470 * Check if we are running under HHVM
2474 function wfIsHHVM() {
2475 return defined( 'HHVM_VERSION' );
2479 * Swap two variables
2481 * @deprecated since 1.24
2485 function swap( &$x, &$y ) {
2486 wfDeprecated( __FUNCTION__
, '1.24' );
2493 * Tries to get the system directory for temporary files. First
2494 * $wgTmpDirectory is checked, and then the TMPDIR, TMP, and TEMP
2495 * environment variables are then checked in sequence, and if none are
2496 * set try sys_get_temp_dir().
2498 * NOTE: When possible, use instead the tmpfile() function to create
2499 * temporary files to avoid race conditions on file creation, etc.
2503 function wfTempDir() {
2504 global $wgTmpDirectory;
2506 if ( $wgTmpDirectory !== false ) {
2507 return $wgTmpDirectory;
2510 $tmpDir = array_map( "getenv", array( 'TMPDIR', 'TMP', 'TEMP' ) );
2512 foreach ( $tmpDir as $tmp ) {
2513 if ( $tmp && file_exists( $tmp ) && is_dir( $tmp ) && is_writable( $tmp ) ) {
2517 return sys_get_temp_dir();
2521 * Make directory, and make all parent directories if they don't exist
2523 * @param string $dir Full path to directory to create
2524 * @param int $mode Chmod value to use, default is $wgDirectoryMode
2525 * @param string $caller Optional caller param for debugging.
2526 * @throws MWException
2529 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2530 global $wgDirectoryMode;
2532 if ( FileBackend
::isStoragePath( $dir ) ) { // sanity
2533 throw new MWException( __FUNCTION__
. " given storage path '$dir'." );
2536 if ( !is_null( $caller ) ) {
2537 wfDebug( "$caller: called wfMkdirParents($dir)\n" );
2540 if ( strval( $dir ) === '' ||
( file_exists( $dir ) && is_dir( $dir ) ) ) {
2544 $dir = str_replace( array( '\\', '/' ), DIRECTORY_SEPARATOR
, $dir );
2546 if ( is_null( $mode ) ) {
2547 $mode = $wgDirectoryMode;
2550 // Turn off the normal warning, we're doing our own below
2551 wfSuppressWarnings();
2552 $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2553 wfRestoreWarnings();
2556 //directory may have been created on another request since we last checked
2557 if ( is_dir( $dir ) ) {
2561 // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2562 wfLogWarning( sprintf( "failed to mkdir \"%s\" mode 0%o", $dir, $mode ) );
2568 * Remove a directory and all its content.
2569 * Does not hide error.
2570 * @param string $dir
2572 function wfRecursiveRemoveDir( $dir ) {
2573 wfDebug( __FUNCTION__
. "( $dir )\n" );
2574 // taken from http://de3.php.net/manual/en/function.rmdir.php#98622
2575 if ( is_dir( $dir ) ) {
2576 $objects = scandir( $dir );
2577 foreach ( $objects as $object ) {
2578 if ( $object != "." && $object != ".." ) {
2579 if ( filetype( $dir . '/' . $object ) == "dir" ) {
2580 wfRecursiveRemoveDir( $dir . '/' . $object );
2582 unlink( $dir . '/' . $object );
2592 * @param int $nr The number to format
2593 * @param int $acc The number of digits after the decimal point, default 2
2594 * @param bool $round Whether or not to round the value, default true
2597 function wfPercent( $nr, $acc = 2, $round = true ) {
2598 $ret = sprintf( "%.${acc}f", $nr );
2599 return $round ?
round( $ret, $acc ) . '%' : "$ret%";
2603 * Safety wrapper around ini_get() for boolean settings.
2604 * The values returned from ini_get() are pre-normalized for settings
2605 * set via php.ini or php_flag/php_admin_flag... but *not*
2606 * for those set via php_value/php_admin_value.
2608 * It's fairly common for people to use php_value instead of php_flag,
2609 * which can leave you with an 'off' setting giving a false positive
2610 * for code that just takes the ini_get() return value as a boolean.
2612 * To make things extra interesting, setting via php_value accepts
2613 * "true" and "yes" as true, but php.ini and php_flag consider them false. :)
2614 * Unrecognized values go false... again opposite PHP's own coercion
2615 * from string to bool.
2617 * Luckily, 'properly' set settings will always come back as '0' or '1',
2618 * so we only have to worry about them and the 'improper' settings.
2620 * I frickin' hate PHP... :P
2622 * @param string $setting
2625 function wfIniGetBool( $setting ) {
2626 $val = strtolower( ini_get( $setting ) );
2627 // 'on' and 'true' can't have whitespace around them, but '1' can.
2631 ||
preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2635 * Windows-compatible version of escapeshellarg()
2636 * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
2637 * function puts single quotes in regardless of OS.
2639 * Also fixes the locale problems on Linux in PHP 5.2.6+ (bug backported to
2640 * earlier distro releases of PHP)
2642 * @param string ... strings to escape and glue together, or a single array of strings parameter
2645 function wfEscapeShellArg( /*...*/ ) {
2646 wfInitShellLocale();
2648 $args = func_get_args();
2649 if ( count( $args ) === 1 && is_array( reset( $args ) ) ) {
2650 // If only one argument has been passed, and that argument is an array,
2651 // treat it as a list of arguments
2652 $args = reset( $args );
2657 foreach ( $args as $arg ) {
2664 if ( wfIsWindows() ) {
2665 // Escaping for an MSVC-style command line parser and CMD.EXE
2666 // @codingStandardsIgnoreStart For long URLs
2668 // * http://web.archive.org/web/20020708081031/http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
2669 // * http://technet.microsoft.com/en-us/library/cc723564.aspx
2672 // Double the backslashes before any double quotes. Escape the double quotes.
2673 // @codingStandardsIgnoreEnd
2674 $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE
);
2677 foreach ( $tokens as $token ) {
2678 if ( $iteration %
2 == 1 ) {
2679 // Delimiter, a double quote preceded by zero or more slashes
2680 $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
2681 } elseif ( $iteration %
4 == 2 ) {
2682 // ^ in $token will be outside quotes, need to be escaped
2683 $arg .= str_replace( '^', '^^', $token );
2684 } else { // $iteration % 4 == 0
2685 // ^ in $token will appear inside double quotes, so leave as is
2690 // Double the backslashes before the end of the string, because
2691 // we will soon add a quote
2693 if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
2694 $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
2697 // Add surrounding quotes
2698 $retVal .= '"' . $arg . '"';
2700 $retVal .= escapeshellarg( $arg );
2707 * Check if wfShellExec() is effectively disabled via php.ini config
2709 * @return bool|string False or one of (safemode,disabled)
2712 function wfShellExecDisabled() {
2713 static $disabled = null;
2714 if ( is_null( $disabled ) ) {
2715 if ( wfIniGetBool( 'safe_mode' ) ) {
2716 wfDebug( "wfShellExec can't run in safe_mode, PHP's exec functions are too broken.\n" );
2717 $disabled = 'safemode';
2718 } elseif ( !function_exists( 'proc_open' ) ) {
2719 wfDebug( "proc_open() is disabled\n" );
2720 $disabled = 'disabled';
2729 * Execute a shell command, with time and memory limits mirrored from the PHP
2730 * configuration if supported.
2732 * @param string|string[] $cmd If string, a properly shell-escaped command line,
2733 * or an array of unescaped arguments, in which case each value will be escaped
2734 * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
2735 * @param null|mixed &$retval Optional, will receive the program's exit code.
2736 * (non-zero is usually failure). If there is an error from
2737 * read, select, or proc_open(), this will be set to -1.
2738 * @param array $environ Optional environment variables which should be
2739 * added to the executed command environment.
2740 * @param array $limits Optional array with limits(filesize, memory, time, walltime)
2741 * this overwrites the global wgMaxShell* limits.
2742 * @param array $options Array of options:
2743 * - duplicateStderr: Set this to true to duplicate stderr to stdout,
2744 * including errors from limit.sh
2745 * - profileMethod: By default this function will profile based on the calling
2746 * method. Set this to a string for an alternative method to profile from
2748 * @return string Collected stdout as a string
2750 function wfShellExec( $cmd, &$retval = null, $environ = array(),
2751 $limits = array(), $options = array()
2753 global $IP, $wgMaxShellMemory, $wgMaxShellFileSize, $wgMaxShellTime,
2754 $wgMaxShellWallClockTime, $wgShellCgroup;
2756 $disabled = wfShellExecDisabled();
2759 return $disabled == 'safemode' ?
2760 'Unable to run external programs in safe mode.' :
2761 'Unable to run external programs, proc_open() is disabled.';
2764 $includeStderr = isset( $options['duplicateStderr'] ) && $options['duplicateStderr'];
2765 $profileMethod = isset( $options['profileMethod'] ) ?
$options['profileMethod'] : wfGetCaller();
2767 wfInitShellLocale();
2770 foreach ( $environ as $k => $v ) {
2771 if ( wfIsWindows() ) {
2772 /* Surrounding a set in quotes (method used by wfEscapeShellArg) makes the quotes themselves
2773 * appear in the environment variable, so we must use carat escaping as documented in
2774 * http://technet.microsoft.com/en-us/library/cc723564.aspx
2775 * Note however that the quote isn't listed there, but is needed, and the parentheses
2776 * are listed there but doesn't appear to need it.
2778 $envcmd .= "set $k=" . preg_replace( '/([&|()<>^"])/', '^\\1', $v ) . '&& ';
2780 /* Assume this is a POSIX shell, thus required to accept variable assignments before the command
2781 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_09_01
2783 $envcmd .= "$k=" . escapeshellarg( $v ) . ' ';
2786 if ( is_array( $cmd ) ) {
2787 $cmd = wfEscapeShellArg( $cmd );
2790 $cmd = $envcmd . $cmd;
2792 $useLogPipe = false;
2793 if ( is_executable( '/bin/bash' ) ) {
2794 $time = intval ( isset( $limits['time'] ) ?
$limits['time'] : $wgMaxShellTime );
2795 if ( isset( $limits['walltime'] ) ) {
2796 $wallTime = intval( $limits['walltime'] );
2797 } elseif ( isset( $limits['time'] ) ) {
2800 $wallTime = intval( $wgMaxShellWallClockTime );
2802 $mem = intval ( isset( $limits['memory'] ) ?
$limits['memory'] : $wgMaxShellMemory );
2803 $filesize = intval ( isset( $limits['filesize'] ) ?
$limits['filesize'] : $wgMaxShellFileSize );
2805 if ( $time > 0 ||
$mem > 0 ||
$filesize > 0 ||
$wallTime > 0 ) {
2806 $cmd = '/bin/bash ' . escapeshellarg( "$IP/includes/limit.sh" ) . ' ' .
2807 escapeshellarg( $cmd ) . ' ' .
2809 "MW_INCLUDE_STDERR=" . ( $includeStderr ?
'1' : '' ) . ';' .
2810 "MW_CPU_LIMIT=$time; " .
2811 'MW_CGROUP=' . escapeshellarg( $wgShellCgroup ) . '; ' .
2812 "MW_MEM_LIMIT=$mem; " .
2813 "MW_FILE_SIZE_LIMIT=$filesize; " .
2814 "MW_WALL_CLOCK_LIMIT=$wallTime; " .
2815 "MW_USE_LOG_PIPE=yes"
2818 } elseif ( $includeStderr ) {
2821 } elseif ( $includeStderr ) {
2824 wfDebug( "wfShellExec: $cmd\n" );
2827 0 => array( 'file', 'php://stdin', 'r' ),
2828 1 => array( 'pipe', 'w' ),
2829 2 => array( 'file', 'php://stderr', 'w' ) );
2830 if ( $useLogPipe ) {
2831 $desc[3] = array( 'pipe', 'w' );
2834 $scoped = Profiler
::instance()->scopedProfileIn( __FUNCTION__
. '-' . $profileMethod );
2835 $proc = proc_open( $cmd, $desc, $pipes );
2837 wfDebugLog( 'exec', "proc_open() failed: $cmd" );
2841 $outBuffer = $logBuffer = '';
2842 $emptyArray = array();
2846 // According to the documentation, it is possible for stream_select()
2847 // to fail due to EINTR. I haven't managed to induce this in testing
2848 // despite sending various signals. If it did happen, the error
2849 // message would take the form:
2851 // stream_select(): unable to select [4]: Interrupted system call (max_fd=5)
2853 // where [4] is the value of the macro EINTR and "Interrupted system
2854 // call" is string which according to the Linux manual is "possibly"
2855 // localised according to LC_MESSAGES.
2856 $eintr = defined( 'SOCKET_EINTR' ) ? SOCKET_EINTR
: 4;
2857 $eintrMessage = "stream_select(): unable to select [$eintr]";
2859 // Build a table mapping resource IDs to pipe FDs to work around a
2860 // PHP 5.3 issue in which stream_select() does not preserve array keys
2861 // <https://bugs.php.net/bug.php?id=53427>.
2863 foreach ( $pipes as $fd => $pipe ) {
2864 $fds[(int)$pipe] = $fd;
2871 while ( $running === true ||
$numReadyPipes !== 0 ) {
2873 $status = proc_get_status( $proc );
2874 // If the process has terminated, switch to nonblocking selects
2875 // for getting any data still waiting to be read.
2876 if ( !$status['running'] ) {
2882 $readyPipes = $pipes;
2885 // @codingStandardsIgnoreStart Generic.PHP.NoSilencedErrors.Discouraged
2886 @trigger_error
( '' );
2887 $numReadyPipes = @stream_select
( $readyPipes, $emptyArray, $emptyArray, $timeout );
2888 if ( $numReadyPipes === false ) {
2889 // @codingStandardsIgnoreEnd
2890 $error = error_get_last();
2891 if ( strncmp( $error['message'], $eintrMessage, strlen( $eintrMessage ) ) == 0 ) {
2894 trigger_error( $error['message'], E_USER_WARNING
);
2895 $logMsg = $error['message'];
2899 foreach ( $readyPipes as $pipe ) {
2900 $block = fread( $pipe, 65536 );
2901 $fd = $fds[(int)$pipe];
2902 if ( $block === '' ) {
2904 fclose( $pipes[$fd] );
2905 unset( $pipes[$fd] );
2909 } elseif ( $block === false ) {
2911 $logMsg = "Error reading from pipe";
2913 } elseif ( $fd == 1 ) {
2915 $outBuffer .= $block;
2916 } elseif ( $fd == 3 ) {
2918 $logBuffer .= $block;
2919 if ( strpos( $block, "\n" ) !== false ) {
2920 $lines = explode( "\n", $logBuffer );
2921 $logBuffer = array_pop( $lines );
2922 foreach ( $lines as $line ) {
2923 wfDebugLog( 'exec', $line );
2930 foreach ( $pipes as $pipe ) {
2934 // Use the status previously collected if possible, since proc_get_status()
2935 // just calls waitpid() which will not return anything useful the second time.
2937 $status = proc_get_status( $proc );
2940 if ( $logMsg !== false ) {
2941 // Read/select error
2943 proc_close( $proc );
2944 } elseif ( $status['signaled'] ) {
2945 $logMsg = "Exited with signal {$status['termsig']}";
2946 $retval = 128 +
$status['termsig'];
2947 proc_close( $proc );
2949 if ( $status['running'] ) {
2950 $retval = proc_close( $proc );
2952 $retval = $status['exitcode'];
2953 proc_close( $proc );
2955 if ( $retval == 127 ) {
2956 $logMsg = "Possibly missing executable file";
2957 } elseif ( $retval >= 129 && $retval <= 192 ) {
2958 $logMsg = "Probably exited with signal " . ( $retval - 128 );
2962 if ( $logMsg !== false ) {
2963 wfDebugLog( 'exec', "$logMsg: $cmd" );
2970 * Execute a shell command, returning both stdout and stderr. Convenience
2971 * function, as all the arguments to wfShellExec can become unwieldy.
2973 * @note This also includes errors from limit.sh, e.g. if $wgMaxShellFileSize is exceeded.
2974 * @param string|string[] $cmd If string, a properly shell-escaped command line,
2975 * or an array of unescaped arguments, in which case each value will be escaped
2976 * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
2977 * @param null|mixed &$retval Optional, will receive the program's exit code.
2978 * (non-zero is usually failure)
2979 * @param array $environ Optional environment variables which should be
2980 * added to the executed command environment.
2981 * @param array $limits Optional array with limits(filesize, memory, time, walltime)
2982 * this overwrites the global wgMaxShell* limits.
2983 * @return string Collected stdout and stderr as a string
2985 function wfShellExecWithStderr( $cmd, &$retval = null, $environ = array(), $limits = array() ) {
2986 return wfShellExec( $cmd, $retval, $environ, $limits,
2987 array( 'duplicateStderr' => true, 'profileMethod' => wfGetCaller() ) );
2991 * Workaround for http://bugs.php.net/bug.php?id=45132
2992 * escapeshellarg() destroys non-ASCII characters if LANG is not a UTF-8 locale
2994 function wfInitShellLocale() {
2995 static $done = false;
3000 global $wgShellLocale;
3001 if ( !wfIniGetBool( 'safe_mode' ) ) {
3002 putenv( "LC_CTYPE=$wgShellLocale" );
3003 setlocale( LC_CTYPE
, $wgShellLocale );
3008 * Generate a shell-escaped command line string to run a MediaWiki cli script.
3009 * Note that $parameters should be a flat array and an option with an argument
3010 * should consist of two consecutive items in the array (do not use "--option value").
3012 * @param string $script MediaWiki cli script path
3013 * @param array $parameters Arguments and options to the script
3014 * @param array $options Associative array of options:
3015 * 'php': The path to the php executable
3016 * 'wrapper': Path to a PHP wrapper to handle the maintenance script
3019 function wfShellWikiCmd( $script, array $parameters = array(), array $options = array() ) {
3021 // Give site config file a chance to run the script in a wrapper.
3022 // The caller may likely want to call wfBasename() on $script.
3023 Hooks
::run( 'wfShellWikiCmd', array( &$script, &$parameters, &$options ) );
3024 $cmd = isset( $options['php'] ) ?
array( $options['php'] ) : array( $wgPhpCli );
3025 if ( isset( $options['wrapper'] ) ) {
3026 $cmd[] = $options['wrapper'];
3029 // Escape each parameter for shell
3030 return wfEscapeShellArg( array_merge( $cmd, $parameters ) );
3034 * wfMerge attempts to merge differences between three texts.
3035 * Returns true for a clean merge and false for failure or a conflict.
3037 * @param string $old
3038 * @param string $mine
3039 * @param string $yours
3040 * @param string $result
3043 function wfMerge( $old, $mine, $yours, &$result ) {
3046 # This check may also protect against code injection in
3047 # case of broken installations.
3048 wfSuppressWarnings();
3049 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
3050 wfRestoreWarnings();
3052 if ( !$haveDiff3 ) {
3053 wfDebug( "diff3 not found\n" );
3057 # Make temporary files
3059 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
3060 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
3061 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
3063 # NOTE: diff3 issues a warning to stderr if any of the files does not end with
3064 # a newline character. To avoid this, we normalize the trailing whitespace before
3065 # creating the diff.
3067 fwrite( $oldtextFile, rtrim( $old ) . "\n" );
3068 fclose( $oldtextFile );
3069 fwrite( $mytextFile, rtrim( $mine ) . "\n" );
3070 fclose( $mytextFile );
3071 fwrite( $yourtextFile, rtrim( $yours ) . "\n" );
3072 fclose( $yourtextFile );
3074 # Check for a conflict
3075 $cmd = wfEscapeShellArg( $wgDiff3, '-a', '--overlap-only', $mytextName, $oldtextName, $yourtextName );
3076 $handle = popen( $cmd, 'r' );
3078 if ( fgets( $handle, 1024 ) ) {
3086 $cmd = wfEscapeShellArg( $wgDiff3, '-a', '-e', '--merge', $mytextName, $oldtextName, $yourtextName );
3087 $handle = popen( $cmd, 'r' );
3090 $data = fread( $handle, 8192 );
3091 if ( strlen( $data ) == 0 ) {
3097 unlink( $mytextName );
3098 unlink( $oldtextName );
3099 unlink( $yourtextName );
3101 if ( $result === '' && $old !== '' && !$conflict ) {
3102 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
3109 * Returns unified plain-text diff of two texts.
3110 * "Useful" for machine processing of diffs.
3112 * @deprecated since 1.25, use DiffEngine/UnifiedDiffFormatter directly
3114 * @param string $before The text before the changes.
3115 * @param string $after The text after the changes.
3116 * @param string $params Command-line options for the diff command.
3117 * @return string Unified diff of $before and $after
3119 function wfDiff( $before, $after, $params = '-u' ) {
3120 if ( $before == $after ) {
3125 wfSuppressWarnings();
3126 $haveDiff = $wgDiff && file_exists( $wgDiff );
3127 wfRestoreWarnings();
3129 # This check may also protect against code injection in
3130 # case of broken installations.
3132 wfDebug( "diff executable not found\n" );
3133 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
3134 $format = new UnifiedDiffFormatter();
3135 return $format->format( $diffs );
3138 # Make temporary files
3140 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
3141 $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
3143 fwrite( $oldtextFile, $before );
3144 fclose( $oldtextFile );
3145 fwrite( $newtextFile, $after );
3146 fclose( $newtextFile );
3148 // Get the diff of the two files
3149 $cmd = "$wgDiff " . $params . ' ' . wfEscapeShellArg( $oldtextName, $newtextName );
3151 $h = popen( $cmd, 'r' );
3153 unlink( $oldtextName );
3154 unlink( $newtextName );
3155 throw new Exception( __METHOD__
. '(): popen() failed' );
3161 $data = fread( $h, 8192 );
3162 if ( strlen( $data ) == 0 ) {
3170 unlink( $oldtextName );
3171 unlink( $newtextName );
3173 // Kill the --- and +++ lines. They're not useful.
3174 $diff_lines = explode( "\n", $diff );
3175 if ( isset( $diff_lines[0] ) && strpos( $diff_lines[0], '---' ) === 0 ) {
3176 unset( $diff_lines[0] );
3178 if ( isset( $diff_lines[1] ) && strpos( $diff_lines[1], '+++' ) === 0 ) {
3179 unset( $diff_lines[1] );
3182 $diff = implode( "\n", $diff_lines );
3188 * This function works like "use VERSION" in Perl, the program will die with a
3189 * backtrace if the current version of PHP is less than the version provided
3191 * This is useful for extensions which due to their nature are not kept in sync
3192 * with releases, and might depend on other versions of PHP than the main code
3194 * Note: PHP might die due to parsing errors in some cases before it ever
3195 * manages to call this function, such is life
3197 * @see perldoc -f use
3199 * @param string|int|float $req_ver The version to check, can be a string, an integer, or a float
3200 * @throws MWException
3202 function wfUsePHP( $req_ver ) {
3203 $php_ver = PHP_VERSION
;
3205 if ( version_compare( $php_ver, (string)$req_ver, '<' ) ) {
3206 throw new MWException( "PHP $req_ver required--this is only $php_ver" );
3211 * This function works like "use VERSION" in Perl except it checks the version
3212 * of MediaWiki, the program will die with a backtrace if the current version
3213 * of MediaWiki is less than the version provided.
3215 * This is useful for extensions which due to their nature are not kept in sync
3218 * Note: Due to the behavior of PHP's version_compare() which is used in this
3219 * function, if you want to allow the 'wmf' development versions add a 'c' (or
3220 * any single letter other than 'a', 'b' or 'p') as a post-fix to your
3221 * targeted version number. For example if you wanted to allow any variation
3222 * of 1.22 use `wfUseMW( '1.22c' )`. Using an 'a' or 'b' instead of 'c' will
3223 * not result in the same comparison due to the internal logic of
3224 * version_compare().
3226 * @see perldoc -f use
3228 * @param string|int|float $req_ver The version to check, can be a string, an integer, or a float
3229 * @throws MWException
3231 function wfUseMW( $req_ver ) {
3234 if ( version_compare( $wgVersion, (string)$req_ver, '<' ) ) {
3235 throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
3240 * Return the final portion of a pathname.
3241 * Reimplemented because PHP5's "basename()" is buggy with multibyte text.
3242 * http://bugs.php.net/bug.php?id=33898
3244 * PHP's basename() only considers '\' a pathchar on Windows and Netware.
3245 * We'll consider it so always, as we don't want '\s' in our Unix paths either.
3247 * @param string $path
3248 * @param string $suffix String to remove if present
3251 function wfBaseName( $path, $suffix = '' ) {
3252 if ( $suffix == '' ) {
3255 $encSuffix = '(?:' . preg_quote( $suffix, '#' ) . ')?';
3259 if ( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
3267 * Generate a relative path name to the given file.
3268 * May explode on non-matching case-insensitive paths,
3269 * funky symlinks, etc.
3271 * @param string $path Absolute destination path including target filename
3272 * @param string $from Absolute source path, directory only
3275 function wfRelativePath( $path, $from ) {
3276 // Normalize mixed input on Windows...
3277 $path = str_replace( '/', DIRECTORY_SEPARATOR
, $path );
3278 $from = str_replace( '/', DIRECTORY_SEPARATOR
, $from );
3280 // Trim trailing slashes -- fix for drive root
3281 $path = rtrim( $path, DIRECTORY_SEPARATOR
);
3282 $from = rtrim( $from, DIRECTORY_SEPARATOR
);
3284 $pieces = explode( DIRECTORY_SEPARATOR
, dirname( $path ) );
3285 $against = explode( DIRECTORY_SEPARATOR
, $from );
3287 if ( $pieces[0] !== $against[0] ) {
3288 // Non-matching Windows drive letters?
3289 // Return a full path.
3293 // Trim off common prefix
3294 while ( count( $pieces ) && count( $against )
3295 && $pieces[0] == $against[0] ) {
3296 array_shift( $pieces );
3297 array_shift( $against );
3300 // relative dots to bump us to the parent
3301 while ( count( $against ) ) {
3302 array_unshift( $pieces, '..' );
3303 array_shift( $against );
3306 array_push( $pieces, wfBaseName( $path ) );
3308 return implode( DIRECTORY_SEPARATOR
, $pieces );
3312 * Convert an arbitrarily-long digit string from one numeric base
3313 * to another, optionally zero-padding to a minimum column width.
3315 * Supports base 2 through 36; digit values 10-36 are represented
3316 * as lowercase letters a-z. Input is case-insensitive.
3318 * @param string $input Input number
3319 * @param int $sourceBase Base of the input number
3320 * @param int $destBase Desired base of the output
3321 * @param int $pad Minimum number of digits in the output (pad with zeroes)
3322 * @param bool $lowercase Whether to output in lowercase or uppercase
3323 * @param string $engine Either "gmp", "bcmath", or "php"
3324 * @return string|bool The output number as a string, or false on error
3326 function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1,
3327 $lowercase = true, $engine = 'auto'
3329 $input = (string)$input;
3335 $sourceBase != (int)$sourceBase ||
3336 $destBase != (int)$destBase ||
3337 $pad != (int)$pad ||
3339 "/^[" . substr( '0123456789abcdefghijklmnopqrstuvwxyz', 0, $sourceBase ) . "]+$/i",
3346 static $baseChars = array(
3347 10 => 'a', 11 => 'b', 12 => 'c', 13 => 'd', 14 => 'e', 15 => 'f',
3348 16 => 'g', 17 => 'h', 18 => 'i', 19 => 'j', 20 => 'k', 21 => 'l',
3349 22 => 'm', 23 => 'n', 24 => 'o', 25 => 'p', 26 => 'q', 27 => 'r',
3350 28 => 's', 29 => 't', 30 => 'u', 31 => 'v', 32 => 'w', 33 => 'x',
3351 34 => 'y', 35 => 'z',
3353 '0' => 0, '1' => 1, '2' => 2, '3' => 3, '4' => 4, '5' => 5,
3354 '6' => 6, '7' => 7, '8' => 8, '9' => 9, 'a' => 10, 'b' => 11,
3355 'c' => 12, 'd' => 13, 'e' => 14, 'f' => 15, 'g' => 16, 'h' => 17,
3356 'i' => 18, 'j' => 19, 'k' => 20, 'l' => 21, 'm' => 22, 'n' => 23,
3357 'o' => 24, 'p' => 25, 'q' => 26, 'r' => 27, 's' => 28, 't' => 29,
3358 'u' => 30, 'v' => 31, 'w' => 32, 'x' => 33, 'y' => 34, 'z' => 35
3361 if ( extension_loaded( 'gmp' ) && ( $engine == 'auto' ||
$engine == 'gmp' ) ) {
3362 // Removing leading zeros works around broken base detection code in
3363 // some PHP versions (see <https://bugs.php.net/bug.php?id=50175> and
3364 // <https://bugs.php.net/bug.php?id=55398>).
3365 $result = gmp_strval( gmp_init( ltrim( $input, '0' ), $sourceBase ), $destBase );
3366 } elseif ( extension_loaded( 'bcmath' ) && ( $engine == 'auto' ||
$engine == 'bcmath' ) ) {
3368 foreach ( str_split( strtolower( $input ) ) as $char ) {
3369 $decimal = bcmul( $decimal, $sourceBase );
3370 $decimal = bcadd( $decimal, $baseChars[$char] );
3373 // @codingStandardsIgnoreStart Generic.CodeAnalysis.ForLoopWithTestFunctionCall.NotAllowed
3374 for ( $result = ''; bccomp( $decimal, 0 ); $decimal = bcdiv( $decimal, $destBase, 0 ) ) {
3375 $result .= $baseChars[bcmod( $decimal, $destBase )];
3377 // @codingStandardsIgnoreEnd
3379 $result = strrev( $result );
3381 $inDigits = array();
3382 foreach ( str_split( strtolower( $input ) ) as $char ) {
3383 $inDigits[] = $baseChars[$char];
3386 // Iterate over the input, modulo-ing out an output digit
3387 // at a time until input is gone.
3389 while ( $inDigits ) {
3391 $workDigits = array();
3394 foreach ( $inDigits as $digit ) {
3395 $work *= $sourceBase;
3398 if ( $workDigits ||
$work >= $destBase ) {
3399 $workDigits[] = (int)( $work / $destBase );
3404 // All that division leaves us with a remainder,
3405 // which is conveniently our next output digit.
3406 $result .= $baseChars[$work];
3409 $inDigits = $workDigits;
3412 $result = strrev( $result );
3415 if ( !$lowercase ) {
3416 $result = strtoupper( $result );
3419 return str_pad( $result, $pad, '0', STR_PAD_LEFT
);
3423 * Check if there is sufficient entropy in php's built-in session generation
3425 * @return bool True = there is sufficient entropy
3427 function wfCheckEntropy() {
3429 ( wfIsWindows() && version_compare( PHP_VERSION
, '5.3.3', '>=' ) )
3430 ||
ini_get( 'session.entropy_file' )
3432 && intval( ini_get( 'session.entropy_length' ) ) >= 32;
3436 * Override session_id before session startup if php's built-in
3437 * session generation code is not secure.
3439 function wfFixSessionID() {
3440 // If the cookie or session id is already set we already have a session and should abort
3441 if ( isset( $_COOKIE[session_name()] ) ||
session_id() ) {
3445 // PHP's built-in session entropy is enabled if:
3446 // - entropy_file is set or you're on Windows with php 5.3.3+
3447 // - AND entropy_length is > 0
3448 // We treat it as disabled if it doesn't have an entropy length of at least 32
3449 $entropyEnabled = wfCheckEntropy();
3451 // If built-in entropy is not enabled or not sufficient override PHP's
3452 // built in session id generation code
3453 if ( !$entropyEnabled ) {
3454 wfDebug( __METHOD__
. ": PHP's built in entropy is disabled or not sufficient, " .
3455 "overriding session id generation using our cryptrand source.\n" );
3456 session_id( MWCryptRand
::generateHex( 32 ) );
3461 * Reset the session_id
3465 function wfResetSessionID() {
3466 global $wgCookieSecure;
3467 $oldSessionId = session_id();
3468 $cookieParams = session_get_cookie_params();
3469 if ( wfCheckEntropy() && $wgCookieSecure == $cookieParams['secure'] ) {
3470 session_regenerate_id( false );
3474 wfSetupSession( MWCryptRand
::generateHex( 32 ) );
3477 $newSessionId = session_id();
3478 Hooks
::run( 'ResetSessionID', array( $oldSessionId, $newSessionId ) );
3482 * Initialise php session
3484 * @param bool $sessionId
3486 function wfSetupSession( $sessionId = false ) {
3487 global $wgSessionsInMemcached, $wgSessionsInObjectCache, $wgCookiePath, $wgCookieDomain,
3488 $wgCookieSecure, $wgCookieHttpOnly, $wgSessionHandler;
3489 if ( $wgSessionsInObjectCache ||
$wgSessionsInMemcached ) {
3490 ObjectCacheSessionHandler
::install();
3491 } elseif ( $wgSessionHandler && $wgSessionHandler != ini_get( 'session.save_handler' ) ) {
3492 # Only set this if $wgSessionHandler isn't null and session.save_handler
3493 # hasn't already been set to the desired value (that causes errors)
3494 ini_set( 'session.save_handler', $wgSessionHandler );
3496 session_set_cookie_params(
3497 0, $wgCookiePath, $wgCookieDomain, $wgCookieSecure, $wgCookieHttpOnly );
3498 session_cache_limiter( 'private, must-revalidate' );
3500 session_id( $sessionId );
3504 wfSuppressWarnings();
3506 wfRestoreWarnings();
3510 * Get an object from the precompiled serialized directory
3512 * @param string $name
3513 * @return mixed The variable on success, false on failure
3515 function wfGetPrecompiledData( $name ) {
3518 $file = "$IP/serialized/$name";
3519 if ( file_exists( $file ) ) {
3520 $blob = file_get_contents( $file );
3522 return unserialize( $blob );
3531 * @param string $args,...
3534 function wfMemcKey( /*...*/ ) {
3535 global $wgCachePrefix;
3536 $prefix = $wgCachePrefix === false ?
wfWikiID() : $wgCachePrefix;
3537 $args = func_get_args();
3538 $key = $prefix . ':' . implode( ':', $args );
3539 $key = str_replace( ' ', '_', $key );
3544 * Get a cache key for a foreign DB
3547 * @param string $prefix
3548 * @param string $args,...
3551 function wfForeignMemcKey( $db, $prefix /*...*/ ) {
3552 $args = array_slice( func_get_args(), 2 );
3554 $key = "$db-$prefix:" . implode( ':', $args );
3556 $key = $db . ':' . implode( ':', $args );
3558 return str_replace( ' ', '_', $key );
3562 * Get an ASCII string identifying this wiki
3563 * This is used as a prefix in memcached keys
3567 function wfWikiID() {
3568 global $wgDBprefix, $wgDBname;
3569 if ( $wgDBprefix ) {
3570 return "$wgDBname-$wgDBprefix";
3577 * Split a wiki ID into DB name and table prefix
3579 * @param string $wiki
3583 function wfSplitWikiID( $wiki ) {
3584 $bits = explode( '-', $wiki, 2 );
3585 if ( count( $bits ) < 2 ) {
3592 * Get a Database object.
3594 * @param int $db Index of the connection to get. May be DB_MASTER for the
3595 * master (for write queries), DB_SLAVE for potentially lagged read
3596 * queries, or an integer >= 0 for a particular server.
3598 * @param string|string[] $groups Query groups. An array of group names that this query
3599 * belongs to. May contain a single string if the query is only
3602 * @param string|bool $wiki The wiki ID, or false for the current wiki
3604 * Note: multiple calls to wfGetDB(DB_SLAVE) during the course of one request
3605 * will always return the same object, unless the underlying connection or load
3606 * balancer is manually destroyed.
3608 * Note 2: use $this->getDB() in maintenance scripts that may be invoked by
3609 * updater to ensure that a proper database is being updated.
3611 * @return DatabaseBase
3613 function wfGetDB( $db, $groups = array(), $wiki = false ) {
3614 return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
3618 * Get a load balancer object.
3620 * @param string|bool $wiki Wiki ID, or false for the current wiki
3621 * @return LoadBalancer
3623 function wfGetLB( $wiki = false ) {
3624 return wfGetLBFactory()->getMainLB( $wiki );
3628 * Get the load balancer factory object
3632 function wfGetLBFactory() {
3633 return LBFactory
::singleton();
3638 * Shortcut for RepoGroup::singleton()->findFile()
3640 * @param string $title String or Title object
3641 * @param array $options Associative array of options (see RepoGroup::findFile)
3642 * @return File|bool File, or false if the file does not exist
3644 function wfFindFile( $title, $options = array() ) {
3645 return RepoGroup
::singleton()->findFile( $title, $options );
3649 * Get an object referring to a locally registered file.
3650 * Returns a valid placeholder object if the file does not exist.
3652 * @param Title|string $title
3653 * @return LocalFile|null A File, or null if passed an invalid Title
3655 function wfLocalFile( $title ) {
3656 return RepoGroup
::singleton()->getLocalRepo()->newFile( $title );
3660 * Should low-performance queries be disabled?
3663 * @codeCoverageIgnore
3665 function wfQueriesMustScale() {
3666 global $wgMiserMode;
3668 ||
( SiteStats
::pages() > 100000
3669 && SiteStats
::edits() > 1000000
3670 && SiteStats
::users() > 10000 );
3674 * Get the path to a specified script file, respecting file
3675 * extensions; this is a wrapper around $wgScriptExtension etc.
3676 * except for 'index' and 'load' which use $wgScript/$wgLoadScript
3678 * @param string $script Script filename, sans extension
3681 function wfScript( $script = 'index' ) {
3682 global $wgScriptPath, $wgScriptExtension, $wgScript, $wgLoadScript;
3683 if ( $script === 'index' ) {
3685 } elseif ( $script === 'load' ) {
3686 return $wgLoadScript;
3688 return "{$wgScriptPath}/{$script}{$wgScriptExtension}";
3693 * Get the script URL.
3695 * @return string Script URL
3697 function wfGetScriptUrl() {
3698 if ( isset( $_SERVER['SCRIPT_NAME'] ) ) {
3700 # as it was called, minus the query string.
3702 # Some sites use Apache rewrite rules to handle subdomains,
3703 # and have PHP set up in a weird way that causes PHP_SELF
3704 # to contain the rewritten URL instead of the one that the
3705 # outside world sees.
3707 # If in this mode, use SCRIPT_URL instead, which mod_rewrite
3708 # provides containing the "before" URL.
3709 return $_SERVER['SCRIPT_NAME'];
3711 return $_SERVER['URL'];
3716 * Convenience function converts boolean values into "true"
3717 * or "false" (string) values
3719 * @param bool $value
3722 function wfBoolToStr( $value ) {
3723 return $value ?
'true' : 'false';
3727 * Get a platform-independent path to the null file, e.g. /dev/null
3731 function wfGetNull() {
3732 return wfIsWindows() ?
'NUL' : '/dev/null';
3736 * Waits for the slaves to catch up to the master position
3738 * Use this when updating very large numbers of rows, as in maintenance scripts,
3739 * to avoid causing too much lag. Of course, this is a no-op if there are no slaves.
3741 * By default this waits on the main DB cluster of the current wiki.
3742 * If $cluster is set to "*" it will wait on all DB clusters, including
3743 * external ones. If the lag being waiting on is caused by the code that
3744 * does this check, it makes since to use $ifWritesSince, particularly if
3745 * cluster is "*", to avoid excess overhead.
3747 * Never call this function after a big DB write that is still in a transaction.
3748 * This only makes sense after the possible lag inducing changes were committed.
3750 * @param float|null $ifWritesSince Only wait if writes were done since this UNIX timestamp
3751 * @param string|bool $wiki Wiki identifier accepted by wfGetLB
3752 * @param string|bool $cluster Cluster name accepted by LBFactory. Default: false.
3753 * @param int|null $timeout Max wait time. Default: 1 day (cli), ~10 seconds (web)
3754 * @return bool Success (able to connect and no timeouts reached)
3756 function wfWaitForSlaves(
3757 $ifWritesSince = null, $wiki = false, $cluster = false, $timeout = null
3759 // B/C: first argument used to be "max seconds of lag"; ignore such values
3760 $ifWritesSince = ( $ifWritesSince > 1e9
) ?
$ifWritesSince : null;
3762 if ( $timeout === null ) {
3763 $timeout = ( PHP_SAPI
=== 'cli' ) ?
86400 : 10;
3766 // Figure out which clusters need to be checked
3768 if ( $cluster === '*' ) {
3769 wfGetLBFactory()->forEachLB( function ( LoadBalancer
$lb ) use ( &$lbs ) {
3772 } elseif ( $cluster !== false ) {
3773 $lbs[] = wfGetLBFactory()->getExternalLB( $cluster );
3775 $lbs[] = wfGetLB( $wiki );
3778 // Get all the master positions of applicable DBs right now.
3779 // This can be faster since waiting on one cluster reduces the
3780 // time needed to wait on the next clusters.
3781 $masterPositions = array_fill( 0, count( $lbs ), false );
3782 foreach ( $lbs as $i => $lb ) {
3783 // bug 27975 - Don't try to wait for slaves if there are none
3784 // Prevents permission error when getting master position
3785 if ( $lb->getServerCount() > 1 ) {
3786 if ( $ifWritesSince && !$lb->hasMasterConnection() ) {
3787 continue; // assume no writes done
3789 // Use the empty string to not trigger selectDB() since the connection
3790 // may have been to a server that does not have a DB for the current wiki.
3791 $dbw = $lb->getConnection( DB_MASTER
, array(), '' );
3792 if ( $ifWritesSince && $dbw->lastDoneWrites() < $ifWritesSince ) {
3793 continue; // no writes since the last wait
3795 $masterPositions[$i] = $dbw->getMasterPos();
3800 foreach ( $lbs as $i => $lb ) {
3801 if ( $masterPositions[$i] ) {
3802 // The DBMS may not support getMasterPos() or the whole
3803 // load balancer might be fake (e.g. $wgAllDBsAreLocalhost).
3804 $ok = $lb->waitForAll( $masterPositions[$i], $timeout ) && $ok;
3812 * Count down from $seconds to zero on the terminal, with a one-second pause
3813 * between showing each number. For use in command-line scripts.
3815 * @codeCoverageIgnore
3816 * @param int $seconds
3818 function wfCountDown( $seconds ) {
3819 for ( $i = $seconds; $i >= 0; $i-- ) {
3820 if ( $i != $seconds ) {
3821 echo str_repeat( "\x08", strlen( $i +
1 ) );
3833 * Replace all invalid characters with -
3834 * Additional characters can be defined in $wgIllegalFileChars (see bug 20489)
3835 * By default, $wgIllegalFileChars = ':'
3837 * @param string $name Filename to process
3840 function wfStripIllegalFilenameChars( $name ) {
3841 global $wgIllegalFileChars;
3842 $illegalFileChars = $wgIllegalFileChars ?
"|[" . $wgIllegalFileChars . "]" : '';
3843 $name = wfBaseName( $name );
3844 $name = preg_replace(
3845 "/[^" . Title
::legalChars() . "]" . $illegalFileChars . "/",
3853 * Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit;
3855 * @return int Value the memory limit was set to.
3857 function wfMemoryLimit() {
3858 global $wgMemoryLimit;
3859 $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
3860 if ( $memlimit != -1 ) {
3861 $conflimit = wfShorthandToInteger( $wgMemoryLimit );
3862 if ( $conflimit == -1 ) {
3863 wfDebug( "Removing PHP's memory limit\n" );
3864 wfSuppressWarnings();
3865 ini_set( 'memory_limit', $conflimit );
3866 wfRestoreWarnings();
3868 } elseif ( $conflimit > $memlimit ) {
3869 wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
3870 wfSuppressWarnings();
3871 ini_set( 'memory_limit', $conflimit );
3872 wfRestoreWarnings();
3880 * Converts shorthand byte notation to integer form
3882 * @param string $string
3885 function wfShorthandToInteger( $string = '' ) {
3886 $string = trim( $string );
3887 if ( $string === '' ) {
3890 $last = $string[strlen( $string ) - 1];
3891 $val = intval( $string );
3896 // break intentionally missing
3900 // break intentionally missing
3910 * Get the normalised IETF language tag
3911 * See unit test for examples.
3913 * @param string $code The language code.
3914 * @return string The language code which complying with BCP 47 standards.
3916 function wfBCP47( $code ) {
3917 $codeSegment = explode( '-', $code );
3919 foreach ( $codeSegment as $segNo => $seg ) {
3920 // when previous segment is x, it is a private segment and should be lc
3921 if ( $segNo > 0 && strtolower( $codeSegment[( $segNo - 1 )] ) == 'x' ) {
3922 $codeBCP[$segNo] = strtolower( $seg );
3923 // ISO 3166 country code
3924 } elseif ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) {
3925 $codeBCP[$segNo] = strtoupper( $seg );
3926 // ISO 15924 script code
3927 } elseif ( ( strlen( $seg ) == 4 ) && ( $segNo > 0 ) ) {
3928 $codeBCP[$segNo] = ucfirst( strtolower( $seg ) );
3929 // Use lowercase for other cases
3931 $codeBCP[$segNo] = strtolower( $seg );
3934 $langCode = implode( '-', $codeBCP );
3939 * Get a cache object.
3941 * @param int $inputType Cache type, one of the CACHE_* constants.
3944 function wfGetCache( $inputType ) {
3945 return ObjectCache
::getInstance( $inputType );
3949 * Get the main cache object
3953 function wfGetMainCache() {
3954 global $wgMainCacheType;
3955 return ObjectCache
::getInstance( $wgMainCacheType );
3959 * Get the cache object used by the message cache
3963 function wfGetMessageCacheStorage() {
3964 global $wgMessageCacheType;
3965 return ObjectCache
::getInstance( $wgMessageCacheType );
3969 * Get the cache object used by the parser cache
3973 function wfGetParserCacheStorage() {
3974 global $wgParserCacheType;
3975 return ObjectCache
::getInstance( $wgParserCacheType );
3979 * Call hook functions defined in $wgHooks
3981 * @param string $event Event name
3982 * @param array $args Parameters passed to hook functions
3983 * @param string|null $deprecatedVersion Optionally mark hook as deprecated with version number
3985 * @return bool True if no handler aborted the hook
3986 * @deprecated 1.25 - use Hooks::run
3988 function wfRunHooks( $event, array $args = array(), $deprecatedVersion = null ) {
3989 return Hooks
::run( $event, $args, $deprecatedVersion );
3993 * Wrapper around php's unpack.
3995 * @param string $format The format string (See php's docs)
3996 * @param string $data A binary string of binary data
3997 * @param int|bool $length The minimum length of $data or false. This is to
3998 * prevent reading beyond the end of $data. false to disable the check.
4000 * Also be careful when using this function to read unsigned 32 bit integer
4001 * because php might make it negative.
4003 * @throws MWException If $data not long enough, or if unpack fails
4004 * @return array Associative array of the extracted data
4006 function wfUnpack( $format, $data, $length = false ) {
4007 if ( $length !== false ) {
4008 $realLen = strlen( $data );
4009 if ( $realLen < $length ) {
4010 throw new MWException( "Tried to use wfUnpack on a "
4011 . "string of length $realLen, but needed one "
4012 . "of at least length $length."
4017 wfSuppressWarnings();
4018 $result = unpack( $format, $data );
4019 wfRestoreWarnings();
4021 if ( $result === false ) {
4022 // If it cannot extract the packed data.
4023 throw new MWException( "unpack could not unpack binary data" );
4029 * Determine if an image exists on the 'bad image list'.
4031 * The format of MediaWiki:Bad_image_list is as follows:
4032 * * Only list items (lines starting with "*") are considered
4033 * * The first link on a line must be a link to a bad image
4034 * * Any subsequent links on the same line are considered to be exceptions,
4035 * i.e. articles where the image may occur inline.
4037 * @param string $name The image name to check
4038 * @param Title|bool $contextTitle The page on which the image occurs, if known
4039 * @param string $blacklist Wikitext of a file blacklist
4042 function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
4043 static $badImageCache = null; // based on bad_image_list msg
4046 $redirectTitle = RepoGroup
::singleton()->checkRedirect( Title
::makeTitle( NS_FILE
, $name ) );
4047 if ( $redirectTitle ) {
4048 $name = $redirectTitle->getDBkey();
4051 # Run the extension hook
4053 if ( !Hooks
::run( 'BadImage', array( $name, &$bad ) ) ) {
4057 $cacheable = ( $blacklist === null );
4058 if ( $cacheable && $badImageCache !== null ) {
4059 $badImages = $badImageCache;
4060 } else { // cache miss
4061 if ( $blacklist === null ) {
4062 $blacklist = wfMessage( 'bad_image_list' )->inContentLanguage()->plain(); // site list
4064 # Build the list now
4065 $badImages = array();
4066 $lines = explode( "\n", $blacklist );
4067 foreach ( $lines as $line ) {
4069 if ( substr( $line, 0, 1 ) !== '*' ) {
4075 if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
4079 $exceptions = array();
4080 $imageDBkey = false;
4081 foreach ( $m[1] as $i => $titleText ) {
4082 $title = Title
::newFromText( $titleText );
4083 if ( !is_null( $title ) ) {
4085 $imageDBkey = $title->getDBkey();
4087 $exceptions[$title->getPrefixedDBkey()] = true;
4092 if ( $imageDBkey !== false ) {
4093 $badImages[$imageDBkey] = $exceptions;
4097 $badImageCache = $badImages;
4101 $contextKey = $contextTitle ?
$contextTitle->getPrefixedDBkey() : false;
4102 $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
4107 * Determine whether the client at a given source IP is likely to be able to
4108 * access the wiki via HTTPS.
4110 * @param string $ip The IPv4/6 address in the normal human-readable form
4113 function wfCanIPUseHTTPS( $ip ) {
4115 Hooks
::run( 'CanIPUseHTTPS', array( $ip, &$canDo ) );
4120 * Determine input string is represents as infinity
4122 * @param string $str The string to determine
4126 function wfIsInfinity( $str ) {
4127 $infinityValues = array( 'infinite', 'indefinite', 'infinity', 'never' );
4128 return in_array( $str, $infinityValues );
4132 * Work out the IP address based on various globals
4133 * For trusted proxies, use the XFF client IP (first of the chain)
4135 * @deprecated since 1.19; call $wgRequest->getIP() directly.
4138 function wfGetIP() {
4139 wfDeprecated( __METHOD__
, '1.19' );
4141 return $wgRequest->getIP();
4145 * Checks if an IP is a trusted proxy provider.
4146 * Useful to tell if X-Forwarded-For data is possibly bogus.
4147 * Squid cache servers for the site are whitelisted.
4148 * @deprecated Since 1.24, use IP::isTrustedProxy()
4153 function wfIsTrustedProxy( $ip ) {
4154 wfDeprecated( __METHOD__
, '1.24' );
4155 return IP
::isTrustedProxy( $ip );
4159 * Checks if an IP matches a proxy we've configured.
4160 * @deprecated Since 1.24, use IP::isConfiguredProxy()
4164 * @since 1.23 Supports CIDR ranges in $wgSquidServersNoPurge
4166 function wfIsConfiguredProxy( $ip ) {
4167 wfDeprecated( __METHOD__
, '1.24' );
4168 return IP
::isConfiguredProxy( $ip );
4172 * Returns true if these thumbnail parameters match one that MediaWiki
4173 * requests from file description pages and/or parser output.
4175 * $params is considered non-standard if they involve a non-standard
4176 * width or any non-default parameters aside from width and page number.
4177 * The number of possible files with standard parameters is far less than
4178 * that of all combinations; rate-limiting for them can thus be more generious.
4181 * @param array $params
4183 * @since 1.24 Moved from thumb.php to GlobalFunctions in 1.25
4185 function wfThumbIsStandard( File
$file, array $params ) {
4186 global $wgThumbLimits, $wgImageLimits, $wgResponsiveImages;
4188 $multipliers = array( 1 );
4189 if ( $wgResponsiveImages ) {
4190 // These available sizes are hardcoded currently elsewhere in MediaWiki.
4191 // @see Linker::processResponsiveImages
4192 $multipliers[] = 1.5;
4196 $handler = $file->getHandler();
4197 if ( !$handler ||
!isset( $params['width'] ) ) {
4201 $basicParams = array();
4202 if ( isset( $params['page'] ) ) {
4203 $basicParams['page'] = $params['page'];
4206 $thumbLimits = array();
4207 $imageLimits = array();
4208 // Expand limits to account for multipliers
4209 foreach ( $multipliers as $multiplier ) {
4210 $thumbLimits = array_merge( $thumbLimits, array_map(
4211 function ( $width ) use ( $multiplier ) {
4212 return round( $width * $multiplier );
4215 $imageLimits = array_merge( $imageLimits, array_map(
4216 function ( $pair ) use ( $multiplier ) {
4218 round( $pair[0] * $multiplier ),
4219 round( $pair[1] * $multiplier ),
4225 // Check if the width matches one of $wgThumbLimits
4226 if ( in_array( $params['width'], $thumbLimits ) ) {
4227 $normalParams = $basicParams +
array( 'width' => $params['width'] );
4228 // Append any default values to the map (e.g. "lossy", "lossless", ...)
4229 $handler->normaliseParams( $file, $normalParams );
4231 // If not, then check if the width matchs one of $wgImageLimits
4233 foreach ( $imageLimits as $pair ) {
4234 $normalParams = $basicParams +
array( 'width' => $pair[0], 'height' => $pair[1] );
4235 // Decide whether the thumbnail should be scaled on width or height.
4236 // Also append any default values to the map (e.g. "lossy", "lossless", ...)
4237 $handler->normaliseParams( $file, $normalParams );
4238 // Check if this standard thumbnail size maps to the given width
4239 if ( $normalParams['width'] == $params['width'] ) {
4245 return false; // not standard for description pages
4249 // Check that the given values for non-page, non-width, params are just defaults
4250 foreach ( $params as $key => $value ) {
4251 if ( !isset( $normalParams[$key] ) ||
$normalParams[$key] != $value ) {