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\Sender\SocketSender
;
28 use MediaWiki\Logger\LoggerFactory
;
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 $ext Name of the extension to load
173 * @param string|null $path Absolute path of where to find the extension.json file
175 function wfLoadExtension( $ext, $path = null ) {
177 global $wgExtensionDirectory;
178 $path = "$wgExtensionDirectory/$ext/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 ) {
196 global $wgExtensionDirectory;
197 $registry = ExtensionRegistry
::getInstance();
198 foreach ( $exts as $ext ) {
199 $registry->queue( "$wgExtensionDirectory/$ext/extension.json" );
206 * @see wfLoadExtension
207 * @param string $skin Name of the extension to load
208 * @param string|null $path Absolute path of where to find the skin.json file
210 function wfLoadSkin( $skin, $path = null ) {
212 global $wgStyleDirectory;
213 $path = "$wgStyleDirectory/$skin/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 ) {
225 global $wgStyleDirectory;
226 $registry = ExtensionRegistry
::getInstance();
227 foreach ( $skins as $skin ) {
228 $registry->queue( "$wgStyleDirectory/$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 * RFC 1738 says ~ is unsafe, however RFC 3986 considers it an unreserved
405 * character which should not be encoded. More importantly, google chrome
406 * always converts %7E back to ~, and converting it in this function can
407 * cause a redirect loop (T105265).
409 * But + is not safe because it's used to indicate a space; &= are only safe in
410 * paths and not in queries (and we don't distinguish here); ' seems kind of
411 * scary; and urlencode() doesn't touch -_. to begin with. Plus, although /
412 * is reserved, we don't care. So the list we unescape is:
416 * However, IIS7 redirects fail when the url contains a colon (Bug 22709),
417 * so no fancy : for IIS7.
419 * %2F in the page titles seems to fatally break for some reason.
424 function wfUrlencode( $s ) {
427 if ( is_null( $s ) ) {
432 if ( is_null( $needle ) ) {
433 $needle = array( '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F', '%7E' );
434 if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) ||
435 ( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false )
441 $s = urlencode( $s );
444 array( ';', '@', '$', '!', '*', '(', ')', ',', '/', '~', ':' ),
452 * This function takes two arrays as input, and returns a CGI-style string, e.g.
453 * "days=7&limit=100". Options in the first array override options in the second.
454 * Options set to null or false will not be output.
456 * @param array $array1 ( String|Array )
457 * @param array $array2 ( String|Array )
458 * @param string $prefix
461 function wfArrayToCgi( $array1, $array2 = null, $prefix = '' ) {
462 if ( !is_null( $array2 ) ) {
463 $array1 = $array1 +
$array2;
467 foreach ( $array1 as $key => $value ) {
468 if ( !is_null( $value ) && $value !== false ) {
472 if ( $prefix !== '' ) {
473 $key = $prefix . "[$key]";
475 if ( is_array( $value ) ) {
477 foreach ( $value as $k => $v ) {
478 $cgi .= $firstTime ?
'' : '&';
479 if ( is_array( $v ) ) {
480 $cgi .= wfArrayToCgi( $v, null, $key . "[$k]" );
482 $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v );
487 if ( is_object( $value ) ) {
488 $value = $value->__toString();
490 $cgi .= urlencode( $key ) . '=' . urlencode( $value );
498 * This is the logical opposite of wfArrayToCgi(): it accepts a query string as
499 * its argument and returns the same string in array form. This allows compatibility
500 * with legacy functions that accept raw query strings instead of nice
501 * arrays. Of course, keys and values are urldecode()d.
503 * @param string $query Query string
504 * @return string[] Array version of input
506 function wfCgiToArray( $query ) {
507 if ( isset( $query[0] ) && $query[0] == '?' ) {
508 $query = substr( $query, 1 );
510 $bits = explode( '&', $query );
512 foreach ( $bits as $bit ) {
516 if ( strpos( $bit, '=' ) === false ) {
517 // Pieces like &qwerty become 'qwerty' => '' (at least this is what php does)
521 list( $key, $value ) = explode( '=', $bit );
523 $key = urldecode( $key );
524 $value = urldecode( $value );
525 if ( strpos( $key, '[' ) !== false ) {
526 $keys = array_reverse( explode( '[', $key ) );
527 $key = array_pop( $keys );
529 foreach ( $keys as $k ) {
530 $k = substr( $k, 0, -1 );
531 $temp = array( $k => $temp );
533 if ( isset( $ret[$key] ) ) {
534 $ret[$key] = array_merge( $ret[$key], $temp );
546 * Append a query string to an existing URL, which may or may not already
547 * have query string parameters already. If so, they will be combined.
550 * @param string|string[] $query String or associative array
553 function wfAppendQuery( $url, $query ) {
554 if ( is_array( $query ) ) {
555 $query = wfArrayToCgi( $query );
557 if ( $query != '' ) {
558 if ( false === strpos( $url, '?' ) ) {
569 * Expand a potentially local URL to a fully-qualified URL. Assumes $wgServer
572 * The meaning of the PROTO_* constants is as follows:
573 * PROTO_HTTP: Output a URL starting with http://
574 * PROTO_HTTPS: Output a URL starting with https://
575 * PROTO_RELATIVE: Output a URL starting with // (protocol-relative URL)
576 * PROTO_CURRENT: Output a URL starting with either http:// or https:// , depending
577 * on which protocol was used for the current incoming request
578 * PROTO_CANONICAL: For URLs without a domain, like /w/index.php , use $wgCanonicalServer.
579 * For protocol-relative URLs, use the protocol of $wgCanonicalServer
580 * PROTO_INTERNAL: Like PROTO_CANONICAL, but uses $wgInternalServer instead of $wgCanonicalServer
582 * @todo this won't work with current-path-relative URLs
583 * like "subdir/foo.html", etc.
585 * @param string $url Either fully-qualified or a local path + query
586 * @param string $defaultProto One of the PROTO_* constants. Determines the
587 * protocol to use if $url or $wgServer is protocol-relative
588 * @return string Fully-qualified URL, current-path-relative URL or false if
589 * no valid URL can be constructed
591 function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT
) {
592 global $wgServer, $wgCanonicalServer, $wgInternalServer, $wgRequest,
594 if ( $defaultProto === PROTO_CANONICAL
) {
595 $serverUrl = $wgCanonicalServer;
596 } elseif ( $defaultProto === PROTO_INTERNAL
&& $wgInternalServer !== false ) {
597 // Make $wgInternalServer fall back to $wgServer if not set
598 $serverUrl = $wgInternalServer;
600 $serverUrl = $wgServer;
601 if ( $defaultProto === PROTO_CURRENT
) {
602 $defaultProto = $wgRequest->getProtocol() . '://';
606 // Analyze $serverUrl to obtain its protocol
607 $bits = wfParseUrl( $serverUrl );
608 $serverHasProto = $bits && $bits['scheme'] != '';
610 if ( $defaultProto === PROTO_CANONICAL ||
$defaultProto === PROTO_INTERNAL
) {
611 if ( $serverHasProto ) {
612 $defaultProto = $bits['scheme'] . '://';
614 // $wgCanonicalServer or $wgInternalServer doesn't have a protocol.
615 // This really isn't supposed to happen. Fall back to HTTP in this
617 $defaultProto = PROTO_HTTP
;
621 $defaultProtoWithoutSlashes = substr( $defaultProto, 0, -2 );
623 if ( substr( $url, 0, 2 ) == '//' ) {
624 $url = $defaultProtoWithoutSlashes . $url;
625 } elseif ( substr( $url, 0, 1 ) == '/' ) {
626 // If $serverUrl is protocol-relative, prepend $defaultProtoWithoutSlashes,
627 // otherwise leave it alone.
628 $url = ( $serverHasProto ?
'' : $defaultProtoWithoutSlashes ) . $serverUrl . $url;
631 $bits = wfParseUrl( $url );
633 // ensure proper port for HTTPS arrives in URL
634 // https://bugzilla.wikimedia.org/show_bug.cgi?id=65184
635 if ( $defaultProto === PROTO_HTTPS
&& $wgHttpsPort != 443 ) {
636 $bits['port'] = $wgHttpsPort;
639 if ( $bits && isset( $bits['path'] ) ) {
640 $bits['path'] = wfRemoveDotSegments( $bits['path'] );
641 return wfAssembleUrl( $bits );
645 } elseif ( substr( $url, 0, 1 ) != '/' ) {
646 # URL is a relative path
647 return wfRemoveDotSegments( $url );
650 # Expanded URL is not valid.
655 * This function will reassemble a URL parsed with wfParseURL. This is useful
656 * if you need to edit part of a URL and put it back together.
658 * This is the basic structure used (brackets contain keys for $urlParts):
659 * [scheme][delimiter][user]:[pass]@[host]:[port][path]?[query]#[fragment]
661 * @todo Need to integrate this into wfExpandUrl (bug 32168)
664 * @param array $urlParts URL parts, as output from wfParseUrl
665 * @return string URL assembled from its component parts
667 function wfAssembleUrl( $urlParts ) {
670 if ( isset( $urlParts['delimiter'] ) ) {
671 if ( isset( $urlParts['scheme'] ) ) {
672 $result .= $urlParts['scheme'];
675 $result .= $urlParts['delimiter'];
678 if ( isset( $urlParts['host'] ) ) {
679 if ( isset( $urlParts['user'] ) ) {
680 $result .= $urlParts['user'];
681 if ( isset( $urlParts['pass'] ) ) {
682 $result .= ':' . $urlParts['pass'];
687 $result .= $urlParts['host'];
689 if ( isset( $urlParts['port'] ) ) {
690 $result .= ':' . $urlParts['port'];
694 if ( isset( $urlParts['path'] ) ) {
695 $result .= $urlParts['path'];
698 if ( isset( $urlParts['query'] ) ) {
699 $result .= '?' . $urlParts['query'];
702 if ( isset( $urlParts['fragment'] ) ) {
703 $result .= '#' . $urlParts['fragment'];
710 * Remove all dot-segments in the provided URL path. For example,
711 * '/a/./b/../c/' becomes '/a/c/'. For details on the algorithm, please see
712 * RFC3986 section 5.2.4.
714 * @todo Need to integrate this into wfExpandUrl (bug 32168)
716 * @param string $urlPath URL path, potentially containing dot-segments
717 * @return string URL path with all dot-segments removed
719 function wfRemoveDotSegments( $urlPath ) {
722 $inputLength = strlen( $urlPath );
724 while ( $inputOffset < $inputLength ) {
725 $prefixLengthOne = substr( $urlPath, $inputOffset, 1 );
726 $prefixLengthTwo = substr( $urlPath, $inputOffset, 2 );
727 $prefixLengthThree = substr( $urlPath, $inputOffset, 3 );
728 $prefixLengthFour = substr( $urlPath, $inputOffset, 4 );
731 if ( $prefixLengthTwo == './' ) {
732 # Step A, remove leading "./"
734 } elseif ( $prefixLengthThree == '../' ) {
735 # Step A, remove leading "../"
737 } elseif ( ( $prefixLengthTwo == '/.' ) && ( $inputOffset +
2 == $inputLength ) ) {
738 # Step B, replace leading "/.$" with "/"
740 $urlPath[$inputOffset] = '/';
741 } elseif ( $prefixLengthThree == '/./' ) {
742 # Step B, replace leading "/./" with "/"
744 } elseif ( $prefixLengthThree == '/..' && ( $inputOffset +
3 == $inputLength ) ) {
745 # Step C, replace leading "/..$" with "/" and
746 # remove last path component in output
748 $urlPath[$inputOffset] = '/';
750 } elseif ( $prefixLengthFour == '/../' ) {
751 # Step C, replace leading "/../" with "/" and
752 # remove last path component in output
755 } elseif ( ( $prefixLengthOne == '.' ) && ( $inputOffset +
1 == $inputLength ) ) {
756 # Step D, remove "^.$"
758 } elseif ( ( $prefixLengthTwo == '..' ) && ( $inputOffset +
2 == $inputLength ) ) {
759 # Step D, remove "^..$"
762 # Step E, move leading path segment to output
763 if ( $prefixLengthOne == '/' ) {
764 $slashPos = strpos( $urlPath, '/', $inputOffset +
1 );
766 $slashPos = strpos( $urlPath, '/', $inputOffset );
768 if ( $slashPos === false ) {
769 $output .= substr( $urlPath, $inputOffset );
770 $inputOffset = $inputLength;
772 $output .= substr( $urlPath, $inputOffset, $slashPos - $inputOffset );
773 $inputOffset +
= $slashPos - $inputOffset;
778 $slashPos = strrpos( $output, '/' );
779 if ( $slashPos === false ) {
782 $output = substr( $output, 0, $slashPos );
791 * Returns a regular expression of url protocols
793 * @param bool $includeProtocolRelative If false, remove '//' from the returned protocol list.
794 * DO NOT USE this directly, use wfUrlProtocolsWithoutProtRel() instead
797 function wfUrlProtocols( $includeProtocolRelative = true ) {
798 global $wgUrlProtocols;
800 // Cache return values separately based on $includeProtocolRelative
801 static $withProtRel = null, $withoutProtRel = null;
802 $cachedValue = $includeProtocolRelative ?
$withProtRel : $withoutProtRel;
803 if ( !is_null( $cachedValue ) ) {
807 // Support old-style $wgUrlProtocols strings, for backwards compatibility
808 // with LocalSettings files from 1.5
809 if ( is_array( $wgUrlProtocols ) ) {
810 $protocols = array();
811 foreach ( $wgUrlProtocols as $protocol ) {
812 // Filter out '//' if !$includeProtocolRelative
813 if ( $includeProtocolRelative ||
$protocol !== '//' ) {
814 $protocols[] = preg_quote( $protocol, '/' );
818 $retval = implode( '|', $protocols );
820 // Ignore $includeProtocolRelative in this case
821 // This case exists for pre-1.6 compatibility, and we can safely assume
822 // that '//' won't appear in a pre-1.6 config because protocol-relative
823 // URLs weren't supported until 1.18
824 $retval = $wgUrlProtocols;
827 // Cache return value
828 if ( $includeProtocolRelative ) {
829 $withProtRel = $retval;
831 $withoutProtRel = $retval;
837 * Like wfUrlProtocols(), but excludes '//' from the protocol list. Use this if
838 * you need a regex that matches all URL protocols but does not match protocol-
842 function wfUrlProtocolsWithoutProtRel() {
843 return wfUrlProtocols( false );
847 * parse_url() work-alike, but non-broken. Differences:
849 * 1) Does not raise warnings on bad URLs (just returns false).
850 * 2) Handles protocols that don't use :// (e.g., mailto: and news:, as well as
851 * protocol-relative URLs) correctly.
852 * 3) Adds a "delimiter" element to the array, either '://', ':' or '//' (see (2)).
854 * @param string $url A URL to parse
855 * @return string[] Bits of the URL in an associative array, per PHP docs
857 function wfParseUrl( $url ) {
858 global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
860 // Protocol-relative URLs are handled really badly by parse_url(). It's so
861 // bad that the easiest way to handle them is to just prepend 'http:' and
862 // strip the protocol out later.
863 $wasRelative = substr( $url, 0, 2 ) == '//';
864 if ( $wasRelative ) {
867 MediaWiki\
suppressWarnings();
868 $bits = parse_url( $url );
869 MediaWiki\restoreWarnings
();
870 // parse_url() returns an array without scheme for some invalid URLs, e.g.
871 // parse_url("%0Ahttp://example.com") == array( 'host' => '%0Ahttp', 'path' => 'example.com' )
872 if ( !$bits ||
!isset( $bits['scheme'] ) ) {
876 // parse_url() incorrectly handles schemes case-sensitively. Convert it to lowercase.
877 $bits['scheme'] = strtolower( $bits['scheme'] );
879 // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
880 if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
881 $bits['delimiter'] = '://';
882 } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
883 $bits['delimiter'] = ':';
884 // parse_url detects for news: and mailto: the host part of an url as path
885 // We have to correct this wrong detection
886 if ( isset( $bits['path'] ) ) {
887 $bits['host'] = $bits['path'];
894 /* Provide an empty host for eg. file:/// urls (see bug 28627) */
895 if ( !isset( $bits['host'] ) ) {
899 if ( isset( $bits['path'] ) ) {
900 /* parse_url loses the third / for file:///c:/ urls (but not on variants) */
901 if ( substr( $bits['path'], 0, 1 ) !== '/' ) {
902 $bits['path'] = '/' . $bits['path'];
909 // If the URL was protocol-relative, fix scheme and delimiter
910 if ( $wasRelative ) {
911 $bits['scheme'] = '';
912 $bits['delimiter'] = '//';
918 * Take a URL, make sure it's expanded to fully qualified, and replace any
919 * encoded non-ASCII Unicode characters with their UTF-8 original forms
920 * for more compact display and legibility for local audiences.
922 * @todo handle punycode domains too
927 function wfExpandIRI( $url ) {
928 return preg_replace_callback(
929 '/((?:%[89A-F][0-9A-F])+)/i',
930 'wfExpandIRI_callback',
936 * Private callback for wfExpandIRI
937 * @param array $matches
940 function wfExpandIRI_callback( $matches ) {
941 return urldecode( $matches[1] );
945 * Make URL indexes, appropriate for the el_index field of externallinks.
950 function wfMakeUrlIndexes( $url ) {
951 $bits = wfParseUrl( $url );
953 // Reverse the labels in the hostname, convert to lower case
954 // For emails reverse domainpart only
955 if ( $bits['scheme'] == 'mailto' ) {
956 $mailparts = explode( '@', $bits['host'], 2 );
957 if ( count( $mailparts ) === 2 ) {
958 $domainpart = strtolower( implode( '.', array_reverse( explode( '.', $mailparts[1] ) ) ) );
960 // No domain specified, don't mangle it
963 $reversedHost = $domainpart . '@' . $mailparts[0];
965 $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) );
967 // Add an extra dot to the end
968 // Why? Is it in wrong place in mailto links?
969 if ( substr( $reversedHost, -1, 1 ) !== '.' ) {
970 $reversedHost .= '.';
972 // Reconstruct the pseudo-URL
973 $prot = $bits['scheme'];
974 $index = $prot . $bits['delimiter'] . $reversedHost;
975 // Leave out user and password. Add the port, path, query and fragment
976 if ( isset( $bits['port'] ) ) {
977 $index .= ':' . $bits['port'];
979 if ( isset( $bits['path'] ) ) {
980 $index .= $bits['path'];
984 if ( isset( $bits['query'] ) ) {
985 $index .= '?' . $bits['query'];
987 if ( isset( $bits['fragment'] ) ) {
988 $index .= '#' . $bits['fragment'];
992 return array( "http:$index", "https:$index" );
994 return array( $index );
999 * Check whether a given URL has a domain that occurs in a given set of domains
1000 * @param string $url URL
1001 * @param array $domains Array of domains (strings)
1002 * @return bool True if the host part of $url ends in one of the strings in $domains
1004 function wfMatchesDomainList( $url, $domains ) {
1005 $bits = wfParseUrl( $url );
1006 if ( is_array( $bits ) && isset( $bits['host'] ) ) {
1007 $host = '.' . $bits['host'];
1008 foreach ( (array)$domains as $domain ) {
1009 $domain = '.' . $domain;
1010 if ( substr( $host, -strlen( $domain ) ) === $domain ) {
1019 * Sends a line to the debug log if enabled or, optionally, to a comment in output.
1020 * In normal operation this is a NOP.
1022 * Controlling globals:
1023 * $wgDebugLogFile - points to the log file
1024 * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
1025 * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
1027 * @since 1.25 support for additional context data
1029 * @param string $text
1030 * @param string|bool $dest Unused
1031 * @param array $context Additional logging context data
1033 function wfDebug( $text, $dest = 'all', array $context = array() ) {
1034 global $wgDebugRawPage, $wgDebugLogPrefix;
1035 global $wgDebugTimestamps, $wgRequestTime;
1037 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1041 $text = trim( $text );
1043 // Inline logic from deprecated wfDebugTimer()
1044 if ( $wgDebugTimestamps ) {
1045 $context['seconds_elapsed'] = sprintf(
1047 microtime( true ) - $wgRequestTime
1049 $context['memory_used'] = sprintf(
1051 ( memory_get_usage( true ) / ( 1024 * 1024 ) )
1055 if ( $wgDebugLogPrefix !== '' ) {
1056 $context['prefix'] = $wgDebugLogPrefix;
1059 $logger = LoggerFactory
::getInstance( 'wfDebug' );
1060 $logger->debug( $text, $context );
1064 * Returns true if debug logging should be suppressed if $wgDebugRawPage = false
1067 function wfIsDebugRawPage() {
1069 if ( $cache !== null ) {
1072 # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
1073 if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
1075 isset( $_SERVER['SCRIPT_NAME'] )
1076 && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
1087 * Get microsecond timestamps for debug logs
1089 * @deprecated since 1.25
1092 function wfDebugTimer() {
1093 global $wgDebugTimestamps, $wgRequestTime;
1095 wfDeprecated( __METHOD__
, '1.25' );
1097 if ( !$wgDebugTimestamps ) {
1101 $prefix = sprintf( "%6.4f", microtime( true ) - $wgRequestTime );
1102 $mem = sprintf( "%5.1fM", ( memory_get_usage( true ) / ( 1024 * 1024 ) ) );
1103 return "$prefix $mem ";
1107 * Send a line giving PHP memory usage.
1109 * @param bool $exact Print exact byte values instead of kibibytes (default: false)
1111 function wfDebugMem( $exact = false ) {
1112 $mem = memory_get_usage();
1114 $mem = floor( $mem / 1024 ) . ' KiB';
1118 wfDebug( "Memory usage: $mem\n" );
1122 * Send a line to a supplementary debug log file, if configured, or main debug
1125 * To configure a supplementary log file, set $wgDebugLogGroups[$logGroup] to
1126 * a string filename or an associative array mapping 'destination' to the
1127 * desired filename. The associative array may also contain a 'sample' key
1128 * with an integer value, specifying a sampling factor. Sampled log events
1129 * will be emitted with a 1 in N random chance.
1131 * @since 1.23 support for sampling log messages via $wgDebugLogGroups.
1132 * @since 1.25 support for additional context data
1133 * @since 1.25 sample behavior dependent on configured $wgMWLoggerDefaultSpi
1135 * @param string $logGroup
1136 * @param string $text
1137 * @param string|bool $dest Destination of the message:
1138 * - 'all': both to the log and HTML (debug toolbar or HTML comments)
1139 * - 'log': only to the log and not in HTML
1140 * - 'private': only to the specific log if set in $wgDebugLogGroups and
1141 * discarded otherwise
1142 * For backward compatibility, it can also take a boolean:
1143 * - true: same as 'all'
1144 * - false: same as 'private'
1145 * @param array $context Additional logging context data
1147 function wfDebugLog(
1148 $logGroup, $text, $dest = 'all', array $context = array()
1150 // Turn $dest into a string if it's a boolean (for b/c)
1151 if ( $dest === true ) {
1153 } elseif ( $dest === false ) {
1157 $text = trim( $text );
1159 $logger = LoggerFactory
::getInstance( $logGroup );
1160 $context['private'] = ( $dest === 'private' );
1161 $logger->info( $text, $context );
1165 * Log for database errors
1167 * @since 1.25 support for additional context data
1169 * @param string $text Database error message.
1170 * @param array $context Additional logging context data
1172 function wfLogDBError( $text, array $context = array() ) {
1173 $logger = LoggerFactory
::getInstance( 'wfLogDBError' );
1174 $logger->error( trim( $text ), $context );
1178 * Throws a warning that $function is deprecated
1180 * @param string $function
1181 * @param string|bool $version Version of MediaWiki that the function
1182 * was deprecated in (Added in 1.19).
1183 * @param string|bool $component Added in 1.19.
1184 * @param int $callerOffset How far up the call stack is the original
1185 * caller. 2 = function that called the function that called
1186 * wfDeprecated (Added in 1.20)
1190 function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) {
1191 MWDebug
::deprecated( $function, $version, $component, $callerOffset +
1 );
1195 * Send a warning either to the debug log or in a PHP error depending on
1196 * $wgDevelopmentWarnings. To log warnings in production, use wfLogWarning() instead.
1198 * @param string $msg Message to send
1199 * @param int $callerOffset Number of items to go back in the backtrace to
1200 * find the correct caller (1 = function calling wfWarn, ...)
1201 * @param int $level PHP error level; defaults to E_USER_NOTICE;
1202 * only used when $wgDevelopmentWarnings is true
1204 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE
) {
1205 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'auto' );
1209 * Send a warning as a PHP error and the debug log. This is intended for logging
1210 * warnings in production. For logging development warnings, use WfWarn instead.
1212 * @param string $msg Message to send
1213 * @param int $callerOffset Number of items to go back in the backtrace to
1214 * find the correct caller (1 = function calling wfLogWarning, ...)
1215 * @param int $level PHP error level; defaults to E_USER_WARNING
1217 function wfLogWarning( $msg, $callerOffset = 1, $level = E_USER_WARNING
) {
1218 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'production' );
1222 * Log to a file without getting "file size exceeded" signals.
1224 * Can also log to TCP or UDP with the syntax udp://host:port/prefix. This will
1225 * send lines to the specified port, prefixed by the specified prefix and a space.
1226 * @since 1.25 support for additional context data
1228 * @param string $text
1229 * @param string $file Filename
1230 * @param array $context Additional logging context data
1231 * @throws MWException
1232 * @deprecated since 1.25 Use MediaWiki\Logger\LegacyLogger::emit or UDPTransport
1234 function wfErrorLog( $text, $file, array $context = array() ) {
1235 wfDeprecated( __METHOD__
, '1.25' );
1236 $logger = LoggerFactory
::getInstance( 'wfErrorLog' );
1237 $context['destination'] = $file;
1238 $logger->info( trim( $text ), $context );
1244 function wfLogProfilingData() {
1245 global $wgDebugLogGroups, $wgDebugRawPage;
1247 $context = RequestContext
::getMain();
1248 $request = $context->getRequest();
1250 $profiler = Profiler
::instance();
1251 $profiler->setContext( $context );
1252 $profiler->logData();
1254 $config = $context->getConfig();
1255 if ( $config->get( 'StatsdServer' ) ) {
1257 $statsdServer = explode( ':', $config->get( 'StatsdServer' ) );
1258 $statsdHost = $statsdServer[0];
1259 $statsdPort = isset( $statsdServer[1] ) ?
$statsdServer[1] : 8125;
1260 $statsdSender = new SocketSender( $statsdHost, $statsdPort );
1261 $statsdClient = new SamplingStatsdClient( $statsdSender, true, false );
1262 $statsdClient->send( $context->getStats()->getBuffer() );
1263 } catch ( Exception
$ex ) {
1264 MWExceptionHandler
::logException( $ex );
1268 # Profiling must actually be enabled...
1269 if ( $profiler instanceof ProfilerStub
) {
1273 if ( isset( $wgDebugLogGroups['profileoutput'] )
1274 && $wgDebugLogGroups['profileoutput'] === false
1276 // Explicitly disabled
1279 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1283 $ctx = array( 'elapsed' => $request->getElapsedTime() );
1284 if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1285 $ctx['forwarded_for'] = $_SERVER['HTTP_X_FORWARDED_FOR'];
1287 if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1288 $ctx['client_ip'] = $_SERVER['HTTP_CLIENT_IP'];
1290 if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1291 $ctx['from'] = $_SERVER['HTTP_FROM'];
1293 if ( isset( $ctx['forwarded_for'] ) ||
1294 isset( $ctx['client_ip'] ) ||
1295 isset( $ctx['from'] ) ) {
1296 $ctx['proxy'] = $_SERVER['REMOTE_ADDR'];
1299 // Don't load $wgUser at this late stage just for statistics purposes
1300 // @todo FIXME: We can detect some anons even if it is not loaded.
1301 // See User::getId()
1302 $user = $context->getUser();
1303 $ctx['anon'] = $user->isItemLoaded( 'id' ) && $user->isAnon();
1305 // Command line script uses a FauxRequest object which does not have
1306 // any knowledge about an URL and throw an exception instead.
1308 $ctx['url'] = urldecode( $request->getRequestURL() );
1309 } catch ( Exception
$ignored ) {
1313 $ctx['output'] = $profiler->getOutput();
1315 $log = LoggerFactory
::getInstance( 'profileoutput' );
1316 $log->info( "Elapsed: {elapsed}; URL: <{url}>\n{output}", $ctx );
1320 * Increment a statistics counter
1322 * @param string $key
1326 function wfIncrStats( $key, $count = 1 ) {
1327 $stats = RequestContext
::getMain()->getStats();
1328 $stats->updateCount( $key, $count );
1332 * Check whether the wiki is in read-only mode.
1336 function wfReadOnly() {
1337 return wfReadOnlyReason() !== false;
1341 * Get the value of $wgReadOnly or the contents of $wgReadOnlyFile.
1343 * @return string|bool String when in read-only mode; false otherwise
1345 function wfReadOnlyReason() {
1346 global $wgReadOnly, $wgReadOnlyFile;
1348 if ( $wgReadOnly === null ) {
1349 // Set $wgReadOnly for faster access next time
1350 if ( is_file( $wgReadOnlyFile ) && filesize( $wgReadOnlyFile ) > 0 ) {
1351 $wgReadOnly = file_get_contents( $wgReadOnlyFile );
1353 $wgReadOnly = false;
1355 // Callers use this method to be aware that data presented to a user
1356 // may be very stale and thus allowing submissions can be problematic.
1358 if ( $wgReadOnly === false && wfGetLB()->getLaggedSlaveMode() ) {
1359 $wgReadOnly = 'The database has been automatically locked ' .
1360 'while the slave database servers catch up to the master';
1362 } catch ( DBConnectionError
$e ) {
1363 $wgReadOnly = 'The database has been automatically locked ' .
1364 'until the slave database servers become available';
1372 * Return a Language object from $langcode
1374 * @param Language|string|bool $langcode Either:
1375 * - a Language object
1376 * - code of the language to get the message for, if it is
1377 * a valid code create a language for that language, if
1378 * it is a string but not a valid code then make a basic
1380 * - a boolean: if it's false then use the global object for
1381 * the current user's language (as a fallback for the old parameter
1382 * functionality), or if it is true then use global object
1383 * for the wiki's content language.
1386 function wfGetLangObj( $langcode = false ) {
1387 # Identify which language to get or create a language object for.
1388 # Using is_object here due to Stub objects.
1389 if ( is_object( $langcode ) ) {
1390 # Great, we already have the object (hopefully)!
1394 global $wgContLang, $wgLanguageCode;
1395 if ( $langcode === true ||
$langcode === $wgLanguageCode ) {
1396 # $langcode is the language code of the wikis content language object.
1397 # or it is a boolean and value is true
1402 if ( $langcode === false ||
$langcode === $wgLang->getCode() ) {
1403 # $langcode is the language code of user language object.
1404 # or it was a boolean and value is false
1408 $validCodes = array_keys( Language
::fetchLanguageNames() );
1409 if ( in_array( $langcode, $validCodes ) ) {
1410 # $langcode corresponds to a valid language.
1411 return Language
::factory( $langcode );
1414 # $langcode is a string, but not a valid language code; use content language.
1415 wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1420 * This is the function for getting translated interface messages.
1422 * @see Message class for documentation how to use them.
1423 * @see https://www.mediawiki.org/wiki/Manual:Messages_API
1425 * This function replaces all old wfMsg* functions.
1427 * @param string|string[]|MessageSpecifier $key Message key, or array of keys, or a MessageSpecifier
1428 * @param mixed $params,... Normal message parameters
1433 * @see Message::__construct
1435 function wfMessage( $key /*...*/ ) {
1436 $params = func_get_args();
1437 array_shift( $params );
1438 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
1439 $params = $params[0];
1441 return new Message( $key, $params );
1445 * This function accepts multiple message keys and returns a message instance
1446 * for the first message which is non-empty. If all messages are empty then an
1447 * instance of the first message key is returned.
1449 * @param string|string[] $keys,... Message keys
1454 * @see Message::newFallbackSequence
1456 function wfMessageFallback( /*...*/ ) {
1457 $args = func_get_args();
1458 return call_user_func_array( 'Message::newFallbackSequence', $args );
1462 * Get a message from anywhere, for the current user language.
1464 * Use wfMsgForContent() instead if the message should NOT
1465 * change depending on the user preferences.
1467 * @deprecated since 1.18
1469 * @param string $key Lookup key for the message, usually
1470 * defined in languages/Language.php
1472 * Parameters to the message, which can be used to insert variable text into
1473 * it, can be passed to this function in the following formats:
1474 * - One per argument, starting at the second parameter
1475 * - As an array in the second parameter
1476 * These are not shown in the function definition.
1480 function wfMsg( $key ) {
1481 wfDeprecated( __METHOD__
, '1.21' );
1483 $args = func_get_args();
1484 array_shift( $args );
1485 return wfMsgReal( $key, $args );
1489 * Same as above except doesn't transform the message
1491 * @deprecated since 1.18
1493 * @param string $key
1496 function wfMsgNoTrans( $key ) {
1497 wfDeprecated( __METHOD__
, '1.21' );
1499 $args = func_get_args();
1500 array_shift( $args );
1501 return wfMsgReal( $key, $args, true, false, false );
1505 * Get a message from anywhere, for the current global language
1506 * set with $wgLanguageCode.
1508 * Use this if the message should NOT change dependent on the
1509 * language set in the user's preferences. This is the case for
1510 * most text written into logs, as well as link targets (such as
1511 * the name of the copyright policy page). Link titles, on the
1512 * other hand, should be shown in the UI language.
1514 * Note that MediaWiki allows users to change the user interface
1515 * language in their preferences, but a single installation
1516 * typically only contains content in one language.
1518 * Be wary of this distinction: If you use wfMsg() where you should
1519 * use wfMsgForContent(), a user of the software may have to
1520 * customize potentially hundreds of messages in
1521 * order to, e.g., fix a link in every possible language.
1523 * @deprecated since 1.18
1525 * @param string $key Lookup key for the message, usually
1526 * defined in languages/Language.php
1529 function wfMsgForContent( $key ) {
1530 wfDeprecated( __METHOD__
, '1.21' );
1532 global $wgForceUIMsgAsContentMsg;
1533 $args = func_get_args();
1534 array_shift( $args );
1536 if ( is_array( $wgForceUIMsgAsContentMsg )
1537 && in_array( $key, $wgForceUIMsgAsContentMsg )
1539 $forcontent = false;
1541 return wfMsgReal( $key, $args, true, $forcontent );
1545 * Same as above except doesn't transform the message
1547 * @deprecated since 1.18
1549 * @param string $key
1552 function wfMsgForContentNoTrans( $key ) {
1553 wfDeprecated( __METHOD__
, '1.21' );
1555 global $wgForceUIMsgAsContentMsg;
1556 $args = func_get_args();
1557 array_shift( $args );
1559 if ( is_array( $wgForceUIMsgAsContentMsg )
1560 && in_array( $key, $wgForceUIMsgAsContentMsg )
1562 $forcontent = false;
1564 return wfMsgReal( $key, $args, true, $forcontent, false );
1568 * Really get a message
1570 * @deprecated since 1.18
1572 * @param string $key Key to get.
1573 * @param array $args
1574 * @param bool $useDB
1575 * @param string|bool $forContent Language code, or false for user lang, true for content lang.
1576 * @param bool $transform Whether or not to transform the message.
1577 * @return string The requested message.
1579 function wfMsgReal( $key, $args, $useDB = true, $forContent = false, $transform = true ) {
1580 wfDeprecated( __METHOD__
, '1.21' );
1582 $message = wfMsgGetKey( $key, $useDB, $forContent, $transform );
1583 $message = wfMsgReplaceArgs( $message, $args );
1588 * Fetch a message string value, but don't replace any keys yet.
1590 * @deprecated since 1.18
1592 * @param string $key
1593 * @param bool $useDB
1594 * @param string|bool $langCode Code of the language to get the message for, or
1595 * behaves as a content language switch if it is a boolean.
1596 * @param bool $transform Whether to parse magic words, etc.
1599 function wfMsgGetKey( $key, $useDB = true, $langCode = false, $transform = true ) {
1600 wfDeprecated( __METHOD__
, '1.21' );
1602 Hooks
::run( 'NormalizeMessageKey', array( &$key, &$useDB, &$langCode, &$transform ) );
1604 $cache = MessageCache
::singleton();
1605 $message = $cache->get( $key, $useDB, $langCode );
1606 if ( $message === false ) {
1607 $message = '<' . htmlspecialchars( $key ) . '>';
1608 } elseif ( $transform ) {
1609 $message = $cache->transform( $message );
1615 * Replace message parameter keys on the given formatted output.
1617 * @param string $message
1618 * @param array $args
1622 function wfMsgReplaceArgs( $message, $args ) {
1623 # Fix windows line-endings
1624 # Some messages are split with explode("\n", $msg)
1625 $message = str_replace( "\r", '', $message );
1627 // Replace arguments
1628 if ( count( $args ) ) {
1629 if ( is_array( $args[0] ) ) {
1630 $args = array_values( $args[0] );
1632 $replacementKeys = array();
1633 foreach ( $args as $n => $param ) {
1634 $replacementKeys['$' . ( $n +
1 )] = $param;
1636 $message = strtr( $message, $replacementKeys );
1643 * Return an HTML-escaped version of a message.
1644 * Parameter replacements, if any, are done *after* the HTML-escaping,
1645 * so parameters may contain HTML (eg links or form controls). Be sure
1646 * to pre-escape them if you really do want plaintext, or just wrap
1647 * the whole thing in htmlspecialchars().
1649 * @deprecated since 1.18
1651 * @param string $key
1652 * @param string $args,... Parameters
1655 function wfMsgHtml( $key ) {
1656 wfDeprecated( __METHOD__
, '1.21' );
1658 $args = func_get_args();
1659 array_shift( $args );
1660 return wfMsgReplaceArgs( htmlspecialchars( wfMsgGetKey( $key ) ), $args );
1664 * Return an HTML version of message
1665 * Parameter replacements, if any, are done *after* parsing the wiki-text message,
1666 * so parameters may contain HTML (eg links or form controls). Be sure
1667 * to pre-escape them if you really do want plaintext, or just wrap
1668 * the whole thing in htmlspecialchars().
1670 * @deprecated since 1.18
1672 * @param string $key
1673 * @param string $args,... Parameters
1676 function wfMsgWikiHtml( $key ) {
1677 wfDeprecated( __METHOD__
, '1.21' );
1679 $args = func_get_args();
1680 array_shift( $args );
1681 return wfMsgReplaceArgs(
1682 MessageCache
::singleton()->parse( wfMsgGetKey( $key ), null,
1683 /* can't be set to false */ true, /* interface */ true )->getText(),
1688 * Returns message in the requested format
1690 * @deprecated since 1.18
1692 * @param string $key Key of the message
1693 * @param array $options Processing rules.
1694 * Can take the following options:
1695 * parse: parses wikitext to HTML
1696 * parseinline: parses wikitext to HTML and removes the surrounding
1697 * p's added by parser or tidy
1698 * escape: filters message through htmlspecialchars
1699 * escapenoentities: same, but allows entity references like   through
1700 * replaceafter: parameters are substituted after parsing or escaping
1701 * parsemag: transform the message using magic phrases
1702 * content: fetch message for content language instead of interface
1703 * Also can accept a single associative argument, of the form 'language' => 'xx':
1704 * language: Language object or language code to fetch message for
1705 * (overridden by content).
1706 * Behavior for conflicting options (e.g., parse+parseinline) is undefined.
1710 function wfMsgExt( $key, $options ) {
1711 wfDeprecated( __METHOD__
, '1.21' );
1713 $args = func_get_args();
1714 array_shift( $args );
1715 array_shift( $args );
1716 $options = (array)$options;
1717 $validOptions = array( 'parse', 'parseinline', 'escape', 'escapenoentities', 'replaceafter',
1718 'parsemag', 'content' );
1720 foreach ( $options as $arrayKey => $option ) {
1721 if ( !preg_match( '/^[0-9]+|language$/', $arrayKey ) ) {
1722 // An unknown index, neither numeric nor "language"
1723 wfWarn( "wfMsgExt called with incorrect parameter key $arrayKey", 1, E_USER_WARNING
);
1724 } elseif ( preg_match( '/^[0-9]+$/', $arrayKey ) && !in_array( $option, $validOptions ) ) {
1725 // A numeric index with unknown value
1726 wfWarn( "wfMsgExt called with incorrect parameter $option", 1, E_USER_WARNING
);
1730 if ( in_array( 'content', $options, true ) ) {
1733 $langCodeObj = null;
1734 } elseif ( array_key_exists( 'language', $options ) ) {
1735 $forContent = false;
1736 $langCode = wfGetLangObj( $options['language'] );
1737 $langCodeObj = $langCode;
1739 $forContent = false;
1741 $langCodeObj = null;
1744 $string = wfMsgGetKey( $key, /*DB*/true, $langCode, /*Transform*/false );
1746 if ( !in_array( 'replaceafter', $options, true ) ) {
1747 $string = wfMsgReplaceArgs( $string, $args );
1750 $messageCache = MessageCache
::singleton();
1751 $parseInline = in_array( 'parseinline', $options, true );
1752 if ( in_array( 'parse', $options, true ) ||
$parseInline ) {
1753 $string = $messageCache->parse( $string, null, true, !$forContent, $langCodeObj );
1754 if ( $string instanceof ParserOutput
) {
1755 $string = $string->getText();
1758 if ( $parseInline ) {
1759 $string = Parser
::stripOuterParagraph( $string );
1761 } elseif ( in_array( 'parsemag', $options, true ) ) {
1762 $string = $messageCache->transform( $string,
1763 !$forContent, $langCodeObj );
1766 if ( in_array( 'escape', $options, true ) ) {
1767 $string = htmlspecialchars( $string );
1768 } elseif ( in_array( 'escapenoentities', $options, true ) ) {
1769 $string = Sanitizer
::escapeHtmlAllowEntities( $string );
1772 if ( in_array( 'replaceafter', $options, true ) ) {
1773 $string = wfMsgReplaceArgs( $string, $args );
1780 * Since wfMsg() and co suck, they don't return false if the message key they
1781 * looked up didn't exist but instead the key wrapped in <>'s, this function checks for the
1782 * nonexistence of messages by checking the MessageCache::get() result directly.
1784 * @deprecated since 1.18. Use Message::isDisabled().
1786 * @param string $key The message key looked up
1787 * @return bool True if the message *doesn't* exist.
1789 function wfEmptyMsg( $key ) {
1790 wfDeprecated( __METHOD__
, '1.21' );
1792 return MessageCache
::singleton()->get( $key, /*useDB*/true, /*content*/false ) === false;
1796 * Fetch server name for use in error reporting etc.
1797 * Use real server name if available, so we know which machine
1798 * in a server farm generated the current page.
1802 function wfHostname() {
1804 if ( is_null( $host ) ) {
1806 # Hostname overriding
1807 global $wgOverrideHostname;
1808 if ( $wgOverrideHostname !== false ) {
1809 # Set static and skip any detection
1810 $host = $wgOverrideHostname;
1814 if ( function_exists( 'posix_uname' ) ) {
1815 // This function not present on Windows
1816 $uname = posix_uname();
1820 if ( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1821 $host = $uname['nodename'];
1822 } elseif ( getenv( 'COMPUTERNAME' ) ) {
1823 # Windows computer name
1824 $host = getenv( 'COMPUTERNAME' );
1826 # This may be a virtual server.
1827 $host = $_SERVER['SERVER_NAME'];
1834 * Returns a script tag that stores the amount of time it took MediaWiki to
1835 * handle the request in milliseconds as 'wgBackendResponseTime'.
1837 * If $wgShowHostnames is true, the script will also set 'wgHostname' to the
1838 * hostname of the server handling the request.
1842 function wfReportTime() {
1843 global $wgRequestTime, $wgShowHostnames;
1845 $responseTime = round( ( microtime( true ) - $wgRequestTime ) * 1000 );
1846 $reportVars = array( 'wgBackendResponseTime' => $responseTime );
1847 if ( $wgShowHostnames ) {
1848 $reportVars['wgHostname'] = wfHostname();
1850 return Skin
::makeVariablesScript( $reportVars );
1854 * Safety wrapper for debug_backtrace().
1856 * Will return an empty array if debug_backtrace is disabled, otherwise
1857 * the output from debug_backtrace() (trimmed).
1859 * @param int $limit This parameter can be used to limit the number of stack frames returned
1861 * @return array Array of backtrace information
1863 function wfDebugBacktrace( $limit = 0 ) {
1864 static $disabled = null;
1866 if ( is_null( $disabled ) ) {
1867 $disabled = !function_exists( 'debug_backtrace' );
1869 wfDebug( "debug_backtrace() is disabled\n" );
1876 if ( $limit && version_compare( PHP_VERSION
, '5.4.0', '>=' ) ) {
1877 return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT
, $limit +
1 ), 1 );
1879 return array_slice( debug_backtrace(), 1 );
1884 * Get a debug backtrace as a string
1886 * @param bool|null $raw If true, the return value is plain text. If false, HTML.
1887 * Defaults to $wgCommandLineMode if unset.
1889 * @since 1.25 Supports $raw parameter.
1891 function wfBacktrace( $raw = null ) {
1892 global $wgCommandLineMode;
1894 if ( $raw === null ) {
1895 $raw = $wgCommandLineMode;
1899 $frameFormat = "%s line %s calls %s()\n";
1900 $traceFormat = "%s";
1902 $frameFormat = "<li>%s line %s calls %s()</li>\n";
1903 $traceFormat = "<ul>\n%s</ul>\n";
1906 $frames = array_map( function ( $frame ) use ( $frameFormat ) {
1907 $file = !empty( $frame['file'] ) ?
basename( $frame['file'] ) : '-';
1908 $line = isset( $frame['line'] ) ?
$frame['line'] : '-';
1909 $call = $frame['function'];
1910 if ( !empty( $frame['class'] ) ) {
1911 $call = $frame['class'] . $frame['type'] . $call;
1913 return sprintf( $frameFormat, $file, $line, $call );
1914 }, wfDebugBacktrace() );
1916 return sprintf( $traceFormat, implode( '', $frames ) );
1920 * Get the name of the function which called this function
1921 * wfGetCaller( 1 ) is the function with the wfGetCaller() call (ie. __FUNCTION__)
1922 * wfGetCaller( 2 ) [default] is the caller of the function running wfGetCaller()
1923 * wfGetCaller( 3 ) is the parent of that.
1928 function wfGetCaller( $level = 2 ) {
1929 $backtrace = wfDebugBacktrace( $level +
1 );
1930 if ( isset( $backtrace[$level] ) ) {
1931 return wfFormatStackFrame( $backtrace[$level] );
1938 * Return a string consisting of callers in the stack. Useful sometimes
1939 * for profiling specific points.
1941 * @param int $limit The maximum depth of the stack frame to return, or false for the entire stack.
1944 function wfGetAllCallers( $limit = 3 ) {
1945 $trace = array_reverse( wfDebugBacktrace() );
1946 if ( !$limit ||
$limit > count( $trace ) - 1 ) {
1947 $limit = count( $trace ) - 1;
1949 $trace = array_slice( $trace, -$limit - 1, $limit );
1950 return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1954 * Return a string representation of frame
1956 * @param array $frame
1959 function wfFormatStackFrame( $frame ) {
1960 return isset( $frame['class'] ) ?
1961 $frame['class'] . '::' . $frame['function'] :
1965 /* Some generic result counters, pulled out of SearchEngine */
1970 * @param int $offset
1974 function wfShowingResults( $offset, $limit ) {
1975 return wfMessage( 'showingresults' )->numParams( $limit, $offset +
1 )->parse();
1980 * @todo FIXME: We may want to blacklist some broken browsers
1982 * @param bool $force
1983 * @return bool Whereas client accept gzip compression
1985 function wfClientAcceptsGzip( $force = false ) {
1986 static $result = null;
1987 if ( $result === null ||
$force ) {
1989 if ( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
1990 # @todo FIXME: We may want to blacklist some broken browsers
1993 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
1994 $_SERVER['HTTP_ACCEPT_ENCODING'],
1998 if ( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
2002 wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
2011 * Obtain the offset and limit values from the request string;
2012 * used in special pages
2014 * @param int $deflimit Default limit if none supplied
2015 * @param string $optionname Name of a user preference to check against
2017 * @deprecated since 1.24, just call WebRequest::getLimitOffset() directly
2019 function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
2021 wfDeprecated( __METHOD__
, '1.24' );
2022 return $wgRequest->getLimitOffset( $deflimit, $optionname );
2026 * Escapes the given text so that it may be output using addWikiText()
2027 * without any linking, formatting, etc. making its way through. This
2028 * is achieved by substituting certain characters with HTML entities.
2029 * As required by the callers, "<nowiki>" is not used.
2031 * @param string $text Text to be escaped
2034 function wfEscapeWikiText( $text ) {
2035 static $repl = null, $repl2 = null;
2036 if ( $repl === null ) {
2038 '"' => '"', '&' => '&', "'" => ''', '<' => '<',
2039 '=' => '=', '>' => '>', '[' => '[', ']' => ']',
2040 '{' => '{', '|' => '|', '}' => '}', ';' => ';',
2041 "\n#" => "\n#", "\r#" => "\r#",
2042 "\n*" => "\n*", "\r*" => "\r*",
2043 "\n:" => "\n:", "\r:" => "\r:",
2044 "\n " => "\n ", "\r " => "\r ",
2045 "\n\n" => "\n ", "\r\n" => " \n",
2046 "\n\r" => "\n ", "\r\r" => "\r ",
2047 "\n\t" => "\n	", "\r\t" => "\r	", // "\n\t\n" is treated like "\n\n"
2048 "\n----" => "\n----", "\r----" => "\r----",
2049 '__' => '__', '://' => '://',
2052 // We have to catch everything "\s" matches in PCRE
2053 foreach ( array( 'ISBN', 'RFC', 'PMID' ) as $magic ) {
2054 $repl["$magic "] = "$magic ";
2055 $repl["$magic\t"] = "$magic	";
2056 $repl["$magic\r"] = "$magic ";
2057 $repl["$magic\n"] = "$magic ";
2058 $repl["$magic\f"] = "$magic";
2061 // And handle protocols that don't use "://"
2062 global $wgUrlProtocols;
2064 foreach ( $wgUrlProtocols as $prot ) {
2065 if ( substr( $prot, -1 ) === ':' ) {
2066 $repl2[] = preg_quote( substr( $prot, 0, -1 ), '/' );
2069 $repl2 = $repl2 ?
'/\b(' . join( '|', $repl2 ) . '):/i' : '/^(?!)/';
2071 $text = substr( strtr( "\n$text", $repl ), 1 );
2072 $text = preg_replace( $repl2, '$1:', $text );
2077 * Sets dest to source and returns the original value of dest
2078 * If source is NULL, it just returns the value, it doesn't set the variable
2079 * If force is true, it will set the value even if source is NULL
2081 * @param mixed $dest
2082 * @param mixed $source
2083 * @param bool $force
2086 function wfSetVar( &$dest, $source, $force = false ) {
2088 if ( !is_null( $source ) ||
$force ) {
2095 * As for wfSetVar except setting a bit
2099 * @param bool $state
2103 function wfSetBit( &$dest, $bit, $state = true ) {
2104 $temp = (bool)( $dest & $bit );
2105 if ( !is_null( $state ) ) {
2116 * A wrapper around the PHP function var_export().
2117 * Either print it or add it to the regular output ($wgOut).
2119 * @param mixed $var A PHP variable to dump.
2121 function wfVarDump( $var ) {
2123 $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
2124 if ( headers_sent() ||
!isset( $wgOut ) ||
!is_object( $wgOut ) ) {
2127 $wgOut->addHTML( $s );
2132 * Provide a simple HTTP error.
2134 * @param int|string $code
2135 * @param string $label
2136 * @param string $desc
2138 function wfHttpError( $code, $label, $desc ) {
2140 HttpStatus
::header( $code );
2143 $wgOut->sendCacheControl();
2146 header( 'Content-type: text/html; charset=utf-8' );
2147 print '<!DOCTYPE html>' .
2148 '<html><head><title>' .
2149 htmlspecialchars( $label ) .
2150 '</title></head><body><h1>' .
2151 htmlspecialchars( $label ) .
2153 nl2br( htmlspecialchars( $desc ) ) .
2154 "</p></body></html>\n";
2158 * Clear away any user-level output buffers, discarding contents.
2160 * Suitable for 'starting afresh', for instance when streaming
2161 * relatively large amounts of data without buffering, or wanting to
2162 * output image files without ob_gzhandler's compression.
2164 * The optional $resetGzipEncoding parameter controls suppression of
2165 * the Content-Encoding header sent by ob_gzhandler; by default it
2166 * is left. See comments for wfClearOutputBuffers() for why it would
2169 * Note that some PHP configuration options may add output buffer
2170 * layers which cannot be removed; these are left in place.
2172 * @param bool $resetGzipEncoding
2174 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
2175 if ( $resetGzipEncoding ) {
2176 // Suppress Content-Encoding and Content-Length
2177 // headers from 1.10+s wfOutputHandler
2178 global $wgDisableOutputCompression;
2179 $wgDisableOutputCompression = true;
2181 while ( $status = ob_get_status() ) {
2182 if ( $status['type'] == 0 /* PHP_OUTPUT_HANDLER_INTERNAL */ ) {
2183 // Probably from zlib.output_compression or other
2184 // PHP-internal setting which can't be removed.
2186 // Give up, and hope the result doesn't break
2190 if ( !ob_end_clean() ) {
2191 // Could not remove output buffer handler; abort now
2192 // to avoid getting in some kind of infinite loop.
2195 if ( $resetGzipEncoding ) {
2196 if ( $status['name'] == 'ob_gzhandler' ) {
2197 // Reset the 'Content-Encoding' field set by this handler
2198 // so we can start fresh.
2199 header_remove( 'Content-Encoding' );
2207 * More legible than passing a 'false' parameter to wfResetOutputBuffers():
2209 * Clear away output buffers, but keep the Content-Encoding header
2210 * produced by ob_gzhandler, if any.
2212 * This should be used for HTTP 304 responses, where you need to
2213 * preserve the Content-Encoding header of the real result, but
2214 * also need to suppress the output of ob_gzhandler to keep to spec
2215 * and avoid breaking Firefox in rare cases where the headers and
2216 * body are broken over two packets.
2218 function wfClearOutputBuffers() {
2219 wfResetOutputBuffers( false );
2223 * Converts an Accept-* header into an array mapping string values to quality
2226 * @param string $accept
2227 * @param string $def Default
2228 * @return float[] Associative array of string => float pairs
2230 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
2231 # No arg means accept anything (per HTTP spec)
2233 return array( $def => 1.0 );
2238 $parts = explode( ',', $accept );
2240 foreach ( $parts as $part ) {
2241 # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
2242 $values = explode( ';', trim( $part ) );
2244 if ( count( $values ) == 1 ) {
2245 $prefs[$values[0]] = 1.0;
2246 } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
2247 $prefs[$values[0]] = floatval( $match[1] );
2255 * Checks if a given MIME type matches any of the keys in the given
2256 * array. Basic wildcards are accepted in the array keys.
2258 * Returns the matching MIME type (or wildcard) if a match, otherwise
2261 * @param string $type
2262 * @param array $avail
2266 function mimeTypeMatch( $type, $avail ) {
2267 if ( array_key_exists( $type, $avail ) ) {
2270 $parts = explode( '/', $type );
2271 if ( array_key_exists( $parts[0] . '/*', $avail ) ) {
2272 return $parts[0] . '/*';
2273 } elseif ( array_key_exists( '*/*', $avail ) ) {
2282 * Returns the 'best' match between a client's requested internet media types
2283 * and the server's list of available types. Each list should be an associative
2284 * array of type to preference (preference is a float between 0.0 and 1.0).
2285 * Wildcards in the types are acceptable.
2287 * @param array $cprefs Client's acceptable type list
2288 * @param array $sprefs Server's offered types
2291 * @todo FIXME: Doesn't handle params like 'text/plain; charset=UTF-8'
2292 * XXX: generalize to negotiate other stuff
2294 function wfNegotiateType( $cprefs, $sprefs ) {
2297 foreach ( array_keys( $sprefs ) as $type ) {
2298 $parts = explode( '/', $type );
2299 if ( $parts[1] != '*' ) {
2300 $ckey = mimeTypeMatch( $type, $cprefs );
2302 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
2307 foreach ( array_keys( $cprefs ) as $type ) {
2308 $parts = explode( '/', $type );
2309 if ( $parts[1] != '*' && !array_key_exists( $type, $sprefs ) ) {
2310 $skey = mimeTypeMatch( $type, $sprefs );
2312 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
2320 foreach ( array_keys( $combine ) as $type ) {
2321 if ( $combine[$type] > $bestq ) {
2323 $bestq = $combine[$type];
2331 * Reference-counted warning suppression
2333 * @deprecated since 1.26, use MediaWiki\suppressWarnings() directly
2336 function wfSuppressWarnings( $end = false ) {
2337 MediaWiki\
suppressWarnings( $end );
2341 * @deprecated since 1.26, use MediaWiki\restoreWarnings() directly
2342 * Restore error level to previous value
2344 function wfRestoreWarnings() {
2345 MediaWiki\
suppressWarnings( true );
2348 # Autodetect, convert and provide timestamps of various types
2351 * Unix time - the number of seconds since 1970-01-01 00:00:00 UTC
2353 define( 'TS_UNIX', 0 );
2356 * MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
2358 define( 'TS_MW', 1 );
2361 * MySQL DATETIME (YYYY-MM-DD HH:MM:SS)
2363 define( 'TS_DB', 2 );
2366 * RFC 2822 format, for E-mail and HTTP headers
2368 define( 'TS_RFC2822', 3 );
2371 * ISO 8601 format with no timezone: 1986-02-09T20:00:00Z
2373 * This is used by Special:Export
2375 define( 'TS_ISO_8601', 4 );
2378 * An Exif timestamp (YYYY:MM:DD HH:MM:SS)
2380 * @see http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the
2381 * DateTime tag and page 36 for the DateTimeOriginal and
2382 * DateTimeDigitized tags.
2384 define( 'TS_EXIF', 5 );
2387 * Oracle format time.
2389 define( 'TS_ORACLE', 6 );
2392 * Postgres format time.
2394 define( 'TS_POSTGRES', 7 );
2397 * ISO 8601 basic format with no timezone: 19860209T200000Z. This is used by ResourceLoader
2399 define( 'TS_ISO_8601_BASIC', 9 );
2402 * Get a timestamp string in one of various formats
2404 * @param mixed $outputtype A timestamp in one of the supported formats, the
2405 * function will autodetect which format is supplied and act accordingly.
2406 * @param mixed $ts Optional timestamp to convert, default 0 for the current time
2407 * @return string|bool String / false The same date in the format specified in $outputtype or false
2409 function wfTimestamp( $outputtype = TS_UNIX
, $ts = 0 ) {
2411 $timestamp = new MWTimestamp( $ts );
2412 return $timestamp->getTimestamp( $outputtype );
2413 } catch ( TimestampException
$e ) {
2414 wfDebug( "wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n" );
2420 * Return a formatted timestamp, or null if input is null.
2421 * For dealing with nullable timestamp columns in the database.
2423 * @param int $outputtype
2427 function wfTimestampOrNull( $outputtype = TS_UNIX
, $ts = null ) {
2428 if ( is_null( $ts ) ) {
2431 return wfTimestamp( $outputtype, $ts );
2436 * Convenience function; returns MediaWiki timestamp for the present time.
2440 function wfTimestampNow() {
2442 return wfTimestamp( TS_MW
, time() );
2446 * Check if the operating system is Windows
2448 * @return bool True if it's Windows, false otherwise.
2450 function wfIsWindows() {
2451 static $isWindows = null;
2452 if ( $isWindows === null ) {
2453 $isWindows = strtoupper( substr( PHP_OS
, 0, 3 ) ) === 'WIN';
2459 * Check if we are running under HHVM
2463 function wfIsHHVM() {
2464 return defined( 'HHVM_VERSION' );
2468 * Tries to get the system directory for temporary files. First
2469 * $wgTmpDirectory is checked, and then the TMPDIR, TMP, and TEMP
2470 * environment variables are then checked in sequence, and if none are
2471 * set try sys_get_temp_dir().
2473 * NOTE: When possible, use instead the tmpfile() function to create
2474 * temporary files to avoid race conditions on file creation, etc.
2478 function wfTempDir() {
2479 global $wgTmpDirectory;
2481 if ( $wgTmpDirectory !== false ) {
2482 return $wgTmpDirectory;
2485 $tmpDir = array_map( "getenv", array( 'TMPDIR', 'TMP', 'TEMP' ) );
2487 foreach ( $tmpDir as $tmp ) {
2488 if ( $tmp && file_exists( $tmp ) && is_dir( $tmp ) && is_writable( $tmp ) ) {
2492 return sys_get_temp_dir();
2496 * Make directory, and make all parent directories if they don't exist
2498 * @param string $dir Full path to directory to create
2499 * @param int $mode Chmod value to use, default is $wgDirectoryMode
2500 * @param string $caller Optional caller param for debugging.
2501 * @throws MWException
2504 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2505 global $wgDirectoryMode;
2507 if ( FileBackend
::isStoragePath( $dir ) ) { // sanity
2508 throw new MWException( __FUNCTION__
. " given storage path '$dir'." );
2511 if ( !is_null( $caller ) ) {
2512 wfDebug( "$caller: called wfMkdirParents($dir)\n" );
2515 if ( strval( $dir ) === '' ||
is_dir( $dir ) ) {
2519 $dir = str_replace( array( '\\', '/' ), DIRECTORY_SEPARATOR
, $dir );
2521 if ( is_null( $mode ) ) {
2522 $mode = $wgDirectoryMode;
2525 // Turn off the normal warning, we're doing our own below
2526 MediaWiki\
suppressWarnings();
2527 $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2528 MediaWiki\restoreWarnings
();
2531 //directory may have been created on another request since we last checked
2532 if ( is_dir( $dir ) ) {
2536 // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2537 wfLogWarning( sprintf( "failed to mkdir \"%s\" mode 0%o", $dir, $mode ) );
2543 * Remove a directory and all its content.
2544 * Does not hide error.
2545 * @param string $dir
2547 function wfRecursiveRemoveDir( $dir ) {
2548 wfDebug( __FUNCTION__
. "( $dir )\n" );
2549 // taken from http://de3.php.net/manual/en/function.rmdir.php#98622
2550 if ( is_dir( $dir ) ) {
2551 $objects = scandir( $dir );
2552 foreach ( $objects as $object ) {
2553 if ( $object != "." && $object != ".." ) {
2554 if ( filetype( $dir . '/' . $object ) == "dir" ) {
2555 wfRecursiveRemoveDir( $dir . '/' . $object );
2557 unlink( $dir . '/' . $object );
2567 * @param int $nr The number to format
2568 * @param int $acc The number of digits after the decimal point, default 2
2569 * @param bool $round Whether or not to round the value, default true
2572 function wfPercent( $nr, $acc = 2, $round = true ) {
2573 $ret = sprintf( "%.${acc}f", $nr );
2574 return $round ?
round( $ret, $acc ) . '%' : "$ret%";
2578 * Safety wrapper around ini_get() for boolean settings.
2579 * The values returned from ini_get() are pre-normalized for settings
2580 * set via php.ini or php_flag/php_admin_flag... but *not*
2581 * for those set via php_value/php_admin_value.
2583 * It's fairly common for people to use php_value instead of php_flag,
2584 * which can leave you with an 'off' setting giving a false positive
2585 * for code that just takes the ini_get() return value as a boolean.
2587 * To make things extra interesting, setting via php_value accepts
2588 * "true" and "yes" as true, but php.ini and php_flag consider them false. :)
2589 * Unrecognized values go false... again opposite PHP's own coercion
2590 * from string to bool.
2592 * Luckily, 'properly' set settings will always come back as '0' or '1',
2593 * so we only have to worry about them and the 'improper' settings.
2595 * I frickin' hate PHP... :P
2597 * @param string $setting
2600 function wfIniGetBool( $setting ) {
2601 $val = strtolower( ini_get( $setting ) );
2602 // 'on' and 'true' can't have whitespace around them, but '1' can.
2606 ||
preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2610 * Windows-compatible version of escapeshellarg()
2611 * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
2612 * function puts single quotes in regardless of OS.
2614 * Also fixes the locale problems on Linux in PHP 5.2.6+ (bug backported to
2615 * earlier distro releases of PHP)
2617 * @param string ... strings to escape and glue together, or a single array of strings parameter
2620 function wfEscapeShellArg( /*...*/ ) {
2621 wfInitShellLocale();
2623 $args = func_get_args();
2624 if ( count( $args ) === 1 && is_array( reset( $args ) ) ) {
2625 // If only one argument has been passed, and that argument is an array,
2626 // treat it as a list of arguments
2627 $args = reset( $args );
2632 foreach ( $args as $arg ) {
2639 if ( wfIsWindows() ) {
2640 // Escaping for an MSVC-style command line parser and CMD.EXE
2641 // @codingStandardsIgnoreStart For long URLs
2643 // * http://web.archive.org/web/20020708081031/http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
2644 // * http://technet.microsoft.com/en-us/library/cc723564.aspx
2647 // Double the backslashes before any double quotes. Escape the double quotes.
2648 // @codingStandardsIgnoreEnd
2649 $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE
);
2652 foreach ( $tokens as $token ) {
2653 if ( $iteration %
2 == 1 ) {
2654 // Delimiter, a double quote preceded by zero or more slashes
2655 $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
2656 } elseif ( $iteration %
4 == 2 ) {
2657 // ^ in $token will be outside quotes, need to be escaped
2658 $arg .= str_replace( '^', '^^', $token );
2659 } else { // $iteration % 4 == 0
2660 // ^ in $token will appear inside double quotes, so leave as is
2665 // Double the backslashes before the end of the string, because
2666 // we will soon add a quote
2668 if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
2669 $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
2672 // Add surrounding quotes
2673 $retVal .= '"' . $arg . '"';
2675 $retVal .= escapeshellarg( $arg );
2682 * Check if wfShellExec() is effectively disabled via php.ini config
2684 * @return bool|string False or one of (safemode,disabled)
2687 function wfShellExecDisabled() {
2688 static $disabled = null;
2689 if ( is_null( $disabled ) ) {
2690 if ( wfIniGetBool( 'safe_mode' ) ) {
2691 wfDebug( "wfShellExec can't run in safe_mode, PHP's exec functions are too broken.\n" );
2692 $disabled = 'safemode';
2693 } elseif ( !function_exists( 'proc_open' ) ) {
2694 wfDebug( "proc_open() is disabled\n" );
2695 $disabled = 'disabled';
2704 * Execute a shell command, with time and memory limits mirrored from the PHP
2705 * configuration if supported.
2707 * @param string|string[] $cmd If string, a properly shell-escaped command line,
2708 * or an array of unescaped arguments, in which case each value will be escaped
2709 * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
2710 * @param null|mixed &$retval Optional, will receive the program's exit code.
2711 * (non-zero is usually failure). If there is an error from
2712 * read, select, or proc_open(), this will be set to -1.
2713 * @param array $environ Optional environment variables which should be
2714 * added to the executed command environment.
2715 * @param array $limits Optional array with limits(filesize, memory, time, walltime)
2716 * this overwrites the global wgMaxShell* limits.
2717 * @param array $options Array of options:
2718 * - duplicateStderr: Set this to true to duplicate stderr to stdout,
2719 * including errors from limit.sh
2720 * - profileMethod: By default this function will profile based on the calling
2721 * method. Set this to a string for an alternative method to profile from
2723 * @return string Collected stdout as a string
2725 function wfShellExec( $cmd, &$retval = null, $environ = array(),
2726 $limits = array(), $options = array()
2728 global $IP, $wgMaxShellMemory, $wgMaxShellFileSize, $wgMaxShellTime,
2729 $wgMaxShellWallClockTime, $wgShellCgroup;
2731 $disabled = wfShellExecDisabled();
2734 return $disabled == 'safemode' ?
2735 'Unable to run external programs in safe mode.' :
2736 'Unable to run external programs, proc_open() is disabled.';
2739 $includeStderr = isset( $options['duplicateStderr'] ) && $options['duplicateStderr'];
2740 $profileMethod = isset( $options['profileMethod'] ) ?
$options['profileMethod'] : wfGetCaller();
2742 wfInitShellLocale();
2745 foreach ( $environ as $k => $v ) {
2746 if ( wfIsWindows() ) {
2747 /* Surrounding a set in quotes (method used by wfEscapeShellArg) makes the quotes themselves
2748 * appear in the environment variable, so we must use carat escaping as documented in
2749 * http://technet.microsoft.com/en-us/library/cc723564.aspx
2750 * Note however that the quote isn't listed there, but is needed, and the parentheses
2751 * are listed there but doesn't appear to need it.
2753 $envcmd .= "set $k=" . preg_replace( '/([&|()<>^"])/', '^\\1', $v ) . '&& ';
2755 /* Assume this is a POSIX shell, thus required to accept variable assignments before the command
2756 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_09_01
2758 $envcmd .= "$k=" . escapeshellarg( $v ) . ' ';
2761 if ( is_array( $cmd ) ) {
2762 $cmd = wfEscapeShellArg( $cmd );
2765 $cmd = $envcmd . $cmd;
2767 $useLogPipe = false;
2768 if ( is_executable( '/bin/bash' ) ) {
2769 $time = intval( isset( $limits['time'] ) ?
$limits['time'] : $wgMaxShellTime );
2770 if ( isset( $limits['walltime'] ) ) {
2771 $wallTime = intval( $limits['walltime'] );
2772 } elseif ( isset( $limits['time'] ) ) {
2775 $wallTime = intval( $wgMaxShellWallClockTime );
2777 $mem = intval( isset( $limits['memory'] ) ?
$limits['memory'] : $wgMaxShellMemory );
2778 $filesize = intval( isset( $limits['filesize'] ) ?
$limits['filesize'] : $wgMaxShellFileSize );
2780 if ( $time > 0 ||
$mem > 0 ||
$filesize > 0 ||
$wallTime > 0 ) {
2781 $cmd = '/bin/bash ' . escapeshellarg( "$IP/includes/limit.sh" ) . ' ' .
2782 escapeshellarg( $cmd ) . ' ' .
2784 "MW_INCLUDE_STDERR=" . ( $includeStderr ?
'1' : '' ) . ';' .
2785 "MW_CPU_LIMIT=$time; " .
2786 'MW_CGROUP=' . escapeshellarg( $wgShellCgroup ) . '; ' .
2787 "MW_MEM_LIMIT=$mem; " .
2788 "MW_FILE_SIZE_LIMIT=$filesize; " .
2789 "MW_WALL_CLOCK_LIMIT=$wallTime; " .
2790 "MW_USE_LOG_PIPE=yes"
2793 } elseif ( $includeStderr ) {
2796 } elseif ( $includeStderr ) {
2799 wfDebug( "wfShellExec: $cmd\n" );
2802 0 => array( 'file', 'php://stdin', 'r' ),
2803 1 => array( 'pipe', 'w' ),
2804 2 => array( 'file', 'php://stderr', 'w' ) );
2805 if ( $useLogPipe ) {
2806 $desc[3] = array( 'pipe', 'w' );
2809 $scoped = Profiler
::instance()->scopedProfileIn( __FUNCTION__
. '-' . $profileMethod );
2810 $proc = proc_open( $cmd, $desc, $pipes );
2812 wfDebugLog( 'exec', "proc_open() failed: $cmd" );
2816 $outBuffer = $logBuffer = '';
2817 $emptyArray = array();
2821 // According to the documentation, it is possible for stream_select()
2822 // to fail due to EINTR. I haven't managed to induce this in testing
2823 // despite sending various signals. If it did happen, the error
2824 // message would take the form:
2826 // stream_select(): unable to select [4]: Interrupted system call (max_fd=5)
2828 // where [4] is the value of the macro EINTR and "Interrupted system
2829 // call" is string which according to the Linux manual is "possibly"
2830 // localised according to LC_MESSAGES.
2831 $eintr = defined( 'SOCKET_EINTR' ) ? SOCKET_EINTR
: 4;
2832 $eintrMessage = "stream_select(): unable to select [$eintr]";
2834 // Build a table mapping resource IDs to pipe FDs to work around a
2835 // PHP 5.3 issue in which stream_select() does not preserve array keys
2836 // <https://bugs.php.net/bug.php?id=53427>.
2838 foreach ( $pipes as $fd => $pipe ) {
2839 $fds[(int)$pipe] = $fd;
2846 while ( $running === true ||
$numReadyPipes !== 0 ) {
2848 $status = proc_get_status( $proc );
2849 // If the process has terminated, switch to nonblocking selects
2850 // for getting any data still waiting to be read.
2851 if ( !$status['running'] ) {
2857 $readyPipes = $pipes;
2860 // @codingStandardsIgnoreStart Generic.PHP.NoSilencedErrors.Discouraged
2861 @trigger_error
( '' );
2862 $numReadyPipes = @stream_select
( $readyPipes, $emptyArray, $emptyArray, $timeout );
2863 if ( $numReadyPipes === false ) {
2864 // @codingStandardsIgnoreEnd
2865 $error = error_get_last();
2866 if ( strncmp( $error['message'], $eintrMessage, strlen( $eintrMessage ) ) == 0 ) {
2869 trigger_error( $error['message'], E_USER_WARNING
);
2870 $logMsg = $error['message'];
2874 foreach ( $readyPipes as $pipe ) {
2875 $block = fread( $pipe, 65536 );
2876 $fd = $fds[(int)$pipe];
2877 if ( $block === '' ) {
2879 fclose( $pipes[$fd] );
2880 unset( $pipes[$fd] );
2884 } elseif ( $block === false ) {
2886 $logMsg = "Error reading from pipe";
2888 } elseif ( $fd == 1 ) {
2890 $outBuffer .= $block;
2891 } elseif ( $fd == 3 ) {
2893 $logBuffer .= $block;
2894 if ( strpos( $block, "\n" ) !== false ) {
2895 $lines = explode( "\n", $logBuffer );
2896 $logBuffer = array_pop( $lines );
2897 foreach ( $lines as $line ) {
2898 wfDebugLog( 'exec', $line );
2905 foreach ( $pipes as $pipe ) {
2909 // Use the status previously collected if possible, since proc_get_status()
2910 // just calls waitpid() which will not return anything useful the second time.
2912 $status = proc_get_status( $proc );
2915 if ( $logMsg !== false ) {
2916 // Read/select error
2918 proc_close( $proc );
2919 } elseif ( $status['signaled'] ) {
2920 $logMsg = "Exited with signal {$status['termsig']}";
2921 $retval = 128 +
$status['termsig'];
2922 proc_close( $proc );
2924 if ( $status['running'] ) {
2925 $retval = proc_close( $proc );
2927 $retval = $status['exitcode'];
2928 proc_close( $proc );
2930 if ( $retval == 127 ) {
2931 $logMsg = "Possibly missing executable file";
2932 } elseif ( $retval >= 129 && $retval <= 192 ) {
2933 $logMsg = "Probably exited with signal " . ( $retval - 128 );
2937 if ( $logMsg !== false ) {
2938 wfDebugLog( 'exec', "$logMsg: $cmd" );
2945 * Execute a shell command, returning both stdout and stderr. Convenience
2946 * function, as all the arguments to wfShellExec can become unwieldy.
2948 * @note This also includes errors from limit.sh, e.g. if $wgMaxShellFileSize is exceeded.
2949 * @param string|string[] $cmd If string, a properly shell-escaped command line,
2950 * or an array of unescaped arguments, in which case each value will be escaped
2951 * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
2952 * @param null|mixed &$retval Optional, will receive the program's exit code.
2953 * (non-zero is usually failure)
2954 * @param array $environ Optional environment variables which should be
2955 * added to the executed command environment.
2956 * @param array $limits Optional array with limits(filesize, memory, time, walltime)
2957 * this overwrites the global wgMaxShell* limits.
2958 * @return string Collected stdout and stderr as a string
2960 function wfShellExecWithStderr( $cmd, &$retval = null, $environ = array(), $limits = array() ) {
2961 return wfShellExec( $cmd, $retval, $environ, $limits,
2962 array( 'duplicateStderr' => true, 'profileMethod' => wfGetCaller() ) );
2966 * Workaround for http://bugs.php.net/bug.php?id=45132
2967 * escapeshellarg() destroys non-ASCII characters if LANG is not a UTF-8 locale
2969 function wfInitShellLocale() {
2970 static $done = false;
2975 global $wgShellLocale;
2976 if ( !wfIniGetBool( 'safe_mode' ) ) {
2977 putenv( "LC_CTYPE=$wgShellLocale" );
2978 setlocale( LC_CTYPE
, $wgShellLocale );
2983 * Generate a shell-escaped command line string to run a MediaWiki cli script.
2984 * Note that $parameters should be a flat array and an option with an argument
2985 * should consist of two consecutive items in the array (do not use "--option value").
2987 * @param string $script MediaWiki cli script path
2988 * @param array $parameters Arguments and options to the script
2989 * @param array $options Associative array of options:
2990 * 'php': The path to the php executable
2991 * 'wrapper': Path to a PHP wrapper to handle the maintenance script
2994 function wfShellWikiCmd( $script, array $parameters = array(), array $options = array() ) {
2996 // Give site config file a chance to run the script in a wrapper.
2997 // The caller may likely want to call wfBasename() on $script.
2998 Hooks
::run( 'wfShellWikiCmd', array( &$script, &$parameters, &$options ) );
2999 $cmd = isset( $options['php'] ) ?
array( $options['php'] ) : array( $wgPhpCli );
3000 if ( isset( $options['wrapper'] ) ) {
3001 $cmd[] = $options['wrapper'];
3004 // Escape each parameter for shell
3005 return wfEscapeShellArg( array_merge( $cmd, $parameters ) );
3009 * wfMerge attempts to merge differences between three texts.
3010 * Returns true for a clean merge and false for failure or a conflict.
3012 * @param string $old
3013 * @param string $mine
3014 * @param string $yours
3015 * @param string $result
3018 function wfMerge( $old, $mine, $yours, &$result ) {
3021 # This check may also protect against code injection in
3022 # case of broken installations.
3023 MediaWiki\
suppressWarnings();
3024 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
3025 MediaWiki\restoreWarnings
();
3027 if ( !$haveDiff3 ) {
3028 wfDebug( "diff3 not found\n" );
3032 # Make temporary files
3034 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
3035 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
3036 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
3038 # NOTE: diff3 issues a warning to stderr if any of the files does not end with
3039 # a newline character. To avoid this, we normalize the trailing whitespace before
3040 # creating the diff.
3042 fwrite( $oldtextFile, rtrim( $old ) . "\n" );
3043 fclose( $oldtextFile );
3044 fwrite( $mytextFile, rtrim( $mine ) . "\n" );
3045 fclose( $mytextFile );
3046 fwrite( $yourtextFile, rtrim( $yours ) . "\n" );
3047 fclose( $yourtextFile );
3049 # Check for a conflict
3050 $cmd = wfEscapeShellArg( $wgDiff3, '-a', '--overlap-only', $mytextName,
3051 $oldtextName, $yourtextName );
3052 $handle = popen( $cmd, 'r' );
3054 if ( fgets( $handle, 1024 ) ) {
3062 $cmd = wfEscapeShellArg( $wgDiff3, '-a', '-e', '--merge', $mytextName,
3063 $oldtextName, $yourtextName );
3064 $handle = popen( $cmd, 'r' );
3067 $data = fread( $handle, 8192 );
3068 if ( strlen( $data ) == 0 ) {
3074 unlink( $mytextName );
3075 unlink( $oldtextName );
3076 unlink( $yourtextName );
3078 if ( $result === '' && $old !== '' && !$conflict ) {
3079 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
3086 * Returns unified plain-text diff of two texts.
3087 * "Useful" for machine processing of diffs.
3089 * @deprecated since 1.25, use DiffEngine/UnifiedDiffFormatter directly
3091 * @param string $before The text before the changes.
3092 * @param string $after The text after the changes.
3093 * @param string $params Command-line options for the diff command.
3094 * @return string Unified diff of $before and $after
3096 function wfDiff( $before, $after, $params = '-u' ) {
3097 if ( $before == $after ) {
3102 MediaWiki\
suppressWarnings();
3103 $haveDiff = $wgDiff && file_exists( $wgDiff );
3104 MediaWiki\restoreWarnings
();
3106 # This check may also protect against code injection in
3107 # case of broken installations.
3109 wfDebug( "diff executable not found\n" );
3110 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
3111 $format = new UnifiedDiffFormatter();
3112 return $format->format( $diffs );
3115 # Make temporary files
3117 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
3118 $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
3120 fwrite( $oldtextFile, $before );
3121 fclose( $oldtextFile );
3122 fwrite( $newtextFile, $after );
3123 fclose( $newtextFile );
3125 // Get the diff of the two files
3126 $cmd = "$wgDiff " . $params . ' ' . wfEscapeShellArg( $oldtextName, $newtextName );
3128 $h = popen( $cmd, 'r' );
3130 unlink( $oldtextName );
3131 unlink( $newtextName );
3132 throw new Exception( __METHOD__
. '(): popen() failed' );
3138 $data = fread( $h, 8192 );
3139 if ( strlen( $data ) == 0 ) {
3147 unlink( $oldtextName );
3148 unlink( $newtextName );
3150 // Kill the --- and +++ lines. They're not useful.
3151 $diff_lines = explode( "\n", $diff );
3152 if ( isset( $diff_lines[0] ) && strpos( $diff_lines[0], '---' ) === 0 ) {
3153 unset( $diff_lines[0] );
3155 if ( isset( $diff_lines[1] ) && strpos( $diff_lines[1], '+++' ) === 0 ) {
3156 unset( $diff_lines[1] );
3159 $diff = implode( "\n", $diff_lines );
3165 * This function works like "use VERSION" in Perl, the program will die with a
3166 * backtrace if the current version of PHP is less than the version provided
3168 * This is useful for extensions which due to their nature are not kept in sync
3169 * with releases, and might depend on other versions of PHP than the main code
3171 * Note: PHP might die due to parsing errors in some cases before it ever
3172 * manages to call this function, such is life
3174 * @see perldoc -f use
3176 * @param string|int|float $req_ver The version to check, can be a string, an integer, or a float
3177 * @throws MWException
3179 function wfUsePHP( $req_ver ) {
3180 $php_ver = PHP_VERSION
;
3182 if ( version_compare( $php_ver, (string)$req_ver, '<' ) ) {
3183 throw new MWException( "PHP $req_ver required--this is only $php_ver" );
3188 * This function works like "use VERSION" in Perl except it checks the version
3189 * of MediaWiki, the program will die with a backtrace if the current version
3190 * of MediaWiki is less than the version provided.
3192 * This is useful for extensions which due to their nature are not kept in sync
3195 * Note: Due to the behavior of PHP's version_compare() which is used in this
3196 * function, if you want to allow the 'wmf' development versions add a 'c' (or
3197 * any single letter other than 'a', 'b' or 'p') as a post-fix to your
3198 * targeted version number. For example if you wanted to allow any variation
3199 * of 1.22 use `wfUseMW( '1.22c' )`. Using an 'a' or 'b' instead of 'c' will
3200 * not result in the same comparison due to the internal logic of
3201 * version_compare().
3203 * @see perldoc -f use
3205 * @param string|int|float $req_ver The version to check, can be a string, an integer, or a float
3206 * @throws MWException
3208 function wfUseMW( $req_ver ) {
3211 if ( version_compare( $wgVersion, (string)$req_ver, '<' ) ) {
3212 throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
3217 * Return the final portion of a pathname.
3218 * Reimplemented because PHP5's "basename()" is buggy with multibyte text.
3219 * http://bugs.php.net/bug.php?id=33898
3221 * PHP's basename() only considers '\' a pathchar on Windows and Netware.
3222 * We'll consider it so always, as we don't want '\s' in our Unix paths either.
3224 * @param string $path
3225 * @param string $suffix String to remove if present
3228 function wfBaseName( $path, $suffix = '' ) {
3229 if ( $suffix == '' ) {
3232 $encSuffix = '(?:' . preg_quote( $suffix, '#' ) . ')?';
3236 if ( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
3244 * Generate a relative path name to the given file.
3245 * May explode on non-matching case-insensitive paths,
3246 * funky symlinks, etc.
3248 * @param string $path Absolute destination path including target filename
3249 * @param string $from Absolute source path, directory only
3252 function wfRelativePath( $path, $from ) {
3253 // Normalize mixed input on Windows...
3254 $path = str_replace( '/', DIRECTORY_SEPARATOR
, $path );
3255 $from = str_replace( '/', DIRECTORY_SEPARATOR
, $from );
3257 // Trim trailing slashes -- fix for drive root
3258 $path = rtrim( $path, DIRECTORY_SEPARATOR
);
3259 $from = rtrim( $from, DIRECTORY_SEPARATOR
);
3261 $pieces = explode( DIRECTORY_SEPARATOR
, dirname( $path ) );
3262 $against = explode( DIRECTORY_SEPARATOR
, $from );
3264 if ( $pieces[0] !== $against[0] ) {
3265 // Non-matching Windows drive letters?
3266 // Return a full path.
3270 // Trim off common prefix
3271 while ( count( $pieces ) && count( $against )
3272 && $pieces[0] == $against[0] ) {
3273 array_shift( $pieces );
3274 array_shift( $against );
3277 // relative dots to bump us to the parent
3278 while ( count( $against ) ) {
3279 array_unshift( $pieces, '..' );
3280 array_shift( $against );
3283 array_push( $pieces, wfBaseName( $path ) );
3285 return implode( DIRECTORY_SEPARATOR
, $pieces );
3289 * Convert an arbitrarily-long digit string from one numeric base
3290 * to another, optionally zero-padding to a minimum column width.
3292 * Supports base 2 through 36; digit values 10-36 are represented
3293 * as lowercase letters a-z. Input is case-insensitive.
3295 * @param string $input Input number
3296 * @param int $sourceBase Base of the input number
3297 * @param int $destBase Desired base of the output
3298 * @param int $pad Minimum number of digits in the output (pad with zeroes)
3299 * @param bool $lowercase Whether to output in lowercase or uppercase
3300 * @param string $engine Either "gmp", "bcmath", or "php"
3301 * @return string|bool The output number as a string, or false on error
3303 function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1,
3304 $lowercase = true, $engine = 'auto'
3306 $input = (string)$input;
3312 $sourceBase != (int)$sourceBase ||
3313 $destBase != (int)$destBase ||
3314 $pad != (int)$pad ||
3316 "/^[" . substr( '0123456789abcdefghijklmnopqrstuvwxyz', 0, $sourceBase ) . "]+$/i",
3323 static $baseChars = array(
3324 10 => 'a', 11 => 'b', 12 => 'c', 13 => 'd', 14 => 'e', 15 => 'f',
3325 16 => 'g', 17 => 'h', 18 => 'i', 19 => 'j', 20 => 'k', 21 => 'l',
3326 22 => 'm', 23 => 'n', 24 => 'o', 25 => 'p', 26 => 'q', 27 => 'r',
3327 28 => 's', 29 => 't', 30 => 'u', 31 => 'v', 32 => 'w', 33 => 'x',
3328 34 => 'y', 35 => 'z',
3330 '0' => 0, '1' => 1, '2' => 2, '3' => 3, '4' => 4, '5' => 5,
3331 '6' => 6, '7' => 7, '8' => 8, '9' => 9, 'a' => 10, 'b' => 11,
3332 'c' => 12, 'd' => 13, 'e' => 14, 'f' => 15, 'g' => 16, 'h' => 17,
3333 'i' => 18, 'j' => 19, 'k' => 20, 'l' => 21, 'm' => 22, 'n' => 23,
3334 'o' => 24, 'p' => 25, 'q' => 26, 'r' => 27, 's' => 28, 't' => 29,
3335 'u' => 30, 'v' => 31, 'w' => 32, 'x' => 33, 'y' => 34, 'z' => 35
3338 if ( extension_loaded( 'gmp' ) && ( $engine == 'auto' ||
$engine == 'gmp' ) ) {
3339 // Removing leading zeros works around broken base detection code in
3340 // some PHP versions (see <https://bugs.php.net/bug.php?id=50175> and
3341 // <https://bugs.php.net/bug.php?id=55398>).
3342 $result = gmp_strval( gmp_init( ltrim( $input, '0' ) ?
: '0', $sourceBase ), $destBase );
3343 } elseif ( extension_loaded( 'bcmath' ) && ( $engine == 'auto' ||
$engine == 'bcmath' ) ) {
3345 foreach ( str_split( strtolower( $input ) ) as $char ) {
3346 $decimal = bcmul( $decimal, $sourceBase );
3347 $decimal = bcadd( $decimal, $baseChars[$char] );
3350 // @codingStandardsIgnoreStart Generic.CodeAnalysis.ForLoopWithTestFunctionCall.NotAllowed
3351 for ( $result = ''; bccomp( $decimal, 0 ); $decimal = bcdiv( $decimal, $destBase, 0 ) ) {
3352 $result .= $baseChars[bcmod( $decimal, $destBase )];
3354 // @codingStandardsIgnoreEnd
3356 $result = strrev( $result );
3358 $inDigits = array();
3359 foreach ( str_split( strtolower( $input ) ) as $char ) {
3360 $inDigits[] = $baseChars[$char];
3363 // Iterate over the input, modulo-ing out an output digit
3364 // at a time until input is gone.
3366 while ( $inDigits ) {
3368 $workDigits = array();
3371 foreach ( $inDigits as $digit ) {
3372 $work *= $sourceBase;
3375 if ( $workDigits ||
$work >= $destBase ) {
3376 $workDigits[] = (int)( $work / $destBase );
3381 // All that division leaves us with a remainder,
3382 // which is conveniently our next output digit.
3383 $result .= $baseChars[$work];
3386 $inDigits = $workDigits;
3389 $result = strrev( $result );
3392 if ( !$lowercase ) {
3393 $result = strtoupper( $result );
3396 return str_pad( $result, $pad, '0', STR_PAD_LEFT
);
3400 * Check if there is sufficient entropy in php's built-in session generation
3402 * @return bool True = there is sufficient entropy
3404 function wfCheckEntropy() {
3406 ( wfIsWindows() && version_compare( PHP_VERSION
, '5.3.3', '>=' ) )
3407 ||
ini_get( 'session.entropy_file' )
3409 && intval( ini_get( 'session.entropy_length' ) ) >= 32;
3413 * Override session_id before session startup if php's built-in
3414 * session generation code is not secure.
3416 function wfFixSessionID() {
3417 // If the cookie or session id is already set we already have a session and should abort
3418 if ( isset( $_COOKIE[session_name()] ) ||
session_id() ) {
3422 // PHP's built-in session entropy is enabled if:
3423 // - entropy_file is set or you're on Windows with php 5.3.3+
3424 // - AND entropy_length is > 0
3425 // We treat it as disabled if it doesn't have an entropy length of at least 32
3426 $entropyEnabled = wfCheckEntropy();
3428 // If built-in entropy is not enabled or not sufficient override PHP's
3429 // built in session id generation code
3430 if ( !$entropyEnabled ) {
3431 wfDebug( __METHOD__
. ": PHP's built in entropy is disabled or not sufficient, " .
3432 "overriding session id generation using our cryptrand source.\n" );
3433 session_id( MWCryptRand
::generateHex( 32 ) );
3438 * Reset the session_id
3442 function wfResetSessionID() {
3443 global $wgCookieSecure;
3444 $oldSessionId = session_id();
3445 $cookieParams = session_get_cookie_params();
3446 if ( wfCheckEntropy() && $wgCookieSecure == $cookieParams['secure'] ) {
3447 session_regenerate_id( false );
3451 wfSetupSession( MWCryptRand
::generateHex( 32 ) );
3454 $newSessionId = session_id();
3455 Hooks
::run( 'ResetSessionID', array( $oldSessionId, $newSessionId ) );
3459 * Initialise php session
3461 * @param bool $sessionId
3463 function wfSetupSession( $sessionId = false ) {
3464 global $wgSessionsInObjectCache, $wgSessionHandler;
3465 global $wgCookiePath, $wgCookieDomain, $wgCookieSecure, $wgCookieHttpOnly;
3467 if ( $wgSessionsInObjectCache ) {
3468 ObjectCacheSessionHandler
::install();
3469 } elseif ( $wgSessionHandler && $wgSessionHandler != ini_get( 'session.save_handler' ) ) {
3470 # Only set this if $wgSessionHandler isn't null and session.save_handler
3471 # hasn't already been set to the desired value (that causes errors)
3472 ini_set( 'session.save_handler', $wgSessionHandler );
3475 session_set_cookie_params(
3476 0, $wgCookiePath, $wgCookieDomain, $wgCookieSecure, $wgCookieHttpOnly );
3477 session_cache_limiter( 'private, must-revalidate' );
3479 session_id( $sessionId );
3484 MediaWiki\
suppressWarnings();
3486 MediaWiki\restoreWarnings
();
3488 if ( $wgSessionsInObjectCache ) {
3489 ObjectCacheSessionHandler
::renewCurrentSession();
3494 * Get an object from the precompiled serialized directory
3496 * @param string $name
3497 * @return mixed The variable on success, false on failure
3499 function wfGetPrecompiledData( $name ) {
3502 $file = "$IP/serialized/$name";
3503 if ( file_exists( $file ) ) {
3504 $blob = file_get_contents( $file );
3506 return unserialize( $blob );
3513 * Make a cache key for the local wiki.
3515 * @param string $args,...
3518 function wfMemcKey( /*...*/ ) {
3519 global $wgCachePrefix;
3520 $prefix = $wgCachePrefix === false ?
wfWikiID() : $wgCachePrefix;
3521 $args = func_get_args();
3522 $key = $prefix . ':' . implode( ':', $args );
3523 return strtr( $key, ' ', '_' );
3527 * Make a cache key for a foreign DB.
3529 * Must match what wfMemcKey() would produce in context of the foreign wiki.
3532 * @param string $prefix
3533 * @param string $args,...
3536 function wfForeignMemcKey( $db, $prefix /*...*/ ) {
3537 $args = array_slice( func_get_args(), 2 );
3539 // Match wfWikiID() logic
3540 $key = "$db-$prefix:" . implode( ':', $args );
3542 $key = $db . ':' . implode( ':', $args );
3544 return strtr( $key, ' ', '_' );
3548 * Make a cache key with database-agnostic prefix.
3550 * Doesn't have a wiki-specific namespace. Uses a generic 'global' prefix
3551 * instead. Must have a prefix as otherwise keys that use a database name
3552 * in the first segment will clash with wfMemcKey/wfForeignMemcKey.
3555 * @param string $args,...
3558 function wfGlobalCacheKey( /*...*/ ) {
3559 $args = func_get_args();
3560 $key = 'global:' . implode( ':', $args );
3561 return strtr( $key, ' ', '_' );
3565 * Get an ASCII string identifying this wiki
3566 * This is used as a prefix in memcached keys
3570 function wfWikiID() {
3571 global $wgDBprefix, $wgDBname;
3572 if ( $wgDBprefix ) {
3573 return "$wgDBname-$wgDBprefix";
3580 * Split a wiki ID into DB name and table prefix
3582 * @param string $wiki
3586 function wfSplitWikiID( $wiki ) {
3587 $bits = explode( '-', $wiki, 2 );
3588 if ( count( $bits ) < 2 ) {
3595 * Get a Database object.
3597 * @param int $db Index of the connection to get. May be DB_MASTER for the
3598 * master (for write queries), DB_SLAVE for potentially lagged read
3599 * queries, or an integer >= 0 for a particular server.
3601 * @param string|string[] $groups Query groups. An array of group names that this query
3602 * belongs to. May contain a single string if the query is only
3605 * @param string|bool $wiki The wiki ID, or false for the current wiki
3607 * Note: multiple calls to wfGetDB(DB_SLAVE) during the course of one request
3608 * will always return the same object, unless the underlying connection or load
3609 * balancer is manually destroyed.
3611 * Note 2: use $this->getDB() in maintenance scripts that may be invoked by
3612 * updater to ensure that a proper database is being updated.
3614 * @return DatabaseBase
3616 function wfGetDB( $db, $groups = array(), $wiki = false ) {
3617 return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
3621 * Get a load balancer object.
3623 * @param string|bool $wiki Wiki ID, or false for the current wiki
3624 * @return LoadBalancer
3626 function wfGetLB( $wiki = false ) {
3627 return wfGetLBFactory()->getMainLB( $wiki );
3631 * Get the load balancer factory object
3635 function wfGetLBFactory() {
3636 return LBFactory
::singleton();
3641 * Shortcut for RepoGroup::singleton()->findFile()
3643 * @param string $title String or Title object
3644 * @param array $options Associative array of options (see RepoGroup::findFile)
3645 * @return File|bool File, or false if the file does not exist
3647 function wfFindFile( $title, $options = array() ) {
3648 return RepoGroup
::singleton()->findFile( $title, $options );
3652 * Get an object referring to a locally registered file.
3653 * Returns a valid placeholder object if the file does not exist.
3655 * @param Title|string $title
3656 * @return LocalFile|null A File, or null if passed an invalid Title
3658 function wfLocalFile( $title ) {
3659 return RepoGroup
::singleton()->getLocalRepo()->newFile( $title );
3663 * Should low-performance queries be disabled?
3666 * @codeCoverageIgnore
3668 function wfQueriesMustScale() {
3669 global $wgMiserMode;
3671 ||
( SiteStats
::pages() > 100000
3672 && SiteStats
::edits() > 1000000
3673 && SiteStats
::users() > 10000 );
3677 * Get the path to a specified script file, respecting file
3678 * extensions; this is a wrapper around $wgScriptExtension etc.
3679 * except for 'index' and 'load' which use $wgScript/$wgLoadScript
3681 * @param string $script Script filename, sans extension
3684 function wfScript( $script = 'index' ) {
3685 global $wgScriptPath, $wgScriptExtension, $wgScript, $wgLoadScript;
3686 if ( $script === 'index' ) {
3688 } elseif ( $script === 'load' ) {
3689 return $wgLoadScript;
3691 return "{$wgScriptPath}/{$script}{$wgScriptExtension}";
3696 * Get the script URL.
3698 * @return string Script URL
3700 function wfGetScriptUrl() {
3701 if ( isset( $_SERVER['SCRIPT_NAME'] ) ) {
3703 # as it was called, minus the query string.
3705 # Some sites use Apache rewrite rules to handle subdomains,
3706 # and have PHP set up in a weird way that causes PHP_SELF
3707 # to contain the rewritten URL instead of the one that the
3708 # outside world sees.
3710 # If in this mode, use SCRIPT_URL instead, which mod_rewrite
3711 # provides containing the "before" URL.
3712 return $_SERVER['SCRIPT_NAME'];
3714 return $_SERVER['URL'];
3719 * Convenience function converts boolean values into "true"
3720 * or "false" (string) values
3722 * @param bool $value
3725 function wfBoolToStr( $value ) {
3726 return $value ?
'true' : 'false';
3730 * Get a platform-independent path to the null file, e.g. /dev/null
3734 function wfGetNull() {
3735 return wfIsWindows() ?
'NUL' : '/dev/null';
3739 * Waits for the slaves to catch up to the master position
3741 * Use this when updating very large numbers of rows, as in maintenance scripts,
3742 * to avoid causing too much lag. Of course, this is a no-op if there are no slaves.
3744 * By default this waits on the main DB cluster of the current wiki.
3745 * If $cluster is set to "*" it will wait on all DB clusters, including
3746 * external ones. If the lag being waiting on is caused by the code that
3747 * does this check, it makes since to use $ifWritesSince, particularly if
3748 * cluster is "*", to avoid excess overhead.
3750 * Never call this function after a big DB write that is still in a transaction.
3751 * This only makes sense after the possible lag inducing changes were committed.
3753 * @param float|null $ifWritesSince Only wait if writes were done since this UNIX timestamp
3754 * @param string|bool $wiki Wiki identifier accepted by wfGetLB
3755 * @param string|bool $cluster Cluster name accepted by LBFactory. Default: false.
3756 * @param int|null $timeout Max wait time. Default: 1 day (cli), ~10 seconds (web)
3757 * @return bool Success (able to connect and no timeouts reached)
3759 function wfWaitForSlaves(
3760 $ifWritesSince = null, $wiki = false, $cluster = false, $timeout = null
3762 // B/C: first argument used to be "max seconds of lag"; ignore such values
3763 $ifWritesSince = ( $ifWritesSince > 1e9
) ?
$ifWritesSince : null;
3765 if ( $timeout === null ) {
3766 $timeout = ( PHP_SAPI
=== 'cli' ) ?
86400 : 10;
3769 // Figure out which clusters need to be checked
3770 /** @var LoadBalancer[] $lbs */
3772 if ( $cluster === '*' ) {
3773 wfGetLBFactory()->forEachLB( function ( LoadBalancer
$lb ) use ( &$lbs ) {
3776 } elseif ( $cluster !== false ) {
3777 $lbs[] = wfGetLBFactory()->getExternalLB( $cluster );
3779 $lbs[] = wfGetLB( $wiki );
3782 // Get all the master positions of applicable DBs right now.
3783 // This can be faster since waiting on one cluster reduces the
3784 // time needed to wait on the next clusters.
3785 $masterPositions = array_fill( 0, count( $lbs ), false );
3786 foreach ( $lbs as $i => $lb ) {
3787 if ( $lb->getServerCount() <= 1 ) {
3788 // Bug 27975 - Don't try to wait for slaves if there are none
3789 // Prevents permission error when getting master position
3791 } elseif ( $ifWritesSince && $lb->lastMasterChangeTimestamp() < $ifWritesSince ) {
3792 continue; // no writes since the last wait
3794 $masterPositions[$i] = $lb->getMasterPos();
3798 foreach ( $lbs as $i => $lb ) {
3799 if ( $masterPositions[$i] ) {
3800 // The DBMS may not support getMasterPos() or the whole
3801 // load balancer might be fake (e.g. $wgAllDBsAreLocalhost).
3802 $ok = $lb->waitForAll( $masterPositions[$i], $timeout ) && $ok;
3810 * Count down from $seconds to zero on the terminal, with a one-second pause
3811 * between showing each number. For use in command-line scripts.
3813 * @codeCoverageIgnore
3814 * @param int $seconds
3816 function wfCountDown( $seconds ) {
3817 for ( $i = $seconds; $i >= 0; $i-- ) {
3818 if ( $i != $seconds ) {
3819 echo str_repeat( "\x08", strlen( $i +
1 ) );
3831 * Replace all invalid characters with -
3832 * Additional characters can be defined in $wgIllegalFileChars (see bug 20489)
3833 * By default, $wgIllegalFileChars = ':'
3835 * @param string $name Filename to process
3838 function wfStripIllegalFilenameChars( $name ) {
3839 global $wgIllegalFileChars;
3840 $illegalFileChars = $wgIllegalFileChars ?
"|[" . $wgIllegalFileChars . "]" : '';
3841 $name = wfBaseName( $name );
3842 $name = preg_replace(
3843 "/[^" . Title
::legalChars() . "]" . $illegalFileChars . "/",
3851 * Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit
3853 * @return int Resulting value of the memory limit.
3855 function wfMemoryLimit() {
3856 global $wgMemoryLimit;
3857 $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
3858 if ( $memlimit != -1 ) {
3859 $conflimit = wfShorthandToInteger( $wgMemoryLimit );
3860 if ( $conflimit == -1 ) {
3861 wfDebug( "Removing PHP's memory limit\n" );
3862 MediaWiki\
suppressWarnings();
3863 ini_set( 'memory_limit', $conflimit );
3864 MediaWiki\restoreWarnings
();
3866 } elseif ( $conflimit > $memlimit ) {
3867 wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
3868 MediaWiki\
suppressWarnings();
3869 ini_set( 'memory_limit', $conflimit );
3870 MediaWiki\restoreWarnings
();
3878 * Set PHP's time limit to the larger of php.ini or $wgTransactionalTimeLimit
3880 * @return int Prior time limit
3883 function wfTransactionalTimeLimit() {
3884 global $wgTransactionalTimeLimit;
3886 $timeLimit = ini_get( 'max_execution_time' );
3887 // Note that CLI scripts use 0
3888 if ( $timeLimit > 0 && $wgTransactionalTimeLimit > $timeLimit ) {
3889 set_time_limit( $wgTransactionalTimeLimit );
3892 ignore_user_abort( true ); // ignore client disconnects
3898 * Converts shorthand byte notation to integer form
3900 * @param string $string
3903 function wfShorthandToInteger( $string = '' ) {
3904 $string = trim( $string );
3905 if ( $string === '' ) {
3908 $last = $string[strlen( $string ) - 1];
3909 $val = intval( $string );
3914 // break intentionally missing
3918 // break intentionally missing
3928 * Get the normalised IETF language tag
3929 * See unit test for examples.
3931 * @param string $code The language code.
3932 * @return string The language code which complying with BCP 47 standards.
3934 function wfBCP47( $code ) {
3935 $codeSegment = explode( '-', $code );
3937 foreach ( $codeSegment as $segNo => $seg ) {
3938 // when previous segment is x, it is a private segment and should be lc
3939 if ( $segNo > 0 && strtolower( $codeSegment[( $segNo - 1 )] ) == 'x' ) {
3940 $codeBCP[$segNo] = strtolower( $seg );
3941 // ISO 3166 country code
3942 } elseif ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) {
3943 $codeBCP[$segNo] = strtoupper( $seg );
3944 // ISO 15924 script code
3945 } elseif ( ( strlen( $seg ) == 4 ) && ( $segNo > 0 ) ) {
3946 $codeBCP[$segNo] = ucfirst( strtolower( $seg ) );
3947 // Use lowercase for other cases
3949 $codeBCP[$segNo] = strtolower( $seg );
3952 $langCode = implode( '-', $codeBCP );
3957 * Get a specific cache object.
3959 * @param int|string $cacheType A CACHE_* constants, or other key in $wgObjectCaches
3962 function wfGetCache( $cacheType ) {
3963 return ObjectCache
::getInstance( $cacheType );
3967 * Get the main cache object
3971 function wfGetMainCache() {
3972 global $wgMainCacheType;
3973 return ObjectCache
::getInstance( $wgMainCacheType );
3977 * Get the cache object used by the message cache
3981 function wfGetMessageCacheStorage() {
3982 global $wgMessageCacheType;
3983 return ObjectCache
::getInstance( $wgMessageCacheType );
3987 * Get the cache object used by the parser cache
3991 function wfGetParserCacheStorage() {
3992 global $wgParserCacheType;
3993 return ObjectCache
::getInstance( $wgParserCacheType );
3997 * Call hook functions defined in $wgHooks
3999 * @param string $event Event name
4000 * @param array $args Parameters passed to hook functions
4001 * @param string|null $deprecatedVersion Optionally mark hook as deprecated with version number
4003 * @return bool True if no handler aborted the hook
4004 * @deprecated 1.25 - use Hooks::run
4006 function wfRunHooks( $event, array $args = array(), $deprecatedVersion = null ) {
4007 return Hooks
::run( $event, $args, $deprecatedVersion );
4011 * Wrapper around php's unpack.
4013 * @param string $format The format string (See php's docs)
4014 * @param string $data A binary string of binary data
4015 * @param int|bool $length The minimum length of $data or false. This is to
4016 * prevent reading beyond the end of $data. false to disable the check.
4018 * Also be careful when using this function to read unsigned 32 bit integer
4019 * because php might make it negative.
4021 * @throws MWException If $data not long enough, or if unpack fails
4022 * @return array Associative array of the extracted data
4024 function wfUnpack( $format, $data, $length = false ) {
4025 if ( $length !== false ) {
4026 $realLen = strlen( $data );
4027 if ( $realLen < $length ) {
4028 throw new MWException( "Tried to use wfUnpack on a "
4029 . "string of length $realLen, but needed one "
4030 . "of at least length $length."
4035 MediaWiki\
suppressWarnings();
4036 $result = unpack( $format, $data );
4037 MediaWiki\restoreWarnings
();
4039 if ( $result === false ) {
4040 // If it cannot extract the packed data.
4041 throw new MWException( "unpack could not unpack binary data" );
4047 * Determine if an image exists on the 'bad image list'.
4049 * The format of MediaWiki:Bad_image_list is as follows:
4050 * * Only list items (lines starting with "*") are considered
4051 * * The first link on a line must be a link to a bad image
4052 * * Any subsequent links on the same line are considered to be exceptions,
4053 * i.e. articles where the image may occur inline.
4055 * @param string $name The image name to check
4056 * @param Title|bool $contextTitle The page on which the image occurs, if known
4057 * @param string $blacklist Wikitext of a file blacklist
4060 function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
4061 static $badImageCache = null; // based on bad_image_list msg
4064 $redirectTitle = RepoGroup
::singleton()->checkRedirect( Title
::makeTitle( NS_FILE
, $name ) );
4065 if ( $redirectTitle ) {
4066 $name = $redirectTitle->getDBkey();
4069 # Run the extension hook
4071 if ( !Hooks
::run( 'BadImage', array( $name, &$bad ) ) ) {
4075 $cacheable = ( $blacklist === null );
4076 if ( $cacheable && $badImageCache !== null ) {
4077 $badImages = $badImageCache;
4078 } else { // cache miss
4079 if ( $blacklist === null ) {
4080 $blacklist = wfMessage( 'bad_image_list' )->inContentLanguage()->plain(); // site list
4082 # Build the list now
4083 $badImages = array();
4084 $lines = explode( "\n", $blacklist );
4085 foreach ( $lines as $line ) {
4087 if ( substr( $line, 0, 1 ) !== '*' ) {
4093 if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
4097 $exceptions = array();
4098 $imageDBkey = false;
4099 foreach ( $m[1] as $i => $titleText ) {
4100 $title = Title
::newFromText( $titleText );
4101 if ( !is_null( $title ) ) {
4103 $imageDBkey = $title->getDBkey();
4105 $exceptions[$title->getPrefixedDBkey()] = true;
4110 if ( $imageDBkey !== false ) {
4111 $badImages[$imageDBkey] = $exceptions;
4115 $badImageCache = $badImages;
4119 $contextKey = $contextTitle ?
$contextTitle->getPrefixedDBkey() : false;
4120 $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
4125 * Determine whether the client at a given source IP is likely to be able to
4126 * access the wiki via HTTPS.
4128 * @param string $ip The IPv4/6 address in the normal human-readable form
4131 function wfCanIPUseHTTPS( $ip ) {
4133 Hooks
::run( 'CanIPUseHTTPS', array( $ip, &$canDo ) );
4138 * Determine input string is represents as infinity
4140 * @param string $str The string to determine
4144 function wfIsInfinity( $str ) {
4145 $infinityValues = array( 'infinite', 'indefinite', 'infinity', 'never' );
4146 return in_array( $str, $infinityValues );
4150 * Work out the IP address based on various globals
4151 * For trusted proxies, use the XFF client IP (first of the chain)
4153 * @deprecated since 1.19; call $wgRequest->getIP() directly.
4156 function wfGetIP() {
4157 wfDeprecated( __METHOD__
, '1.19' );
4159 return $wgRequest->getIP();
4163 * Checks if an IP is a trusted proxy provider.
4164 * Useful to tell if X-Forwarded-For data is possibly bogus.
4165 * Squid cache servers for the site are whitelisted.
4166 * @deprecated Since 1.24, use IP::isTrustedProxy()
4171 function wfIsTrustedProxy( $ip ) {
4172 wfDeprecated( __METHOD__
, '1.24' );
4173 return IP
::isTrustedProxy( $ip );
4177 * Checks if an IP matches a proxy we've configured.
4178 * @deprecated Since 1.24, use IP::isConfiguredProxy()
4182 * @since 1.23 Supports CIDR ranges in $wgSquidServersNoPurge
4184 function wfIsConfiguredProxy( $ip ) {
4185 wfDeprecated( __METHOD__
, '1.24' );
4186 return IP
::isConfiguredProxy( $ip );
4190 * Returns true if these thumbnail parameters match one that MediaWiki
4191 * requests from file description pages and/or parser output.
4193 * $params is considered non-standard if they involve a non-standard
4194 * width or any non-default parameters aside from width and page number.
4195 * The number of possible files with standard parameters is far less than
4196 * that of all combinations; rate-limiting for them can thus be more generious.
4199 * @param array $params
4201 * @since 1.24 Moved from thumb.php to GlobalFunctions in 1.25
4203 function wfThumbIsStandard( File
$file, array $params ) {
4204 global $wgThumbLimits, $wgImageLimits, $wgResponsiveImages;
4206 $multipliers = array( 1 );
4207 if ( $wgResponsiveImages ) {
4208 // These available sizes are hardcoded currently elsewhere in MediaWiki.
4209 // @see Linker::processResponsiveImages
4210 $multipliers[] = 1.5;
4214 $handler = $file->getHandler();
4215 if ( !$handler ||
!isset( $params['width'] ) ) {
4219 $basicParams = array();
4220 if ( isset( $params['page'] ) ) {
4221 $basicParams['page'] = $params['page'];
4224 $thumbLimits = array();
4225 $imageLimits = array();
4226 // Expand limits to account for multipliers
4227 foreach ( $multipliers as $multiplier ) {
4228 $thumbLimits = array_merge( $thumbLimits, array_map(
4229 function ( $width ) use ( $multiplier ) {
4230 return round( $width * $multiplier );
4233 $imageLimits = array_merge( $imageLimits, array_map(
4234 function ( $pair ) use ( $multiplier ) {
4236 round( $pair[0] * $multiplier ),
4237 round( $pair[1] * $multiplier ),
4243 // Check if the width matches one of $wgThumbLimits
4244 if ( in_array( $params['width'], $thumbLimits ) ) {
4245 $normalParams = $basicParams +
array( 'width' => $params['width'] );
4246 // Append any default values to the map (e.g. "lossy", "lossless", ...)
4247 $handler->normaliseParams( $file, $normalParams );
4249 // If not, then check if the width matchs one of $wgImageLimits
4251 foreach ( $imageLimits as $pair ) {
4252 $normalParams = $basicParams +
array( 'width' => $pair[0], 'height' => $pair[1] );
4253 // Decide whether the thumbnail should be scaled on width or height.
4254 // Also append any default values to the map (e.g. "lossy", "lossless", ...)
4255 $handler->normaliseParams( $file, $normalParams );
4256 // Check if this standard thumbnail size maps to the given width
4257 if ( $normalParams['width'] == $params['width'] ) {
4263 return false; // not standard for description pages
4267 // Check that the given values for non-page, non-width, params are just defaults
4268 foreach ( $params as $key => $value ) {
4269 if ( !isset( $normalParams[$key] ) ||
$normalParams[$key] != $value ) {