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 $wgDebugLogGroups, $wgDebugRawPage;
1242 $context = RequestContext
::getMain();
1243 $request = $context->getRequest();
1245 $profiler = Profiler
::instance();
1246 $profiler->setContext( $context );
1247 $profiler->logData();
1249 $config = $context->getConfig();
1250 if ( $config->has( 'StatsdServer' ) ) {
1251 $statsdServer = explode( ':', $config->get( 'StatsdServer' ) );
1252 $statsdHost = $statsdServer[0];
1253 $statsdPort = isset( $statsdServer[1] ) ?
$statsdServer[1] : 8125;
1254 $statsdSender = new SocketSender( $statsdHost, $statsdPort );
1255 $statsdClient = new StatsdClient( $statsdSender );
1256 $statsdClient->send( $context->getStats()->getBuffer() );
1259 # Profiling must actually be enabled...
1260 if ( $profiler instanceof ProfilerStub
) {
1264 if ( isset( $wgDebugLogGroups['profileoutput'] )
1265 && $wgDebugLogGroups['profileoutput'] === false
1267 // Explicitly disabled
1270 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1274 $ctx = array( 'elapsed' => $request->getElapsedTime() );
1275 if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1276 $ctx['forwarded_for'] = $_SERVER['HTTP_X_FORWARDED_FOR'];
1278 if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1279 $ctx['client_ip'] = $_SERVER['HTTP_CLIENT_IP'];
1281 if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1282 $ctx['from'] = $_SERVER['HTTP_FROM'];
1284 if ( isset( $ctx['forwarded_for'] ) ||
1285 isset( $ctx['client_ip'] ) ||
1286 isset( $ctx['from'] ) ) {
1287 $ctx['proxy'] = $_SERVER['REMOTE_ADDR'];
1290 // Don't load $wgUser at this late stage just for statistics purposes
1291 // @todo FIXME: We can detect some anons even if it is not loaded.
1292 // See User::getId()
1293 $user = $context->getUser();
1294 $ctx['anon'] = $user->isItemLoaded( 'id' ) && $user->isAnon();
1296 // Command line script uses a FauxRequest object which does not have
1297 // any knowledge about an URL and throw an exception instead.
1299 $ctx['url'] = urldecode( $request->getRequestURL() );
1300 } catch ( Exception
$ignored ) {
1304 $ctx['output'] = $profiler->getOutput();
1306 $log = MWLoggerFactory
::getInstance( 'profileoutput' );
1307 $log->info( "Elapsed: {elapsed}; URL: <{url}>\n{output}", $ctx );
1311 * Increment a statistics counter
1313 * @param string $key
1317 function wfIncrStats( $key, $count = 1 ) {
1318 $stats = RequestContext
::getMain()->getStats();
1319 $stats->updateCount( $key, $count );
1323 * Check whether the wiki is in read-only mode.
1327 function wfReadOnly() {
1328 return wfReadOnlyReason() !== false;
1332 * Get the value of $wgReadOnly or the contents of $wgReadOnlyFile.
1334 * @return string|bool String when in read-only mode; false otherwise
1336 function wfReadOnlyReason() {
1337 global $wgReadOnly, $wgReadOnlyFile;
1339 if ( $wgReadOnly === null ) {
1340 // Set $wgReadOnly for faster access next time
1341 if ( is_file( $wgReadOnlyFile ) && filesize( $wgReadOnlyFile ) > 0 ) {
1342 $wgReadOnly = file_get_contents( $wgReadOnlyFile );
1344 $wgReadOnly = false;
1352 * Return a Language object from $langcode
1354 * @param Language|string|bool $langcode Either:
1355 * - a Language object
1356 * - code of the language to get the message for, if it is
1357 * a valid code create a language for that language, if
1358 * it is a string but not a valid code then make a basic
1360 * - a boolean: if it's false then use the global object for
1361 * the current user's language (as a fallback for the old parameter
1362 * functionality), or if it is true then use global object
1363 * for the wiki's content language.
1366 function wfGetLangObj( $langcode = false ) {
1367 # Identify which language to get or create a language object for.
1368 # Using is_object here due to Stub objects.
1369 if ( is_object( $langcode ) ) {
1370 # Great, we already have the object (hopefully)!
1374 global $wgContLang, $wgLanguageCode;
1375 if ( $langcode === true ||
$langcode === $wgLanguageCode ) {
1376 # $langcode is the language code of the wikis content language object.
1377 # or it is a boolean and value is true
1382 if ( $langcode === false ||
$langcode === $wgLang->getCode() ) {
1383 # $langcode is the language code of user language object.
1384 # or it was a boolean and value is false
1388 $validCodes = array_keys( Language
::fetchLanguageNames() );
1389 if ( in_array( $langcode, $validCodes ) ) {
1390 # $langcode corresponds to a valid language.
1391 return Language
::factory( $langcode );
1394 # $langcode is a string, but not a valid language code; use content language.
1395 wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1400 * This is the function for getting translated interface messages.
1402 * @see Message class for documentation how to use them.
1403 * @see https://www.mediawiki.org/wiki/Manual:Messages_API
1405 * This function replaces all old wfMsg* functions.
1407 * @param string|string[] $key Message key, or array of keys
1408 * @param mixed $params,... Normal message parameters
1413 * @see Message::__construct
1415 function wfMessage( $key /*...*/ ) {
1416 $params = func_get_args();
1417 array_shift( $params );
1418 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
1419 $params = $params[0];
1421 return new Message( $key, $params );
1425 * This function accepts multiple message keys and returns a message instance
1426 * for the first message which is non-empty. If all messages are empty then an
1427 * instance of the first message key is returned.
1429 * @param string|string[] $keys,... Message keys
1434 * @see Message::newFallbackSequence
1436 function wfMessageFallback( /*...*/ ) {
1437 $args = func_get_args();
1438 return call_user_func_array( 'Message::newFallbackSequence', $args );
1442 * Get a message from anywhere, for the current user language.
1444 * Use wfMsgForContent() instead if the message should NOT
1445 * change depending on the user preferences.
1447 * @deprecated since 1.18
1449 * @param string $key Lookup key for the message, usually
1450 * defined in languages/Language.php
1452 * Parameters to the message, which can be used to insert variable text into
1453 * it, can be passed to this function in the following formats:
1454 * - One per argument, starting at the second parameter
1455 * - As an array in the second parameter
1456 * These are not shown in the function definition.
1460 function wfMsg( $key ) {
1461 wfDeprecated( __METHOD__
, '1.21' );
1463 $args = func_get_args();
1464 array_shift( $args );
1465 return wfMsgReal( $key, $args );
1469 * Same as above except doesn't transform the message
1471 * @deprecated since 1.18
1473 * @param string $key
1476 function wfMsgNoTrans( $key ) {
1477 wfDeprecated( __METHOD__
, '1.21' );
1479 $args = func_get_args();
1480 array_shift( $args );
1481 return wfMsgReal( $key, $args, true, false, false );
1485 * Get a message from anywhere, for the current global language
1486 * set with $wgLanguageCode.
1488 * Use this if the message should NOT change dependent on the
1489 * language set in the user's preferences. This is the case for
1490 * most text written into logs, as well as link targets (such as
1491 * the name of the copyright policy page). Link titles, on the
1492 * other hand, should be shown in the UI language.
1494 * Note that MediaWiki allows users to change the user interface
1495 * language in their preferences, but a single installation
1496 * typically only contains content in one language.
1498 * Be wary of this distinction: If you use wfMsg() where you should
1499 * use wfMsgForContent(), a user of the software may have to
1500 * customize potentially hundreds of messages in
1501 * order to, e.g., fix a link in every possible language.
1503 * @deprecated since 1.18
1505 * @param string $key Lookup key for the message, usually
1506 * defined in languages/Language.php
1509 function wfMsgForContent( $key ) {
1510 wfDeprecated( __METHOD__
, '1.21' );
1512 global $wgForceUIMsgAsContentMsg;
1513 $args = func_get_args();
1514 array_shift( $args );
1516 if ( is_array( $wgForceUIMsgAsContentMsg )
1517 && in_array( $key, $wgForceUIMsgAsContentMsg )
1519 $forcontent = false;
1521 return wfMsgReal( $key, $args, true, $forcontent );
1525 * Same as above except doesn't transform the message
1527 * @deprecated since 1.18
1529 * @param string $key
1532 function wfMsgForContentNoTrans( $key ) {
1533 wfDeprecated( __METHOD__
, '1.21' );
1535 global $wgForceUIMsgAsContentMsg;
1536 $args = func_get_args();
1537 array_shift( $args );
1539 if ( is_array( $wgForceUIMsgAsContentMsg )
1540 && in_array( $key, $wgForceUIMsgAsContentMsg )
1542 $forcontent = false;
1544 return wfMsgReal( $key, $args, true, $forcontent, false );
1548 * Really get a message
1550 * @deprecated since 1.18
1552 * @param string $key Key to get.
1553 * @param array $args
1554 * @param bool $useDB
1555 * @param string|bool $forContent Language code, or false for user lang, true for content lang.
1556 * @param bool $transform Whether or not to transform the message.
1557 * @return string The requested message.
1559 function wfMsgReal( $key, $args, $useDB = true, $forContent = false, $transform = true ) {
1560 wfDeprecated( __METHOD__
, '1.21' );
1562 $message = wfMsgGetKey( $key, $useDB, $forContent, $transform );
1563 $message = wfMsgReplaceArgs( $message, $args );
1568 * Fetch a message string value, but don't replace any keys yet.
1570 * @deprecated since 1.18
1572 * @param string $key
1573 * @param bool $useDB
1574 * @param string|bool $langCode Code of the language to get the message for, or
1575 * behaves as a content language switch if it is a boolean.
1576 * @param bool $transform Whether to parse magic words, etc.
1579 function wfMsgGetKey( $key, $useDB = true, $langCode = false, $transform = true ) {
1580 wfDeprecated( __METHOD__
, '1.21' );
1582 Hooks
::run( 'NormalizeMessageKey', array( &$key, &$useDB, &$langCode, &$transform ) );
1584 $cache = MessageCache
::singleton();
1585 $message = $cache->get( $key, $useDB, $langCode );
1586 if ( $message === false ) {
1587 $message = '<' . htmlspecialchars( $key ) . '>';
1588 } elseif ( $transform ) {
1589 $message = $cache->transform( $message );
1595 * Replace message parameter keys on the given formatted output.
1597 * @param string $message
1598 * @param array $args
1602 function wfMsgReplaceArgs( $message, $args ) {
1603 # Fix windows line-endings
1604 # Some messages are split with explode("\n", $msg)
1605 $message = str_replace( "\r", '', $message );
1607 // Replace arguments
1608 if ( count( $args ) ) {
1609 if ( is_array( $args[0] ) ) {
1610 $args = array_values( $args[0] );
1612 $replacementKeys = array();
1613 foreach ( $args as $n => $param ) {
1614 $replacementKeys['$' . ( $n +
1 )] = $param;
1616 $message = strtr( $message, $replacementKeys );
1623 * Return an HTML-escaped version of a message.
1624 * Parameter replacements, if any, are done *after* the HTML-escaping,
1625 * so parameters may contain HTML (eg links or form controls). Be sure
1626 * to pre-escape them if you really do want plaintext, or just wrap
1627 * the whole thing in htmlspecialchars().
1629 * @deprecated since 1.18
1631 * @param string $key
1632 * @param string $args,... Parameters
1635 function wfMsgHtml( $key ) {
1636 wfDeprecated( __METHOD__
, '1.21' );
1638 $args = func_get_args();
1639 array_shift( $args );
1640 return wfMsgReplaceArgs( htmlspecialchars( wfMsgGetKey( $key ) ), $args );
1644 * Return an HTML version of message
1645 * Parameter replacements, if any, are done *after* parsing the wiki-text message,
1646 * so parameters may contain HTML (eg links or form controls). Be sure
1647 * to pre-escape them if you really do want plaintext, or just wrap
1648 * the whole thing in htmlspecialchars().
1650 * @deprecated since 1.18
1652 * @param string $key
1653 * @param string $args,... Parameters
1656 function wfMsgWikiHtml( $key ) {
1657 wfDeprecated( __METHOD__
, '1.21' );
1659 $args = func_get_args();
1660 array_shift( $args );
1661 return wfMsgReplaceArgs(
1662 MessageCache
::singleton()->parse( wfMsgGetKey( $key ), null,
1663 /* can't be set to false */ true, /* interface */ true )->getText(),
1668 * Returns message in the requested format
1670 * @deprecated since 1.18
1672 * @param string $key Key of the message
1673 * @param array $options Processing rules.
1674 * Can take the following options:
1675 * parse: parses wikitext to HTML
1676 * parseinline: parses wikitext to HTML and removes the surrounding
1677 * p's added by parser or tidy
1678 * escape: filters message through htmlspecialchars
1679 * escapenoentities: same, but allows entity references like   through
1680 * replaceafter: parameters are substituted after parsing or escaping
1681 * parsemag: transform the message using magic phrases
1682 * content: fetch message for content language instead of interface
1683 * Also can accept a single associative argument, of the form 'language' => 'xx':
1684 * language: Language object or language code to fetch message for
1685 * (overridden by content).
1686 * Behavior for conflicting options (e.g., parse+parseinline) is undefined.
1690 function wfMsgExt( $key, $options ) {
1691 wfDeprecated( __METHOD__
, '1.21' );
1693 $args = func_get_args();
1694 array_shift( $args );
1695 array_shift( $args );
1696 $options = (array)$options;
1697 $validOptions = array( 'parse', 'parseinline', 'escape', 'escapenoentities', 'replaceafter',
1698 'parsemag', 'content' );
1700 foreach ( $options as $arrayKey => $option ) {
1701 if ( !preg_match( '/^[0-9]+|language$/', $arrayKey ) ) {
1702 // An unknown index, neither numeric nor "language"
1703 wfWarn( "wfMsgExt called with incorrect parameter key $arrayKey", 1, E_USER_WARNING
);
1704 } elseif ( preg_match( '/^[0-9]+$/', $arrayKey ) && !in_array( $option, $validOptions ) ) {
1705 // A numeric index with unknown value
1706 wfWarn( "wfMsgExt called with incorrect parameter $option", 1, E_USER_WARNING
);
1710 if ( in_array( 'content', $options, true ) ) {
1713 $langCodeObj = null;
1714 } elseif ( array_key_exists( 'language', $options ) ) {
1715 $forContent = false;
1716 $langCode = wfGetLangObj( $options['language'] );
1717 $langCodeObj = $langCode;
1719 $forContent = false;
1721 $langCodeObj = null;
1724 $string = wfMsgGetKey( $key, /*DB*/true, $langCode, /*Transform*/false );
1726 if ( !in_array( 'replaceafter', $options, true ) ) {
1727 $string = wfMsgReplaceArgs( $string, $args );
1730 $messageCache = MessageCache
::singleton();
1731 $parseInline = in_array( 'parseinline', $options, true );
1732 if ( in_array( 'parse', $options, true ) ||
$parseInline ) {
1733 $string = $messageCache->parse( $string, null, true, !$forContent, $langCodeObj );
1734 if ( $string instanceof ParserOutput
) {
1735 $string = $string->getText();
1738 if ( $parseInline ) {
1739 $string = Parser
::stripOuterParagraph( $string );
1741 } elseif ( in_array( 'parsemag', $options, true ) ) {
1742 $string = $messageCache->transform( $string,
1743 !$forContent, $langCodeObj );
1746 if ( in_array( 'escape', $options, true ) ) {
1747 $string = htmlspecialchars ( $string );
1748 } elseif ( in_array( 'escapenoentities', $options, true ) ) {
1749 $string = Sanitizer
::escapeHtmlAllowEntities( $string );
1752 if ( in_array( 'replaceafter', $options, true ) ) {
1753 $string = wfMsgReplaceArgs( $string, $args );
1760 * Since wfMsg() and co suck, they don't return false if the message key they
1761 * looked up didn't exist but instead the key wrapped in <>'s, this function checks for the
1762 * nonexistence of messages by checking the MessageCache::get() result directly.
1764 * @deprecated since 1.18. Use Message::isDisabled().
1766 * @param string $key The message key looked up
1767 * @return bool True if the message *doesn't* exist.
1769 function wfEmptyMsg( $key ) {
1770 wfDeprecated( __METHOD__
, '1.21' );
1772 return MessageCache
::singleton()->get( $key, /*useDB*/true, /*content*/false ) === false;
1776 * Fetch server name for use in error reporting etc.
1777 * Use real server name if available, so we know which machine
1778 * in a server farm generated the current page.
1782 function wfHostname() {
1784 if ( is_null( $host ) ) {
1786 # Hostname overriding
1787 global $wgOverrideHostname;
1788 if ( $wgOverrideHostname !== false ) {
1789 # Set static and skip any detection
1790 $host = $wgOverrideHostname;
1794 if ( function_exists( 'posix_uname' ) ) {
1795 // This function not present on Windows
1796 $uname = posix_uname();
1800 if ( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1801 $host = $uname['nodename'];
1802 } elseif ( getenv( 'COMPUTERNAME' ) ) {
1803 # Windows computer name
1804 $host = getenv( 'COMPUTERNAME' );
1806 # This may be a virtual server.
1807 $host = $_SERVER['SERVER_NAME'];
1814 * Returns a script tag that stores the amount of time it took MediaWiki to
1815 * handle the request in milliseconds as 'wgBackendResponseTime'.
1817 * If $wgShowHostnames is true, the script will also set 'wgHostname' to the
1818 * hostname of the server handling the request.
1822 function wfReportTime() {
1823 global $wgRequestTime, $wgShowHostnames;
1825 $responseTime = round( ( microtime( true ) - $wgRequestTime ) * 1000 );
1826 $reportVars = array( 'wgBackendResponseTime' => $responseTime );
1827 if ( $wgShowHostnames ) {
1828 $reportVars['wgHostname'] = wfHostname();
1830 return Skin
::makeVariablesScript( $reportVars );
1834 * Safety wrapper for debug_backtrace().
1836 * Will return an empty array if debug_backtrace is disabled, otherwise
1837 * the output from debug_backtrace() (trimmed).
1839 * @param int $limit This parameter can be used to limit the number of stack frames returned
1841 * @return array Array of backtrace information
1843 function wfDebugBacktrace( $limit = 0 ) {
1844 static $disabled = null;
1846 if ( is_null( $disabled ) ) {
1847 $disabled = !function_exists( 'debug_backtrace' );
1849 wfDebug( "debug_backtrace() is disabled\n" );
1856 if ( $limit && version_compare( PHP_VERSION
, '5.4.0', '>=' ) ) {
1857 return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT
, $limit +
1 ), 1 );
1859 return array_slice( debug_backtrace(), 1 );
1864 * Get a debug backtrace as a string
1866 * @param bool|null $raw If true, the return value is plain text. If false, HTML.
1867 * Defaults to $wgCommandLineMode if unset.
1869 * @since 1.25 Supports $raw parameter.
1871 function wfBacktrace( $raw = null ) {
1872 global $wgCommandLineMode;
1874 if ( $raw === null ) {
1875 $raw = $wgCommandLineMode;
1879 $frameFormat = "%s line %s calls %s()\n";
1880 $traceFormat = "%s";
1882 $frameFormat = "<li>%s line %s calls %s()</li>\n";
1883 $traceFormat = "<ul>\n%s</ul>\n";
1886 $frames = array_map( function ( $frame ) use ( $frameFormat ) {
1887 $file = !empty( $frame['file'] ) ?
basename( $frame['file'] ) : '-';
1888 $line = isset( $frame['line'] ) ?
$frame['line'] : '-';
1889 $call = $frame['function'];
1890 if ( !empty( $frame['class'] ) ) {
1891 $call = $frame['class'] . $frame['type'] . $call;
1893 return sprintf( $frameFormat, $file, $line, $call );
1894 }, wfDebugBacktrace() );
1896 return sprintf( $traceFormat, implode( '', $frames ) );
1900 * Get the name of the function which called this function
1901 * wfGetCaller( 1 ) is the function with the wfGetCaller() call (ie. __FUNCTION__)
1902 * wfGetCaller( 2 ) [default] is the caller of the function running wfGetCaller()
1903 * wfGetCaller( 3 ) is the parent of that.
1908 function wfGetCaller( $level = 2 ) {
1909 $backtrace = wfDebugBacktrace( $level +
1 );
1910 if ( isset( $backtrace[$level] ) ) {
1911 return wfFormatStackFrame( $backtrace[$level] );
1918 * Return a string consisting of callers in the stack. Useful sometimes
1919 * for profiling specific points.
1921 * @param int $limit The maximum depth of the stack frame to return, or false for the entire stack.
1924 function wfGetAllCallers( $limit = 3 ) {
1925 $trace = array_reverse( wfDebugBacktrace() );
1926 if ( !$limit ||
$limit > count( $trace ) - 1 ) {
1927 $limit = count( $trace ) - 1;
1929 $trace = array_slice( $trace, -$limit - 1, $limit );
1930 return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1934 * Return a string representation of frame
1936 * @param array $frame
1939 function wfFormatStackFrame( $frame ) {
1940 return isset( $frame['class'] ) ?
1941 $frame['class'] . '::' . $frame['function'] :
1945 /* Some generic result counters, pulled out of SearchEngine */
1950 * @param int $offset
1954 function wfShowingResults( $offset, $limit ) {
1955 return wfMessage( 'showingresults' )->numParams( $limit, $offset +
1 )->parse();
1960 * @todo FIXME: We may want to blacklist some broken browsers
1962 * @param bool $force
1963 * @return bool Whereas client accept gzip compression
1965 function wfClientAcceptsGzip( $force = false ) {
1966 static $result = null;
1967 if ( $result === null ||
$force ) {
1969 if ( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
1970 # @todo FIXME: We may want to blacklist some broken browsers
1973 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
1974 $_SERVER['HTTP_ACCEPT_ENCODING'],
1978 if ( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
1982 wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
1991 * Obtain the offset and limit values from the request string;
1992 * used in special pages
1994 * @param int $deflimit Default limit if none supplied
1995 * @param string $optionname Name of a user preference to check against
1997 * @deprecated since 1.24, just call WebRequest::getLimitOffset() directly
1999 function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
2001 wfDeprecated( __METHOD__
, '1.24' );
2002 return $wgRequest->getLimitOffset( $deflimit, $optionname );
2006 * Escapes the given text so that it may be output using addWikiText()
2007 * without any linking, formatting, etc. making its way through. This
2008 * is achieved by substituting certain characters with HTML entities.
2009 * As required by the callers, "<nowiki>" is not used.
2011 * @param string $text Text to be escaped
2014 function wfEscapeWikiText( $text ) {
2015 static $repl = null, $repl2 = null;
2016 if ( $repl === null ) {
2018 '"' => '"', '&' => '&', "'" => ''', '<' => '<',
2019 '=' => '=', '>' => '>', '[' => '[', ']' => ']',
2020 '{' => '{', '|' => '|', '}' => '}', ';' => ';',
2021 "\n#" => "\n#", "\r#" => "\r#",
2022 "\n*" => "\n*", "\r*" => "\r*",
2023 "\n:" => "\n:", "\r:" => "\r:",
2024 "\n " => "\n ", "\r " => "\r ",
2025 "\n\n" => "\n ", "\r\n" => " \n",
2026 "\n\r" => "\n ", "\r\r" => "\r ",
2027 "\n\t" => "\n	", "\r\t" => "\r	", // "\n\t\n" is treated like "\n\n"
2028 "\n----" => "\n----", "\r----" => "\r----",
2029 '__' => '__', '://' => '://',
2032 // We have to catch everything "\s" matches in PCRE
2033 foreach ( array( 'ISBN', 'RFC', 'PMID' ) as $magic ) {
2034 $repl["$magic "] = "$magic ";
2035 $repl["$magic\t"] = "$magic	";
2036 $repl["$magic\r"] = "$magic ";
2037 $repl["$magic\n"] = "$magic ";
2038 $repl["$magic\f"] = "$magic";
2041 // And handle protocols that don't use "://"
2042 global $wgUrlProtocols;
2044 foreach ( $wgUrlProtocols as $prot ) {
2045 if ( substr( $prot, -1 ) === ':' ) {
2046 $repl2[] = preg_quote( substr( $prot, 0, -1 ), '/' );
2049 $repl2 = $repl2 ?
'/\b(' . join( '|', $repl2 ) . '):/i' : '/^(?!)/';
2051 $text = substr( strtr( "\n$text", $repl ), 1 );
2052 $text = preg_replace( $repl2, '$1:', $text );
2057 * Sets dest to source and returns the original value of dest
2058 * If source is NULL, it just returns the value, it doesn't set the variable
2059 * If force is true, it will set the value even if source is NULL
2061 * @param mixed $dest
2062 * @param mixed $source
2063 * @param bool $force
2066 function wfSetVar( &$dest, $source, $force = false ) {
2068 if ( !is_null( $source ) ||
$force ) {
2075 * As for wfSetVar except setting a bit
2079 * @param bool $state
2083 function wfSetBit( &$dest, $bit, $state = true ) {
2084 $temp = (bool)( $dest & $bit );
2085 if ( !is_null( $state ) ) {
2096 * A wrapper around the PHP function var_export().
2097 * Either print it or add it to the regular output ($wgOut).
2099 * @param mixed $var A PHP variable to dump.
2101 function wfVarDump( $var ) {
2103 $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
2104 if ( headers_sent() ||
!isset( $wgOut ) ||
!is_object( $wgOut ) ) {
2107 $wgOut->addHTML( $s );
2112 * Provide a simple HTTP error.
2114 * @param int|string $code
2115 * @param string $label
2116 * @param string $desc
2118 function wfHttpError( $code, $label, $desc ) {
2120 header( "HTTP/1.0 $code $label" );
2121 header( "Status: $code $label" );
2124 $wgOut->sendCacheControl();
2127 header( 'Content-type: text/html; charset=utf-8' );
2128 print "<!doctype html>" .
2129 '<html><head><title>' .
2130 htmlspecialchars( $label ) .
2131 '</title></head><body><h1>' .
2132 htmlspecialchars( $label ) .
2134 nl2br( htmlspecialchars( $desc ) ) .
2135 "</p></body></html>\n";
2139 * Clear away any user-level output buffers, discarding contents.
2141 * Suitable for 'starting afresh', for instance when streaming
2142 * relatively large amounts of data without buffering, or wanting to
2143 * output image files without ob_gzhandler's compression.
2145 * The optional $resetGzipEncoding parameter controls suppression of
2146 * the Content-Encoding header sent by ob_gzhandler; by default it
2147 * is left. See comments for wfClearOutputBuffers() for why it would
2150 * Note that some PHP configuration options may add output buffer
2151 * layers which cannot be removed; these are left in place.
2153 * @param bool $resetGzipEncoding
2155 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
2156 if ( $resetGzipEncoding ) {
2157 // Suppress Content-Encoding and Content-Length
2158 // headers from 1.10+s wfOutputHandler
2159 global $wgDisableOutputCompression;
2160 $wgDisableOutputCompression = true;
2162 while ( $status = ob_get_status() ) {
2163 if ( $status['type'] == 0 /* PHP_OUTPUT_HANDLER_INTERNAL */ ) {
2164 // Probably from zlib.output_compression or other
2165 // PHP-internal setting which can't be removed.
2167 // Give up, and hope the result doesn't break
2171 if ( !ob_end_clean() ) {
2172 // Could not remove output buffer handler; abort now
2173 // to avoid getting in some kind of infinite loop.
2176 if ( $resetGzipEncoding ) {
2177 if ( $status['name'] == 'ob_gzhandler' ) {
2178 // Reset the 'Content-Encoding' field set by this handler
2179 // so we can start fresh.
2180 header_remove( 'Content-Encoding' );
2188 * More legible than passing a 'false' parameter to wfResetOutputBuffers():
2190 * Clear away output buffers, but keep the Content-Encoding header
2191 * produced by ob_gzhandler, if any.
2193 * This should be used for HTTP 304 responses, where you need to
2194 * preserve the Content-Encoding header of the real result, but
2195 * also need to suppress the output of ob_gzhandler to keep to spec
2196 * and avoid breaking Firefox in rare cases where the headers and
2197 * body are broken over two packets.
2199 function wfClearOutputBuffers() {
2200 wfResetOutputBuffers( false );
2204 * Converts an Accept-* header into an array mapping string values to quality
2207 * @param string $accept
2208 * @param string $def Default
2209 * @return float[] Associative array of string => float pairs
2211 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
2212 # No arg means accept anything (per HTTP spec)
2214 return array( $def => 1.0 );
2219 $parts = explode( ',', $accept );
2221 foreach ( $parts as $part ) {
2222 # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
2223 $values = explode( ';', trim( $part ) );
2225 if ( count( $values ) == 1 ) {
2226 $prefs[$values[0]] = 1.0;
2227 } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
2228 $prefs[$values[0]] = floatval( $match[1] );
2236 * Checks if a given MIME type matches any of the keys in the given
2237 * array. Basic wildcards are accepted in the array keys.
2239 * Returns the matching MIME type (or wildcard) if a match, otherwise
2242 * @param string $type
2243 * @param array $avail
2247 function mimeTypeMatch( $type, $avail ) {
2248 if ( array_key_exists( $type, $avail ) ) {
2251 $parts = explode( '/', $type );
2252 if ( array_key_exists( $parts[0] . '/*', $avail ) ) {
2253 return $parts[0] . '/*';
2254 } elseif ( array_key_exists( '*/*', $avail ) ) {
2263 * Returns the 'best' match between a client's requested internet media types
2264 * and the server's list of available types. Each list should be an associative
2265 * array of type to preference (preference is a float between 0.0 and 1.0).
2266 * Wildcards in the types are acceptable.
2268 * @param array $cprefs Client's acceptable type list
2269 * @param array $sprefs Server's offered types
2272 * @todo FIXME: Doesn't handle params like 'text/plain; charset=UTF-8'
2273 * XXX: generalize to negotiate other stuff
2275 function wfNegotiateType( $cprefs, $sprefs ) {
2278 foreach ( array_keys( $sprefs ) as $type ) {
2279 $parts = explode( '/', $type );
2280 if ( $parts[1] != '*' ) {
2281 $ckey = mimeTypeMatch( $type, $cprefs );
2283 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
2288 foreach ( array_keys( $cprefs ) as $type ) {
2289 $parts = explode( '/', $type );
2290 if ( $parts[1] != '*' && !array_key_exists( $type, $sprefs ) ) {
2291 $skey = mimeTypeMatch( $type, $sprefs );
2293 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
2301 foreach ( array_keys( $combine ) as $type ) {
2302 if ( $combine[$type] > $bestq ) {
2304 $bestq = $combine[$type];
2312 * Reference-counted warning suppression
2316 function wfSuppressWarnings( $end = false ) {
2317 static $suppressCount = 0;
2318 static $originalLevel = false;
2321 if ( $suppressCount ) {
2323 if ( !$suppressCount ) {
2324 error_reporting( $originalLevel );
2328 if ( !$suppressCount ) {
2329 $originalLevel = error_reporting( E_ALL
& ~
(
2344 * Restore error level to previous value
2346 function wfRestoreWarnings() {
2347 wfSuppressWarnings( true );
2350 # Autodetect, convert and provide timestamps of various types
2353 * Unix time - the number of seconds since 1970-01-01 00:00:00 UTC
2355 define( 'TS_UNIX', 0 );
2358 * MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
2360 define( 'TS_MW', 1 );
2363 * MySQL DATETIME (YYYY-MM-DD HH:MM:SS)
2365 define( 'TS_DB', 2 );
2368 * RFC 2822 format, for E-mail and HTTP headers
2370 define( 'TS_RFC2822', 3 );
2373 * ISO 8601 format with no timezone: 1986-02-09T20:00:00Z
2375 * This is used by Special:Export
2377 define( 'TS_ISO_8601', 4 );
2380 * An Exif timestamp (YYYY:MM:DD HH:MM:SS)
2382 * @see http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the
2383 * DateTime tag and page 36 for the DateTimeOriginal and
2384 * DateTimeDigitized tags.
2386 define( 'TS_EXIF', 5 );
2389 * Oracle format time.
2391 define( 'TS_ORACLE', 6 );
2394 * Postgres format time.
2396 define( 'TS_POSTGRES', 7 );
2399 * ISO 8601 basic format with no timezone: 19860209T200000Z. This is used by ResourceLoader
2401 define( 'TS_ISO_8601_BASIC', 9 );
2404 * Get a timestamp string in one of various formats
2406 * @param mixed $outputtype A timestamp in one of the supported formats, the
2407 * function will autodetect which format is supplied and act accordingly.
2408 * @param mixed $ts Optional timestamp to convert, default 0 for the current time
2409 * @return string|bool String / false The same date in the format specified in $outputtype or false
2411 function wfTimestamp( $outputtype = TS_UNIX
, $ts = 0 ) {
2413 $timestamp = new MWTimestamp( $ts );
2414 return $timestamp->getTimestamp( $outputtype );
2415 } catch ( TimestampException
$e ) {
2416 wfDebug( "wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n" );
2422 * Return a formatted timestamp, or null if input is null.
2423 * For dealing with nullable timestamp columns in the database.
2425 * @param int $outputtype
2429 function wfTimestampOrNull( $outputtype = TS_UNIX
, $ts = null ) {
2430 if ( is_null( $ts ) ) {
2433 return wfTimestamp( $outputtype, $ts );
2438 * Convenience function; returns MediaWiki timestamp for the present time.
2442 function wfTimestampNow() {
2444 return wfTimestamp( TS_MW
, time() );
2448 * Check if the operating system is Windows
2450 * @return bool True if it's Windows, false otherwise.
2452 function wfIsWindows() {
2453 static $isWindows = null;
2454 if ( $isWindows === null ) {
2455 $isWindows = substr( php_uname(), 0, 7 ) == 'Windows';
2461 * Check if we are running under HHVM
2465 function wfIsHHVM() {
2466 return defined( 'HHVM_VERSION' );
2470 * Swap two variables
2472 * @deprecated since 1.24
2476 function swap( &$x, &$y ) {
2477 wfDeprecated( __FUNCTION__
, '1.24' );
2484 * Tries to get the system directory for temporary files. First
2485 * $wgTmpDirectory is checked, and then the TMPDIR, TMP, and TEMP
2486 * environment variables are then checked in sequence, and if none are
2487 * set try sys_get_temp_dir().
2489 * NOTE: When possible, use instead the tmpfile() function to create
2490 * temporary files to avoid race conditions on file creation, etc.
2494 function wfTempDir() {
2495 global $wgTmpDirectory;
2497 if ( $wgTmpDirectory !== false ) {
2498 return $wgTmpDirectory;
2501 $tmpDir = array_map( "getenv", array( 'TMPDIR', 'TMP', 'TEMP' ) );
2503 foreach ( $tmpDir as $tmp ) {
2504 if ( $tmp && file_exists( $tmp ) && is_dir( $tmp ) && is_writable( $tmp ) ) {
2508 return sys_get_temp_dir();
2512 * Make directory, and make all parent directories if they don't exist
2514 * @param string $dir Full path to directory to create
2515 * @param int $mode Chmod value to use, default is $wgDirectoryMode
2516 * @param string $caller Optional caller param for debugging.
2517 * @throws MWException
2520 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2521 global $wgDirectoryMode;
2523 if ( FileBackend
::isStoragePath( $dir ) ) { // sanity
2524 throw new MWException( __FUNCTION__
. " given storage path '$dir'." );
2527 if ( !is_null( $caller ) ) {
2528 wfDebug( "$caller: called wfMkdirParents($dir)\n" );
2531 if ( strval( $dir ) === '' ||
( file_exists( $dir ) && is_dir( $dir ) ) ) {
2535 $dir = str_replace( array( '\\', '/' ), DIRECTORY_SEPARATOR
, $dir );
2537 if ( is_null( $mode ) ) {
2538 $mode = $wgDirectoryMode;
2541 // Turn off the normal warning, we're doing our own below
2542 wfSuppressWarnings();
2543 $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2544 wfRestoreWarnings();
2547 //directory may have been created on another request since we last checked
2548 if ( is_dir( $dir ) ) {
2552 // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2553 wfLogWarning( sprintf( "failed to mkdir \"%s\" mode 0%o", $dir, $mode ) );
2559 * Remove a directory and all its content.
2560 * Does not hide error.
2561 * @param string $dir
2563 function wfRecursiveRemoveDir( $dir ) {
2564 wfDebug( __FUNCTION__
. "( $dir )\n" );
2565 // taken from http://de3.php.net/manual/en/function.rmdir.php#98622
2566 if ( is_dir( $dir ) ) {
2567 $objects = scandir( $dir );
2568 foreach ( $objects as $object ) {
2569 if ( $object != "." && $object != ".." ) {
2570 if ( filetype( $dir . '/' . $object ) == "dir" ) {
2571 wfRecursiveRemoveDir( $dir . '/' . $object );
2573 unlink( $dir . '/' . $object );
2583 * @param int $nr The number to format
2584 * @param int $acc The number of digits after the decimal point, default 2
2585 * @param bool $round Whether or not to round the value, default true
2588 function wfPercent( $nr, $acc = 2, $round = true ) {
2589 $ret = sprintf( "%.${acc}f", $nr );
2590 return $round ?
round( $ret, $acc ) . '%' : "$ret%";
2594 * Safety wrapper around ini_get() for boolean settings.
2595 * The values returned from ini_get() are pre-normalized for settings
2596 * set via php.ini or php_flag/php_admin_flag... but *not*
2597 * for those set via php_value/php_admin_value.
2599 * It's fairly common for people to use php_value instead of php_flag,
2600 * which can leave you with an 'off' setting giving a false positive
2601 * for code that just takes the ini_get() return value as a boolean.
2603 * To make things extra interesting, setting via php_value accepts
2604 * "true" and "yes" as true, but php.ini and php_flag consider them false. :)
2605 * Unrecognized values go false... again opposite PHP's own coercion
2606 * from string to bool.
2608 * Luckily, 'properly' set settings will always come back as '0' or '1',
2609 * so we only have to worry about them and the 'improper' settings.
2611 * I frickin' hate PHP... :P
2613 * @param string $setting
2616 function wfIniGetBool( $setting ) {
2617 $val = strtolower( ini_get( $setting ) );
2618 // 'on' and 'true' can't have whitespace around them, but '1' can.
2622 ||
preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2626 * Windows-compatible version of escapeshellarg()
2627 * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
2628 * function puts single quotes in regardless of OS.
2630 * Also fixes the locale problems on Linux in PHP 5.2.6+ (bug backported to
2631 * earlier distro releases of PHP)
2633 * @param string ... strings to escape and glue together, or a single array of strings parameter
2636 function wfEscapeShellArg( /*...*/ ) {
2637 wfInitShellLocale();
2639 $args = func_get_args();
2640 if ( count( $args ) === 1 && is_array( reset( $args ) ) ) {
2641 // If only one argument has been passed, and that argument is an array,
2642 // treat it as a list of arguments
2643 $args = reset( $args );
2648 foreach ( $args as $arg ) {
2655 if ( wfIsWindows() ) {
2656 // Escaping for an MSVC-style command line parser and CMD.EXE
2657 // @codingStandardsIgnoreStart For long URLs
2659 // * http://web.archive.org/web/20020708081031/http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
2660 // * http://technet.microsoft.com/en-us/library/cc723564.aspx
2663 // Double the backslashes before any double quotes. Escape the double quotes.
2664 // @codingStandardsIgnoreEnd
2665 $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE
);
2668 foreach ( $tokens as $token ) {
2669 if ( $iteration %
2 == 1 ) {
2670 // Delimiter, a double quote preceded by zero or more slashes
2671 $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
2672 } elseif ( $iteration %
4 == 2 ) {
2673 // ^ in $token will be outside quotes, need to be escaped
2674 $arg .= str_replace( '^', '^^', $token );
2675 } else { // $iteration % 4 == 0
2676 // ^ in $token will appear inside double quotes, so leave as is
2681 // Double the backslashes before the end of the string, because
2682 // we will soon add a quote
2684 if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
2685 $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
2688 // Add surrounding quotes
2689 $retVal .= '"' . $arg . '"';
2691 $retVal .= escapeshellarg( $arg );
2698 * Check if wfShellExec() is effectively disabled via php.ini config
2700 * @return bool|string False or one of (safemode,disabled)
2703 function wfShellExecDisabled() {
2704 static $disabled = null;
2705 if ( is_null( $disabled ) ) {
2706 if ( wfIniGetBool( 'safe_mode' ) ) {
2707 wfDebug( "wfShellExec can't run in safe_mode, PHP's exec functions are too broken.\n" );
2708 $disabled = 'safemode';
2709 } elseif ( !function_exists( 'proc_open' ) ) {
2710 wfDebug( "proc_open() is disabled\n" );
2711 $disabled = 'disabled';
2720 * Execute a shell command, with time and memory limits mirrored from the PHP
2721 * configuration if supported.
2723 * @param string|string[] $cmd If string, a properly shell-escaped command line,
2724 * or an array of unescaped arguments, in which case each value will be escaped
2725 * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
2726 * @param null|mixed &$retval Optional, will receive the program's exit code.
2727 * (non-zero is usually failure). If there is an error from
2728 * read, select, or proc_open(), this will be set to -1.
2729 * @param array $environ Optional environment variables which should be
2730 * added to the executed command environment.
2731 * @param array $limits Optional array with limits(filesize, memory, time, walltime)
2732 * this overwrites the global wgMaxShell* limits.
2733 * @param array $options Array of options:
2734 * - duplicateStderr: Set this to true to duplicate stderr to stdout,
2735 * including errors from limit.sh
2736 * - profileMethod: By default this function will profile based on the calling
2737 * method. Set this to a string for an alternative method to profile from
2739 * @return string Collected stdout as a string
2741 function wfShellExec( $cmd, &$retval = null, $environ = array(),
2742 $limits = array(), $options = array()
2744 global $IP, $wgMaxShellMemory, $wgMaxShellFileSize, $wgMaxShellTime,
2745 $wgMaxShellWallClockTime, $wgShellCgroup;
2747 $disabled = wfShellExecDisabled();
2750 return $disabled == 'safemode' ?
2751 'Unable to run external programs in safe mode.' :
2752 'Unable to run external programs, proc_open() is disabled.';
2755 $includeStderr = isset( $options['duplicateStderr'] ) && $options['duplicateStderr'];
2756 $profileMethod = isset( $options['profileMethod'] ) ?
$options['profileMethod'] : wfGetCaller();
2758 wfInitShellLocale();
2761 foreach ( $environ as $k => $v ) {
2762 if ( wfIsWindows() ) {
2763 /* Surrounding a set in quotes (method used by wfEscapeShellArg) makes the quotes themselves
2764 * appear in the environment variable, so we must use carat escaping as documented in
2765 * http://technet.microsoft.com/en-us/library/cc723564.aspx
2766 * Note however that the quote isn't listed there, but is needed, and the parentheses
2767 * are listed there but doesn't appear to need it.
2769 $envcmd .= "set $k=" . preg_replace( '/([&|()<>^"])/', '^\\1', $v ) . '&& ';
2771 /* Assume this is a POSIX shell, thus required to accept variable assignments before the command
2772 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_09_01
2774 $envcmd .= "$k=" . escapeshellarg( $v ) . ' ';
2777 if ( is_array( $cmd ) ) {
2778 $cmd = wfEscapeShellArg( $cmd );
2781 $cmd = $envcmd . $cmd;
2783 $useLogPipe = false;
2784 if ( is_executable( '/bin/bash' ) ) {
2785 $time = intval ( isset( $limits['time'] ) ?
$limits['time'] : $wgMaxShellTime );
2786 if ( isset( $limits['walltime'] ) ) {
2787 $wallTime = intval( $limits['walltime'] );
2788 } elseif ( isset( $limits['time'] ) ) {
2791 $wallTime = intval( $wgMaxShellWallClockTime );
2793 $mem = intval ( isset( $limits['memory'] ) ?
$limits['memory'] : $wgMaxShellMemory );
2794 $filesize = intval ( isset( $limits['filesize'] ) ?
$limits['filesize'] : $wgMaxShellFileSize );
2796 if ( $time > 0 ||
$mem > 0 ||
$filesize > 0 ||
$wallTime > 0 ) {
2797 $cmd = '/bin/bash ' . escapeshellarg( "$IP/includes/limit.sh" ) . ' ' .
2798 escapeshellarg( $cmd ) . ' ' .
2800 "MW_INCLUDE_STDERR=" . ( $includeStderr ?
'1' : '' ) . ';' .
2801 "MW_CPU_LIMIT=$time; " .
2802 'MW_CGROUP=' . escapeshellarg( $wgShellCgroup ) . '; ' .
2803 "MW_MEM_LIMIT=$mem; " .
2804 "MW_FILE_SIZE_LIMIT=$filesize; " .
2805 "MW_WALL_CLOCK_LIMIT=$wallTime; " .
2806 "MW_USE_LOG_PIPE=yes"
2809 } elseif ( $includeStderr ) {
2812 } elseif ( $includeStderr ) {
2815 wfDebug( "wfShellExec: $cmd\n" );
2818 0 => array( 'file', 'php://stdin', 'r' ),
2819 1 => array( 'pipe', 'w' ),
2820 2 => array( 'file', 'php://stderr', 'w' ) );
2821 if ( $useLogPipe ) {
2822 $desc[3] = array( 'pipe', 'w' );
2825 $scoped = Profiler
::instance()->scopedProfileIn( __FUNCTION__
. '-' . $profileMethod );
2826 $proc = proc_open( $cmd, $desc, $pipes );
2828 wfDebugLog( 'exec', "proc_open() failed: $cmd" );
2832 $outBuffer = $logBuffer = '';
2833 $emptyArray = array();
2837 // According to the documentation, it is possible for stream_select()
2838 // to fail due to EINTR. I haven't managed to induce this in testing
2839 // despite sending various signals. If it did happen, the error
2840 // message would take the form:
2842 // stream_select(): unable to select [4]: Interrupted system call (max_fd=5)
2844 // where [4] is the value of the macro EINTR and "Interrupted system
2845 // call" is string which according to the Linux manual is "possibly"
2846 // localised according to LC_MESSAGES.
2847 $eintr = defined( 'SOCKET_EINTR' ) ? SOCKET_EINTR
: 4;
2848 $eintrMessage = "stream_select(): unable to select [$eintr]";
2850 // Build a table mapping resource IDs to pipe FDs to work around a
2851 // PHP 5.3 issue in which stream_select() does not preserve array keys
2852 // <https://bugs.php.net/bug.php?id=53427>.
2854 foreach ( $pipes as $fd => $pipe ) {
2855 $fds[(int)$pipe] = $fd;
2862 while ( $running === true ||
$numReadyPipes !== 0 ) {
2864 $status = proc_get_status( $proc );
2865 // If the process has terminated, switch to nonblocking selects
2866 // for getting any data still waiting to be read.
2867 if ( !$status['running'] ) {
2873 $readyPipes = $pipes;
2876 // @codingStandardsIgnoreStart Generic.PHP.NoSilencedErrors.Discouraged
2877 @trigger_error
( '' );
2878 $numReadyPipes = @stream_select
( $readyPipes, $emptyArray, $emptyArray, $timeout );
2879 if ( $numReadyPipes === false ) {
2880 // @codingStandardsIgnoreEnd
2881 $error = error_get_last();
2882 if ( strncmp( $error['message'], $eintrMessage, strlen( $eintrMessage ) ) == 0 ) {
2885 trigger_error( $error['message'], E_USER_WARNING
);
2886 $logMsg = $error['message'];
2890 foreach ( $readyPipes as $pipe ) {
2891 $block = fread( $pipe, 65536 );
2892 $fd = $fds[(int)$pipe];
2893 if ( $block === '' ) {
2895 fclose( $pipes[$fd] );
2896 unset( $pipes[$fd] );
2900 } elseif ( $block === false ) {
2902 $logMsg = "Error reading from pipe";
2904 } elseif ( $fd == 1 ) {
2906 $outBuffer .= $block;
2907 } elseif ( $fd == 3 ) {
2909 $logBuffer .= $block;
2910 if ( strpos( $block, "\n" ) !== false ) {
2911 $lines = explode( "\n", $logBuffer );
2912 $logBuffer = array_pop( $lines );
2913 foreach ( $lines as $line ) {
2914 wfDebugLog( 'exec', $line );
2921 foreach ( $pipes as $pipe ) {
2925 // Use the status previously collected if possible, since proc_get_status()
2926 // just calls waitpid() which will not return anything useful the second time.
2928 $status = proc_get_status( $proc );
2931 if ( $logMsg !== false ) {
2932 // Read/select error
2934 proc_close( $proc );
2935 } elseif ( $status['signaled'] ) {
2936 $logMsg = "Exited with signal {$status['termsig']}";
2937 $retval = 128 +
$status['termsig'];
2938 proc_close( $proc );
2940 if ( $status['running'] ) {
2941 $retval = proc_close( $proc );
2943 $retval = $status['exitcode'];
2944 proc_close( $proc );
2946 if ( $retval == 127 ) {
2947 $logMsg = "Possibly missing executable file";
2948 } elseif ( $retval >= 129 && $retval <= 192 ) {
2949 $logMsg = "Probably exited with signal " . ( $retval - 128 );
2953 if ( $logMsg !== false ) {
2954 wfDebugLog( 'exec', "$logMsg: $cmd" );
2961 * Execute a shell command, returning both stdout and stderr. Convenience
2962 * function, as all the arguments to wfShellExec can become unwieldy.
2964 * @note This also includes errors from limit.sh, e.g. if $wgMaxShellFileSize is exceeded.
2965 * @param string|string[] $cmd If string, a properly shell-escaped command line,
2966 * or an array of unescaped arguments, in which case each value will be escaped
2967 * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
2968 * @param null|mixed &$retval Optional, will receive the program's exit code.
2969 * (non-zero is usually failure)
2970 * @param array $environ Optional environment variables which should be
2971 * added to the executed command environment.
2972 * @param array $limits Optional array with limits(filesize, memory, time, walltime)
2973 * this overwrites the global wgMaxShell* limits.
2974 * @return string Collected stdout and stderr as a string
2976 function wfShellExecWithStderr( $cmd, &$retval = null, $environ = array(), $limits = array() ) {
2977 return wfShellExec( $cmd, $retval, $environ, $limits,
2978 array( 'duplicateStderr' => true, 'profileMethod' => wfGetCaller() ) );
2982 * Workaround for http://bugs.php.net/bug.php?id=45132
2983 * escapeshellarg() destroys non-ASCII characters if LANG is not a UTF-8 locale
2985 function wfInitShellLocale() {
2986 static $done = false;
2991 global $wgShellLocale;
2992 if ( !wfIniGetBool( 'safe_mode' ) ) {
2993 putenv( "LC_CTYPE=$wgShellLocale" );
2994 setlocale( LC_CTYPE
, $wgShellLocale );
2999 * Generate a shell-escaped command line string to run a MediaWiki cli script.
3000 * Note that $parameters should be a flat array and an option with an argument
3001 * should consist of two consecutive items in the array (do not use "--option value").
3003 * @param string $script MediaWiki cli script path
3004 * @param array $parameters Arguments and options to the script
3005 * @param array $options Associative array of options:
3006 * 'php': The path to the php executable
3007 * 'wrapper': Path to a PHP wrapper to handle the maintenance script
3010 function wfShellWikiCmd( $script, array $parameters = array(), array $options = array() ) {
3012 // Give site config file a chance to run the script in a wrapper.
3013 // The caller may likely want to call wfBasename() on $script.
3014 Hooks
::run( 'wfShellWikiCmd', array( &$script, &$parameters, &$options ) );
3015 $cmd = isset( $options['php'] ) ?
array( $options['php'] ) : array( $wgPhpCli );
3016 if ( isset( $options['wrapper'] ) ) {
3017 $cmd[] = $options['wrapper'];
3020 // Escape each parameter for shell
3021 return wfEscapeShellArg( array_merge( $cmd, $parameters ) );
3025 * wfMerge attempts to merge differences between three texts.
3026 * Returns true for a clean merge and false for failure or a conflict.
3028 * @param string $old
3029 * @param string $mine
3030 * @param string $yours
3031 * @param string $result
3034 function wfMerge( $old, $mine, $yours, &$result ) {
3037 # This check may also protect against code injection in
3038 # case of broken installations.
3039 wfSuppressWarnings();
3040 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
3041 wfRestoreWarnings();
3043 if ( !$haveDiff3 ) {
3044 wfDebug( "diff3 not found\n" );
3048 # Make temporary files
3050 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
3051 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
3052 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
3054 # NOTE: diff3 issues a warning to stderr if any of the files does not end with
3055 # a newline character. To avoid this, we normalize the trailing whitespace before
3056 # creating the diff.
3058 fwrite( $oldtextFile, rtrim( $old ) . "\n" );
3059 fclose( $oldtextFile );
3060 fwrite( $mytextFile, rtrim( $mine ) . "\n" );
3061 fclose( $mytextFile );
3062 fwrite( $yourtextFile, rtrim( $yours ) . "\n" );
3063 fclose( $yourtextFile );
3065 # Check for a conflict
3066 $cmd = wfEscapeShellArg( $wgDiff3, '-a', '--overlap-only', $mytextName,
3067 $oldtextName, $yourtextName );
3068 $handle = popen( $cmd, 'r' );
3070 if ( fgets( $handle, 1024 ) ) {
3078 $cmd = wfEscapeShellArg( $wgDiff3, '-a', '-e', '--merge', $mytextName,
3079 $oldtextName, $yourtextName );
3080 $handle = popen( $cmd, 'r' );
3083 $data = fread( $handle, 8192 );
3084 if ( strlen( $data ) == 0 ) {
3090 unlink( $mytextName );
3091 unlink( $oldtextName );
3092 unlink( $yourtextName );
3094 if ( $result === '' && $old !== '' && !$conflict ) {
3095 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
3102 * Returns unified plain-text diff of two texts.
3103 * "Useful" for machine processing of diffs.
3105 * @deprecated since 1.25, use DiffEngine/UnifiedDiffFormatter directly
3107 * @param string $before The text before the changes.
3108 * @param string $after The text after the changes.
3109 * @param string $params Command-line options for the diff command.
3110 * @return string Unified diff of $before and $after
3112 function wfDiff( $before, $after, $params = '-u' ) {
3113 if ( $before == $after ) {
3118 wfSuppressWarnings();
3119 $haveDiff = $wgDiff && file_exists( $wgDiff );
3120 wfRestoreWarnings();
3122 # This check may also protect against code injection in
3123 # case of broken installations.
3125 wfDebug( "diff executable not found\n" );
3126 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
3127 $format = new UnifiedDiffFormatter();
3128 return $format->format( $diffs );
3131 # Make temporary files
3133 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
3134 $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
3136 fwrite( $oldtextFile, $before );
3137 fclose( $oldtextFile );
3138 fwrite( $newtextFile, $after );
3139 fclose( $newtextFile );
3141 // Get the diff of the two files
3142 $cmd = "$wgDiff " . $params . ' ' . wfEscapeShellArg( $oldtextName, $newtextName );
3144 $h = popen( $cmd, 'r' );
3146 unlink( $oldtextName );
3147 unlink( $newtextName );
3148 throw new Exception( __METHOD__
. '(): popen() failed' );
3154 $data = fread( $h, 8192 );
3155 if ( strlen( $data ) == 0 ) {
3163 unlink( $oldtextName );
3164 unlink( $newtextName );
3166 // Kill the --- and +++ lines. They're not useful.
3167 $diff_lines = explode( "\n", $diff );
3168 if ( isset( $diff_lines[0] ) && strpos( $diff_lines[0], '---' ) === 0 ) {
3169 unset( $diff_lines[0] );
3171 if ( isset( $diff_lines[1] ) && strpos( $diff_lines[1], '+++' ) === 0 ) {
3172 unset( $diff_lines[1] );
3175 $diff = implode( "\n", $diff_lines );
3181 * This function works like "use VERSION" in Perl, the program will die with a
3182 * backtrace if the current version of PHP is less than the version provided
3184 * This is useful for extensions which due to their nature are not kept in sync
3185 * with releases, and might depend on other versions of PHP than the main code
3187 * Note: PHP might die due to parsing errors in some cases before it ever
3188 * manages to call this function, such is life
3190 * @see perldoc -f use
3192 * @param string|int|float $req_ver The version to check, can be a string, an integer, or a float
3193 * @throws MWException
3195 function wfUsePHP( $req_ver ) {
3196 $php_ver = PHP_VERSION
;
3198 if ( version_compare( $php_ver, (string)$req_ver, '<' ) ) {
3199 throw new MWException( "PHP $req_ver required--this is only $php_ver" );
3204 * This function works like "use VERSION" in Perl except it checks the version
3205 * of MediaWiki, the program will die with a backtrace if the current version
3206 * of MediaWiki is less than the version provided.
3208 * This is useful for extensions which due to their nature are not kept in sync
3211 * Note: Due to the behavior of PHP's version_compare() which is used in this
3212 * function, if you want to allow the 'wmf' development versions add a 'c' (or
3213 * any single letter other than 'a', 'b' or 'p') as a post-fix to your
3214 * targeted version number. For example if you wanted to allow any variation
3215 * of 1.22 use `wfUseMW( '1.22c' )`. Using an 'a' or 'b' instead of 'c' will
3216 * not result in the same comparison due to the internal logic of
3217 * version_compare().
3219 * @see perldoc -f use
3221 * @param string|int|float $req_ver The version to check, can be a string, an integer, or a float
3222 * @throws MWException
3224 function wfUseMW( $req_ver ) {
3227 if ( version_compare( $wgVersion, (string)$req_ver, '<' ) ) {
3228 throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
3233 * Return the final portion of a pathname.
3234 * Reimplemented because PHP5's "basename()" is buggy with multibyte text.
3235 * http://bugs.php.net/bug.php?id=33898
3237 * PHP's basename() only considers '\' a pathchar on Windows and Netware.
3238 * We'll consider it so always, as we don't want '\s' in our Unix paths either.
3240 * @param string $path
3241 * @param string $suffix String to remove if present
3244 function wfBaseName( $path, $suffix = '' ) {
3245 if ( $suffix == '' ) {
3248 $encSuffix = '(?:' . preg_quote( $suffix, '#' ) . ')?';
3252 if ( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
3260 * Generate a relative path name to the given file.
3261 * May explode on non-matching case-insensitive paths,
3262 * funky symlinks, etc.
3264 * @param string $path Absolute destination path including target filename
3265 * @param string $from Absolute source path, directory only
3268 function wfRelativePath( $path, $from ) {
3269 // Normalize mixed input on Windows...
3270 $path = str_replace( '/', DIRECTORY_SEPARATOR
, $path );
3271 $from = str_replace( '/', DIRECTORY_SEPARATOR
, $from );
3273 // Trim trailing slashes -- fix for drive root
3274 $path = rtrim( $path, DIRECTORY_SEPARATOR
);
3275 $from = rtrim( $from, DIRECTORY_SEPARATOR
);
3277 $pieces = explode( DIRECTORY_SEPARATOR
, dirname( $path ) );
3278 $against = explode( DIRECTORY_SEPARATOR
, $from );
3280 if ( $pieces[0] !== $against[0] ) {
3281 // Non-matching Windows drive letters?
3282 // Return a full path.
3286 // Trim off common prefix
3287 while ( count( $pieces ) && count( $against )
3288 && $pieces[0] == $against[0] ) {
3289 array_shift( $pieces );
3290 array_shift( $against );
3293 // relative dots to bump us to the parent
3294 while ( count( $against ) ) {
3295 array_unshift( $pieces, '..' );
3296 array_shift( $against );
3299 array_push( $pieces, wfBaseName( $path ) );
3301 return implode( DIRECTORY_SEPARATOR
, $pieces );
3305 * Convert an arbitrarily-long digit string from one numeric base
3306 * to another, optionally zero-padding to a minimum column width.
3308 * Supports base 2 through 36; digit values 10-36 are represented
3309 * as lowercase letters a-z. Input is case-insensitive.
3311 * @param string $input Input number
3312 * @param int $sourceBase Base of the input number
3313 * @param int $destBase Desired base of the output
3314 * @param int $pad Minimum number of digits in the output (pad with zeroes)
3315 * @param bool $lowercase Whether to output in lowercase or uppercase
3316 * @param string $engine Either "gmp", "bcmath", or "php"
3317 * @return string|bool The output number as a string, or false on error
3319 function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1,
3320 $lowercase = true, $engine = 'auto'
3322 $input = (string)$input;
3328 $sourceBase != (int)$sourceBase ||
3329 $destBase != (int)$destBase ||
3330 $pad != (int)$pad ||
3332 "/^[" . substr( '0123456789abcdefghijklmnopqrstuvwxyz', 0, $sourceBase ) . "]+$/i",
3339 static $baseChars = array(
3340 10 => 'a', 11 => 'b', 12 => 'c', 13 => 'd', 14 => 'e', 15 => 'f',
3341 16 => 'g', 17 => 'h', 18 => 'i', 19 => 'j', 20 => 'k', 21 => 'l',
3342 22 => 'm', 23 => 'n', 24 => 'o', 25 => 'p', 26 => 'q', 27 => 'r',
3343 28 => 's', 29 => 't', 30 => 'u', 31 => 'v', 32 => 'w', 33 => 'x',
3344 34 => 'y', 35 => 'z',
3346 '0' => 0, '1' => 1, '2' => 2, '3' => 3, '4' => 4, '5' => 5,
3347 '6' => 6, '7' => 7, '8' => 8, '9' => 9, 'a' => 10, 'b' => 11,
3348 'c' => 12, 'd' => 13, 'e' => 14, 'f' => 15, 'g' => 16, 'h' => 17,
3349 'i' => 18, 'j' => 19, 'k' => 20, 'l' => 21, 'm' => 22, 'n' => 23,
3350 'o' => 24, 'p' => 25, 'q' => 26, 'r' => 27, 's' => 28, 't' => 29,
3351 'u' => 30, 'v' => 31, 'w' => 32, 'x' => 33, 'y' => 34, 'z' => 35
3354 if ( extension_loaded( 'gmp' ) && ( $engine == 'auto' ||
$engine == 'gmp' ) ) {
3355 // Removing leading zeros works around broken base detection code in
3356 // some PHP versions (see <https://bugs.php.net/bug.php?id=50175> and
3357 // <https://bugs.php.net/bug.php?id=55398>).
3358 $result = gmp_strval( gmp_init( ltrim( $input, '0' ), $sourceBase ), $destBase );
3359 } elseif ( extension_loaded( 'bcmath' ) && ( $engine == 'auto' ||
$engine == 'bcmath' ) ) {
3361 foreach ( str_split( strtolower( $input ) ) as $char ) {
3362 $decimal = bcmul( $decimal, $sourceBase );
3363 $decimal = bcadd( $decimal, $baseChars[$char] );
3366 // @codingStandardsIgnoreStart Generic.CodeAnalysis.ForLoopWithTestFunctionCall.NotAllowed
3367 for ( $result = ''; bccomp( $decimal, 0 ); $decimal = bcdiv( $decimal, $destBase, 0 ) ) {
3368 $result .= $baseChars[bcmod( $decimal, $destBase )];
3370 // @codingStandardsIgnoreEnd
3372 $result = strrev( $result );
3374 $inDigits = array();
3375 foreach ( str_split( strtolower( $input ) ) as $char ) {
3376 $inDigits[] = $baseChars[$char];
3379 // Iterate over the input, modulo-ing out an output digit
3380 // at a time until input is gone.
3382 while ( $inDigits ) {
3384 $workDigits = array();
3387 foreach ( $inDigits as $digit ) {
3388 $work *= $sourceBase;
3391 if ( $workDigits ||
$work >= $destBase ) {
3392 $workDigits[] = (int)( $work / $destBase );
3397 // All that division leaves us with a remainder,
3398 // which is conveniently our next output digit.
3399 $result .= $baseChars[$work];
3402 $inDigits = $workDigits;
3405 $result = strrev( $result );
3408 if ( !$lowercase ) {
3409 $result = strtoupper( $result );
3412 return str_pad( $result, $pad, '0', STR_PAD_LEFT
);
3416 * Check if there is sufficient entropy in php's built-in session generation
3418 * @return bool True = there is sufficient entropy
3420 function wfCheckEntropy() {
3422 ( wfIsWindows() && version_compare( PHP_VERSION
, '5.3.3', '>=' ) )
3423 ||
ini_get( 'session.entropy_file' )
3425 && intval( ini_get( 'session.entropy_length' ) ) >= 32;
3429 * Override session_id before session startup if php's built-in
3430 * session generation code is not secure.
3432 function wfFixSessionID() {
3433 // If the cookie or session id is already set we already have a session and should abort
3434 if ( isset( $_COOKIE[session_name()] ) ||
session_id() ) {
3438 // PHP's built-in session entropy is enabled if:
3439 // - entropy_file is set or you're on Windows with php 5.3.3+
3440 // - AND entropy_length is > 0
3441 // We treat it as disabled if it doesn't have an entropy length of at least 32
3442 $entropyEnabled = wfCheckEntropy();
3444 // If built-in entropy is not enabled or not sufficient override PHP's
3445 // built in session id generation code
3446 if ( !$entropyEnabled ) {
3447 wfDebug( __METHOD__
. ": PHP's built in entropy is disabled or not sufficient, " .
3448 "overriding session id generation using our cryptrand source.\n" );
3449 session_id( MWCryptRand
::generateHex( 32 ) );
3454 * Reset the session_id
3458 function wfResetSessionID() {
3459 global $wgCookieSecure;
3460 $oldSessionId = session_id();
3461 $cookieParams = session_get_cookie_params();
3462 if ( wfCheckEntropy() && $wgCookieSecure == $cookieParams['secure'] ) {
3463 session_regenerate_id( false );
3467 wfSetupSession( MWCryptRand
::generateHex( 32 ) );
3470 $newSessionId = session_id();
3471 Hooks
::run( 'ResetSessionID', array( $oldSessionId, $newSessionId ) );
3475 * Initialise php session
3477 * @param bool $sessionId
3479 function wfSetupSession( $sessionId = false ) {
3480 global $wgSessionsInMemcached, $wgSessionsInObjectCache, $wgCookiePath, $wgCookieDomain,
3481 $wgCookieSecure, $wgCookieHttpOnly, $wgSessionHandler;
3482 if ( $wgSessionsInObjectCache ||
$wgSessionsInMemcached ) {
3483 ObjectCacheSessionHandler
::install();
3484 } elseif ( $wgSessionHandler && $wgSessionHandler != ini_get( 'session.save_handler' ) ) {
3485 # Only set this if $wgSessionHandler isn't null and session.save_handler
3486 # hasn't already been set to the desired value (that causes errors)
3487 ini_set( 'session.save_handler', $wgSessionHandler );
3489 session_set_cookie_params(
3490 0, $wgCookiePath, $wgCookieDomain, $wgCookieSecure, $wgCookieHttpOnly );
3491 session_cache_limiter( 'private, must-revalidate' );
3493 session_id( $sessionId );
3497 wfSuppressWarnings();
3499 wfRestoreWarnings();
3503 * Get an object from the precompiled serialized directory
3505 * @param string $name
3506 * @return mixed The variable on success, false on failure
3508 function wfGetPrecompiledData( $name ) {
3511 $file = "$IP/serialized/$name";
3512 if ( file_exists( $file ) ) {
3513 $blob = file_get_contents( $file );
3515 return unserialize( $blob );
3524 * @param string $args,...
3527 function wfMemcKey( /*...*/ ) {
3528 global $wgCachePrefix;
3529 $prefix = $wgCachePrefix === false ?
wfWikiID() : $wgCachePrefix;
3530 $args = func_get_args();
3531 $key = $prefix . ':' . implode( ':', $args );
3532 $key = str_replace( ' ', '_', $key );
3537 * Get a cache key for a foreign DB
3540 * @param string $prefix
3541 * @param string $args,...
3544 function wfForeignMemcKey( $db, $prefix /*...*/ ) {
3545 $args = array_slice( func_get_args(), 2 );
3547 $key = "$db-$prefix:" . implode( ':', $args );
3549 $key = $db . ':' . implode( ':', $args );
3551 return str_replace( ' ', '_', $key );
3555 * Get an ASCII string identifying this wiki
3556 * This is used as a prefix in memcached keys
3560 function wfWikiID() {
3561 global $wgDBprefix, $wgDBname;
3562 if ( $wgDBprefix ) {
3563 return "$wgDBname-$wgDBprefix";
3570 * Split a wiki ID into DB name and table prefix
3572 * @param string $wiki
3576 function wfSplitWikiID( $wiki ) {
3577 $bits = explode( '-', $wiki, 2 );
3578 if ( count( $bits ) < 2 ) {
3585 * Get a Database object.
3587 * @param int $db Index of the connection to get. May be DB_MASTER for the
3588 * master (for write queries), DB_SLAVE for potentially lagged read
3589 * queries, or an integer >= 0 for a particular server.
3591 * @param string|string[] $groups Query groups. An array of group names that this query
3592 * belongs to. May contain a single string if the query is only
3595 * @param string|bool $wiki The wiki ID, or false for the current wiki
3597 * Note: multiple calls to wfGetDB(DB_SLAVE) during the course of one request
3598 * will always return the same object, unless the underlying connection or load
3599 * balancer is manually destroyed.
3601 * Note 2: use $this->getDB() in maintenance scripts that may be invoked by
3602 * updater to ensure that a proper database is being updated.
3604 * @return DatabaseBase
3606 function wfGetDB( $db, $groups = array(), $wiki = false ) {
3607 return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
3611 * Get a load balancer object.
3613 * @param string|bool $wiki Wiki ID, or false for the current wiki
3614 * @return LoadBalancer
3616 function wfGetLB( $wiki = false ) {
3617 return wfGetLBFactory()->getMainLB( $wiki );
3621 * Get the load balancer factory object
3625 function wfGetLBFactory() {
3626 return LBFactory
::singleton();
3631 * Shortcut for RepoGroup::singleton()->findFile()
3633 * @param string $title String or Title object
3634 * @param array $options Associative array of options (see RepoGroup::findFile)
3635 * @return File|bool File, or false if the file does not exist
3637 function wfFindFile( $title, $options = array() ) {
3638 return RepoGroup
::singleton()->findFile( $title, $options );
3642 * Get an object referring to a locally registered file.
3643 * Returns a valid placeholder object if the file does not exist.
3645 * @param Title|string $title
3646 * @return LocalFile|null A File, or null if passed an invalid Title
3648 function wfLocalFile( $title ) {
3649 return RepoGroup
::singleton()->getLocalRepo()->newFile( $title );
3653 * Should low-performance queries be disabled?
3656 * @codeCoverageIgnore
3658 function wfQueriesMustScale() {
3659 global $wgMiserMode;
3661 ||
( SiteStats
::pages() > 100000
3662 && SiteStats
::edits() > 1000000
3663 && SiteStats
::users() > 10000 );
3667 * Get the path to a specified script file, respecting file
3668 * extensions; this is a wrapper around $wgScriptExtension etc.
3669 * except for 'index' and 'load' which use $wgScript/$wgLoadScript
3671 * @param string $script Script filename, sans extension
3674 function wfScript( $script = 'index' ) {
3675 global $wgScriptPath, $wgScriptExtension, $wgScript, $wgLoadScript;
3676 if ( $script === 'index' ) {
3678 } elseif ( $script === 'load' ) {
3679 return $wgLoadScript;
3681 return "{$wgScriptPath}/{$script}{$wgScriptExtension}";
3686 * Get the script URL.
3688 * @return string Script URL
3690 function wfGetScriptUrl() {
3691 if ( isset( $_SERVER['SCRIPT_NAME'] ) ) {
3693 # as it was called, minus the query string.
3695 # Some sites use Apache rewrite rules to handle subdomains,
3696 # and have PHP set up in a weird way that causes PHP_SELF
3697 # to contain the rewritten URL instead of the one that the
3698 # outside world sees.
3700 # If in this mode, use SCRIPT_URL instead, which mod_rewrite
3701 # provides containing the "before" URL.
3702 return $_SERVER['SCRIPT_NAME'];
3704 return $_SERVER['URL'];
3709 * Convenience function converts boolean values into "true"
3710 * or "false" (string) values
3712 * @param bool $value
3715 function wfBoolToStr( $value ) {
3716 return $value ?
'true' : 'false';
3720 * Get a platform-independent path to the null file, e.g. /dev/null
3724 function wfGetNull() {
3725 return wfIsWindows() ?
'NUL' : '/dev/null';
3729 * Waits for the slaves to catch up to the master position
3731 * Use this when updating very large numbers of rows, as in maintenance scripts,
3732 * to avoid causing too much lag. Of course, this is a no-op if there are no slaves.
3734 * By default this waits on the main DB cluster of the current wiki.
3735 * If $cluster is set to "*" it will wait on all DB clusters, including
3736 * external ones. If the lag being waiting on is caused by the code that
3737 * does this check, it makes since to use $ifWritesSince, particularly if
3738 * cluster is "*", to avoid excess overhead.
3740 * Never call this function after a big DB write that is still in a transaction.
3741 * This only makes sense after the possible lag inducing changes were committed.
3743 * @param float|null $ifWritesSince Only wait if writes were done since this UNIX timestamp
3744 * @param string|bool $wiki Wiki identifier accepted by wfGetLB
3745 * @param string|bool $cluster Cluster name accepted by LBFactory. Default: false.
3746 * @param int|null $timeout Max wait time. Default: 1 day (cli), ~10 seconds (web)
3747 * @return bool Success (able to connect and no timeouts reached)
3749 function wfWaitForSlaves(
3750 $ifWritesSince = null, $wiki = false, $cluster = false, $timeout = null
3752 // B/C: first argument used to be "max seconds of lag"; ignore such values
3753 $ifWritesSince = ( $ifWritesSince > 1e9
) ?
$ifWritesSince : null;
3755 if ( $timeout === null ) {
3756 $timeout = ( PHP_SAPI
=== 'cli' ) ?
86400 : 10;
3759 // Figure out which clusters need to be checked
3761 if ( $cluster === '*' ) {
3762 wfGetLBFactory()->forEachLB( function ( LoadBalancer
$lb ) use ( &$lbs ) {
3765 } elseif ( $cluster !== false ) {
3766 $lbs[] = wfGetLBFactory()->getExternalLB( $cluster );
3768 $lbs[] = wfGetLB( $wiki );
3771 // Get all the master positions of applicable DBs right now.
3772 // This can be faster since waiting on one cluster reduces the
3773 // time needed to wait on the next clusters.
3774 $masterPositions = array_fill( 0, count( $lbs ), false );
3775 foreach ( $lbs as $i => $lb ) {
3776 // bug 27975 - Don't try to wait for slaves if there are none
3777 // Prevents permission error when getting master position
3778 if ( $lb->getServerCount() > 1 ) {
3779 if ( $ifWritesSince && !$lb->hasMasterConnection() ) {
3780 continue; // assume no writes done
3782 // Use the empty string to not trigger selectDB() since the connection
3783 // may have been to a server that does not have a DB for the current wiki.
3784 $dbw = $lb->getConnection( DB_MASTER
, array(), '' );
3785 if ( $ifWritesSince && $dbw->lastDoneWrites() < $ifWritesSince ) {
3786 continue; // no writes since the last wait
3788 $masterPositions[$i] = $dbw->getMasterPos();
3793 foreach ( $lbs as $i => $lb ) {
3794 if ( $masterPositions[$i] ) {
3795 // The DBMS may not support getMasterPos() or the whole
3796 // load balancer might be fake (e.g. $wgAllDBsAreLocalhost).
3797 $ok = $lb->waitForAll( $masterPositions[$i], $timeout ) && $ok;
3805 * Count down from $seconds to zero on the terminal, with a one-second pause
3806 * between showing each number. For use in command-line scripts.
3808 * @codeCoverageIgnore
3809 * @param int $seconds
3811 function wfCountDown( $seconds ) {
3812 for ( $i = $seconds; $i >= 0; $i-- ) {
3813 if ( $i != $seconds ) {
3814 echo str_repeat( "\x08", strlen( $i +
1 ) );
3826 * Replace all invalid characters with -
3827 * Additional characters can be defined in $wgIllegalFileChars (see bug 20489)
3828 * By default, $wgIllegalFileChars = ':'
3830 * @param string $name Filename to process
3833 function wfStripIllegalFilenameChars( $name ) {
3834 global $wgIllegalFileChars;
3835 $illegalFileChars = $wgIllegalFileChars ?
"|[" . $wgIllegalFileChars . "]" : '';
3836 $name = wfBaseName( $name );
3837 $name = preg_replace(
3838 "/[^" . Title
::legalChars() . "]" . $illegalFileChars . "/",
3846 * Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit;
3848 * @return int Value the memory limit was set to.
3850 function wfMemoryLimit() {
3851 global $wgMemoryLimit;
3852 $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
3853 if ( $memlimit != -1 ) {
3854 $conflimit = wfShorthandToInteger( $wgMemoryLimit );
3855 if ( $conflimit == -1 ) {
3856 wfDebug( "Removing PHP's memory limit\n" );
3857 wfSuppressWarnings();
3858 ini_set( 'memory_limit', $conflimit );
3859 wfRestoreWarnings();
3861 } elseif ( $conflimit > $memlimit ) {
3862 wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
3863 wfSuppressWarnings();
3864 ini_set( 'memory_limit', $conflimit );
3865 wfRestoreWarnings();
3873 * Converts shorthand byte notation to integer form
3875 * @param string $string
3878 function wfShorthandToInteger( $string = '' ) {
3879 $string = trim( $string );
3880 if ( $string === '' ) {
3883 $last = $string[strlen( $string ) - 1];
3884 $val = intval( $string );
3889 // break intentionally missing
3893 // break intentionally missing
3903 * Get the normalised IETF language tag
3904 * See unit test for examples.
3906 * @param string $code The language code.
3907 * @return string The language code which complying with BCP 47 standards.
3909 function wfBCP47( $code ) {
3910 $codeSegment = explode( '-', $code );
3912 foreach ( $codeSegment as $segNo => $seg ) {
3913 // when previous segment is x, it is a private segment and should be lc
3914 if ( $segNo > 0 && strtolower( $codeSegment[( $segNo - 1 )] ) == 'x' ) {
3915 $codeBCP[$segNo] = strtolower( $seg );
3916 // ISO 3166 country code
3917 } elseif ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) {
3918 $codeBCP[$segNo] = strtoupper( $seg );
3919 // ISO 15924 script code
3920 } elseif ( ( strlen( $seg ) == 4 ) && ( $segNo > 0 ) ) {
3921 $codeBCP[$segNo] = ucfirst( strtolower( $seg ) );
3922 // Use lowercase for other cases
3924 $codeBCP[$segNo] = strtolower( $seg );
3927 $langCode = implode( '-', $codeBCP );
3932 * Get a cache object.
3934 * @param int $inputType Cache type, one of the CACHE_* constants.
3937 function wfGetCache( $inputType ) {
3938 return ObjectCache
::getInstance( $inputType );
3942 * Get the main cache object
3946 function wfGetMainCache() {
3947 global $wgMainCacheType;
3948 return ObjectCache
::getInstance( $wgMainCacheType );
3952 * Get the cache object used by the message cache
3956 function wfGetMessageCacheStorage() {
3957 global $wgMessageCacheType;
3958 return ObjectCache
::getInstance( $wgMessageCacheType );
3962 * Get the cache object used by the parser cache
3966 function wfGetParserCacheStorage() {
3967 global $wgParserCacheType;
3968 return ObjectCache
::getInstance( $wgParserCacheType );
3972 * Call hook functions defined in $wgHooks
3974 * @param string $event Event name
3975 * @param array $args Parameters passed to hook functions
3976 * @param string|null $deprecatedVersion Optionally mark hook as deprecated with version number
3978 * @return bool True if no handler aborted the hook
3979 * @deprecated 1.25 - use Hooks::run
3981 function wfRunHooks( $event, array $args = array(), $deprecatedVersion = null ) {
3982 return Hooks
::run( $event, $args, $deprecatedVersion );
3986 * Wrapper around php's unpack.
3988 * @param string $format The format string (See php's docs)
3989 * @param string $data A binary string of binary data
3990 * @param int|bool $length The minimum length of $data or false. This is to
3991 * prevent reading beyond the end of $data. false to disable the check.
3993 * Also be careful when using this function to read unsigned 32 bit integer
3994 * because php might make it negative.
3996 * @throws MWException If $data not long enough, or if unpack fails
3997 * @return array Associative array of the extracted data
3999 function wfUnpack( $format, $data, $length = false ) {
4000 if ( $length !== false ) {
4001 $realLen = strlen( $data );
4002 if ( $realLen < $length ) {
4003 throw new MWException( "Tried to use wfUnpack on a "
4004 . "string of length $realLen, but needed one "
4005 . "of at least length $length."
4010 wfSuppressWarnings();
4011 $result = unpack( $format, $data );
4012 wfRestoreWarnings();
4014 if ( $result === false ) {
4015 // If it cannot extract the packed data.
4016 throw new MWException( "unpack could not unpack binary data" );
4022 * Determine if an image exists on the 'bad image list'.
4024 * The format of MediaWiki:Bad_image_list is as follows:
4025 * * Only list items (lines starting with "*") are considered
4026 * * The first link on a line must be a link to a bad image
4027 * * Any subsequent links on the same line are considered to be exceptions,
4028 * i.e. articles where the image may occur inline.
4030 * @param string $name The image name to check
4031 * @param Title|bool $contextTitle The page on which the image occurs, if known
4032 * @param string $blacklist Wikitext of a file blacklist
4035 function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
4036 static $badImageCache = null; // based on bad_image_list msg
4039 $redirectTitle = RepoGroup
::singleton()->checkRedirect( Title
::makeTitle( NS_FILE
, $name ) );
4040 if ( $redirectTitle ) {
4041 $name = $redirectTitle->getDBkey();
4044 # Run the extension hook
4046 if ( !Hooks
::run( 'BadImage', array( $name, &$bad ) ) ) {
4050 $cacheable = ( $blacklist === null );
4051 if ( $cacheable && $badImageCache !== null ) {
4052 $badImages = $badImageCache;
4053 } else { // cache miss
4054 if ( $blacklist === null ) {
4055 $blacklist = wfMessage( 'bad_image_list' )->inContentLanguage()->plain(); // site list
4057 # Build the list now
4058 $badImages = array();
4059 $lines = explode( "\n", $blacklist );
4060 foreach ( $lines as $line ) {
4062 if ( substr( $line, 0, 1 ) !== '*' ) {
4068 if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
4072 $exceptions = array();
4073 $imageDBkey = false;
4074 foreach ( $m[1] as $i => $titleText ) {
4075 $title = Title
::newFromText( $titleText );
4076 if ( !is_null( $title ) ) {
4078 $imageDBkey = $title->getDBkey();
4080 $exceptions[$title->getPrefixedDBkey()] = true;
4085 if ( $imageDBkey !== false ) {
4086 $badImages[$imageDBkey] = $exceptions;
4090 $badImageCache = $badImages;
4094 $contextKey = $contextTitle ?
$contextTitle->getPrefixedDBkey() : false;
4095 $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
4100 * Determine whether the client at a given source IP is likely to be able to
4101 * access the wiki via HTTPS.
4103 * @param string $ip The IPv4/6 address in the normal human-readable form
4106 function wfCanIPUseHTTPS( $ip ) {
4108 Hooks
::run( 'CanIPUseHTTPS', array( $ip, &$canDo ) );
4113 * Determine input string is represents as infinity
4115 * @param string $str The string to determine
4119 function wfIsInfinity( $str ) {
4120 $infinityValues = array( 'infinite', 'indefinite', 'infinity', 'never' );
4121 return in_array( $str, $infinityValues );
4125 * Work out the IP address based on various globals
4126 * For trusted proxies, use the XFF client IP (first of the chain)
4128 * @deprecated since 1.19; call $wgRequest->getIP() directly.
4131 function wfGetIP() {
4132 wfDeprecated( __METHOD__
, '1.19' );
4134 return $wgRequest->getIP();
4138 * Checks if an IP is a trusted proxy provider.
4139 * Useful to tell if X-Forwarded-For data is possibly bogus.
4140 * Squid cache servers for the site are whitelisted.
4141 * @deprecated Since 1.24, use IP::isTrustedProxy()
4146 function wfIsTrustedProxy( $ip ) {
4147 wfDeprecated( __METHOD__
, '1.24' );
4148 return IP
::isTrustedProxy( $ip );
4152 * Checks if an IP matches a proxy we've configured.
4153 * @deprecated Since 1.24, use IP::isConfiguredProxy()
4157 * @since 1.23 Supports CIDR ranges in $wgSquidServersNoPurge
4159 function wfIsConfiguredProxy( $ip ) {
4160 wfDeprecated( __METHOD__
, '1.24' );
4161 return IP
::isConfiguredProxy( $ip );
4165 * Returns true if these thumbnail parameters match one that MediaWiki
4166 * requests from file description pages and/or parser output.
4168 * $params is considered non-standard if they involve a non-standard
4169 * width or any non-default parameters aside from width and page number.
4170 * The number of possible files with standard parameters is far less than
4171 * that of all combinations; rate-limiting for them can thus be more generious.
4174 * @param array $params
4176 * @since 1.24 Moved from thumb.php to GlobalFunctions in 1.25
4178 function wfThumbIsStandard( File
$file, array $params ) {
4179 global $wgThumbLimits, $wgImageLimits, $wgResponsiveImages;
4181 $multipliers = array( 1 );
4182 if ( $wgResponsiveImages ) {
4183 // These available sizes are hardcoded currently elsewhere in MediaWiki.
4184 // @see Linker::processResponsiveImages
4185 $multipliers[] = 1.5;
4189 $handler = $file->getHandler();
4190 if ( !$handler ||
!isset( $params['width'] ) ) {
4194 $basicParams = array();
4195 if ( isset( $params['page'] ) ) {
4196 $basicParams['page'] = $params['page'];
4199 $thumbLimits = array();
4200 $imageLimits = array();
4201 // Expand limits to account for multipliers
4202 foreach ( $multipliers as $multiplier ) {
4203 $thumbLimits = array_merge( $thumbLimits, array_map(
4204 function ( $width ) use ( $multiplier ) {
4205 return round( $width * $multiplier );
4208 $imageLimits = array_merge( $imageLimits, array_map(
4209 function ( $pair ) use ( $multiplier ) {
4211 round( $pair[0] * $multiplier ),
4212 round( $pair[1] * $multiplier ),
4218 // Check if the width matches one of $wgThumbLimits
4219 if ( in_array( $params['width'], $thumbLimits ) ) {
4220 $normalParams = $basicParams +
array( 'width' => $params['width'] );
4221 // Append any default values to the map (e.g. "lossy", "lossless", ...)
4222 $handler->normaliseParams( $file, $normalParams );
4224 // If not, then check if the width matchs one of $wgImageLimits
4226 foreach ( $imageLimits as $pair ) {
4227 $normalParams = $basicParams +
array( 'width' => $pair[0], 'height' => $pair[1] );
4228 // Decide whether the thumbnail should be scaled on width or height.
4229 // Also append any default values to the map (e.g. "lossy", "lossless", ...)
4230 $handler->normaliseParams( $file, $normalParams );
4231 // Check if this standard thumbnail size maps to the given width
4232 if ( $normalParams['width'] == $params['width'] ) {
4238 return false; // not standard for description pages
4242 // Check that the given values for non-page, non-width, params are just defaults
4243 foreach ( $params as $key => $value ) {
4244 if ( !isset( $normalParams[$key] ) ||
$normalParams[$key] != $value ) {