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
;
29 use MediaWiki\ProcOpenError
;
30 use MediaWiki\Session\SessionManager
;
31 use MediaWiki\MediaWikiServices
;
32 use MediaWiki\Shell\Shell
;
33 use Wikimedia\ScopedCallback
;
34 use Wikimedia\Rdbms\DBReplicationWaitError
;
36 // Hide compatibility functions from Doxygen
39 * Compatibility functions
41 * We support PHP 5.5.9 and up.
42 * Re-implementations of newer functions or functions in non-standard
43 * PHP extensions may be included here.
46 // hash_equals function only exists in PHP >= 5.6.0
47 // https://secure.php.net/hash_equals
48 if ( !function_exists( 'hash_equals' ) ) {
50 * Check whether a user-provided string is equal to a fixed-length secret string
51 * without revealing bytes of the secret string through timing differences.
53 * The usual way to compare strings (PHP's === operator or the underlying memcmp()
54 * function in C) is to compare corresponding bytes and stop at the first difference,
55 * which would take longer for a partial match than for a complete mismatch. This
56 * is not secure when one of the strings (e.g. an HMAC or token) must remain secret
57 * and the other may come from an attacker. Statistical analysis of timing measurements
58 * over many requests may allow the attacker to guess the string's bytes one at a time
59 * (and check his guesses) even if the timing differences are extremely small.
61 * When making such a security-sensitive comparison, it is essential that the sequence
62 * in which instructions are executed and memory locations are accessed not depend on
63 * the secret string's value. HOWEVER, for simplicity, we do not attempt to minimize
64 * the inevitable leakage of the string's length. That is generally known anyway as
65 * a chararacteristic of the hash function used to compute the secret value.
67 * Longer explanation: http://www.emerose.com/timing-attacks-explained
70 * @param string $known_string Fixed-length secret string to compare against
71 * @param string $user_string User-provided string
72 * @return bool True if the strings are the same, false otherwise
74 function hash_equals( $known_string, $user_string ) {
75 // Strict type checking as in PHP's native implementation
76 if ( !is_string( $known_string ) ) {
77 trigger_error( 'hash_equals(): Expected known_string to be a string, ' .
78 gettype( $known_string ) . ' given', E_USER_WARNING
);
83 if ( !is_string( $user_string ) ) {
84 trigger_error( 'hash_equals(): Expected user_string to be a string, ' .
85 gettype( $user_string ) . ' given', E_USER_WARNING
);
90 $known_string_len = strlen( $known_string );
91 if ( $known_string_len !== strlen( $user_string ) ) {
96 for ( $i = 0; $i < $known_string_len; $i++
) {
97 $result |
= ord( $known_string[$i] ) ^
ord( $user_string[$i] );
100 return ( $result === 0 );
108 * This queues an extension to be loaded through
109 * the ExtensionRegistry system.
111 * @param string $ext Name of the extension to load
112 * @param string|null $path Absolute path of where to find the extension.json file
115 function wfLoadExtension( $ext, $path = null ) {
117 global $wgExtensionDirectory;
118 $path = "$wgExtensionDirectory/$ext/extension.json";
120 ExtensionRegistry
::getInstance()->queue( $path );
124 * Load multiple extensions at once
126 * Same as wfLoadExtension, but more efficient if you
127 * are loading multiple extensions.
129 * If you want to specify custom paths, you should interact with
130 * ExtensionRegistry directly.
132 * @see wfLoadExtension
133 * @param string[] $exts Array of extension names to load
136 function wfLoadExtensions( array $exts ) {
137 global $wgExtensionDirectory;
138 $registry = ExtensionRegistry
::getInstance();
139 foreach ( $exts as $ext ) {
140 $registry->queue( "$wgExtensionDirectory/$ext/extension.json" );
147 * @see wfLoadExtension
148 * @param string $skin Name of the extension to load
149 * @param string|null $path Absolute path of where to find the skin.json file
152 function wfLoadSkin( $skin, $path = null ) {
154 global $wgStyleDirectory;
155 $path = "$wgStyleDirectory/$skin/skin.json";
157 ExtensionRegistry
::getInstance()->queue( $path );
161 * Load multiple skins at once
163 * @see wfLoadExtensions
164 * @param string[] $skins Array of extension names to load
167 function wfLoadSkins( array $skins ) {
168 global $wgStyleDirectory;
169 $registry = ExtensionRegistry
::getInstance();
170 foreach ( $skins as $skin ) {
171 $registry->queue( "$wgStyleDirectory/$skin/skin.json" );
176 * Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
181 function wfArrayDiff2( $a, $b ) {
182 return array_udiff( $a, $b, 'wfArrayDiff2_cmp' );
186 * @param array|string $a
187 * @param array|string $b
190 function wfArrayDiff2_cmp( $a, $b ) {
191 if ( is_string( $a ) && is_string( $b ) ) {
192 return strcmp( $a, $b );
193 } elseif ( count( $a ) !== count( $b ) ) {
194 return count( $a ) < count( $b ) ?
-1 : 1;
198 while ( key( $a ) !== null && key( $b ) !== null ) {
199 $valueA = current( $a );
200 $valueB = current( $b );
201 $cmp = strcmp( $valueA, $valueB );
213 * Like array_filter with ARRAY_FILTER_USE_BOTH, but works pre-5.6.
216 * @param callable $callback Will be called with the array value and key (in that order) and
217 * should return a bool which will determine whether the array element is kept.
220 function wfArrayFilter( array $arr, callable
$callback ) {
221 if ( defined( 'ARRAY_FILTER_USE_BOTH' ) ) {
222 return array_filter( $arr, $callback, ARRAY_FILTER_USE_BOTH
);
224 $filteredKeys = array_filter( array_keys( $arr ), function ( $key ) use ( $arr, $callback ) {
225 return call_user_func( $callback, $arr[$key], $key );
227 return array_intersect_key( $arr, array_fill_keys( $filteredKeys, true ) );
231 * Like array_filter with ARRAY_FILTER_USE_KEY, but works pre-5.6.
234 * @param callable $callback Will be called with the array key and should return a bool which
235 * will determine whether the array element is kept.
238 function wfArrayFilterByKey( array $arr, callable
$callback ) {
239 return wfArrayFilter( $arr, function ( $val, $key ) use ( $callback ) {
240 return call_user_func( $callback, $key );
245 * Appends to second array if $value differs from that in $default
247 * @param string|int $key
248 * @param mixed $value
249 * @param mixed $default
250 * @param array &$changed Array to alter
251 * @throws MWException
253 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
254 if ( is_null( $changed ) ) {
255 throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' );
257 if ( $default[$key] !== $value ) {
258 $changed[$key] = $value;
263 * Merge arrays in the style of getUserPermissionsErrors, with duplicate removal
265 * wfMergeErrorArrays(
278 * @param array $array1,...
281 function wfMergeErrorArrays( /*...*/ ) {
282 $args = func_get_args();
284 foreach ( $args as $errors ) {
285 foreach ( $errors as $params ) {
286 $originalParams = $params;
287 if ( $params[0] instanceof MessageSpecifier
) {
289 $params = array_merge( [ $msg->getKey() ], $msg->getParams() );
291 # @todo FIXME: Sometimes get nested arrays for $params,
292 # which leads to E_NOTICEs
293 $spec = implode( "\t", $params );
294 $out[$spec] = $originalParams;
297 return array_values( $out );
301 * Insert array into another array after the specified *KEY*
303 * @param array $array The array.
304 * @param array $insert The array to insert.
305 * @param mixed $after The key to insert after
308 function wfArrayInsertAfter( array $array, array $insert, $after ) {
309 // Find the offset of the element to insert after.
310 $keys = array_keys( $array );
311 $offsetByKey = array_flip( $keys );
313 $offset = $offsetByKey[$after];
315 // Insert at the specified offset
316 $before = array_slice( $array, 0, $offset +
1, true );
317 $after = array_slice( $array, $offset +
1, count( $array ) - $offset, true );
319 $output = $before +
$insert +
$after;
325 * Recursively converts the parameter (an object) to an array with the same data
327 * @param object|array $objOrArray
328 * @param bool $recursive
331 function wfObjectToArray( $objOrArray, $recursive = true ) {
333 if ( is_object( $objOrArray ) ) {
334 $objOrArray = get_object_vars( $objOrArray );
336 foreach ( $objOrArray as $key => $value ) {
337 if ( $recursive && ( is_object( $value ) ||
is_array( $value ) ) ) {
338 $value = wfObjectToArray( $value );
341 $array[$key] = $value;
348 * Get a random decimal value between 0 and 1, in a way
349 * not likely to give duplicate values for any realistic
350 * number of articles.
352 * @note This is designed for use in relation to Special:RandomPage
353 * and the page_random database field.
357 function wfRandom() {
358 // The maximum random value is "only" 2^31-1, so get two random
359 // values to reduce the chance of dupes
360 $max = mt_getrandmax() +
1;
361 $rand = number_format( ( mt_rand() * $max +
mt_rand() ) / $max / $max, 12, '.', '' );
366 * Get a random string containing a number of pseudo-random hex characters.
368 * @note This is not secure, if you are trying to generate some sort
369 * of token please use MWCryptRand instead.
371 * @param int $length The length of the string to generate
375 function wfRandomString( $length = 32 ) {
377 for ( $n = 0; $n < $length; $n +
= 7 ) {
378 $str .= sprintf( '%07x', mt_rand() & 0xfffffff );
380 return substr( $str, 0, $length );
384 * We want some things to be included as literal characters in our title URLs
385 * for prettiness, which urlencode encodes by default. According to RFC 1738,
386 * all of the following should be safe:
390 * RFC 1738 says ~ is unsafe, however RFC 3986 considers it an unreserved
391 * character which should not be encoded. More importantly, google chrome
392 * always converts %7E back to ~, and converting it in this function can
393 * cause a redirect loop (T105265).
395 * But + is not safe because it's used to indicate a space; &= are only safe in
396 * paths and not in queries (and we don't distinguish here); ' seems kind of
397 * scary; and urlencode() doesn't touch -_. to begin with. Plus, although /
398 * is reserved, we don't care. So the list we unescape is:
402 * However, IIS7 redirects fail when the url contains a colon (see T24709),
403 * so no fancy : for IIS7.
405 * %2F in the page titles seems to fatally break for some reason.
410 function wfUrlencode( $s ) {
413 if ( is_null( $s ) ) {
418 if ( is_null( $needle ) ) {
419 $needle = [ '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F', '%7E' ];
420 if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) ||
421 ( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false )
427 $s = urlencode( $s );
430 [ ';', '@', '$', '!', '*', '(', ')', ',', '/', '~', ':' ],
438 * This function takes one or two arrays as input, and returns a CGI-style string, e.g.
439 * "days=7&limit=100". Options in the first array override options in the second.
440 * Options set to null or false will not be output.
442 * @param array $array1 ( String|Array )
443 * @param array|null $array2 ( String|Array )
444 * @param string $prefix
447 function wfArrayToCgi( $array1, $array2 = null, $prefix = '' ) {
448 if ( !is_null( $array2 ) ) {
449 $array1 = $array1 +
$array2;
453 foreach ( $array1 as $key => $value ) {
454 if ( !is_null( $value ) && $value !== false ) {
458 if ( $prefix !== '' ) {
459 $key = $prefix . "[$key]";
461 if ( is_array( $value ) ) {
463 foreach ( $value as $k => $v ) {
464 $cgi .= $firstTime ?
'' : '&';
465 if ( is_array( $v ) ) {
466 $cgi .= wfArrayToCgi( $v, null, $key . "[$k]" );
468 $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v );
473 if ( is_object( $value ) ) {
474 $value = $value->__toString();
476 $cgi .= urlencode( $key ) . '=' . urlencode( $value );
484 * This is the logical opposite of wfArrayToCgi(): it accepts a query string as
485 * its argument and returns the same string in array form. This allows compatibility
486 * with legacy functions that accept raw query strings instead of nice
487 * arrays. Of course, keys and values are urldecode()d.
489 * @param string $query Query string
490 * @return string[] Array version of input
492 function wfCgiToArray( $query ) {
493 if ( isset( $query[0] ) && $query[0] == '?' ) {
494 $query = substr( $query, 1 );
496 $bits = explode( '&', $query );
498 foreach ( $bits as $bit ) {
502 if ( strpos( $bit, '=' ) === false ) {
503 // Pieces like &qwerty become 'qwerty' => '' (at least this is what php does)
507 list( $key, $value ) = explode( '=', $bit );
509 $key = urldecode( $key );
510 $value = urldecode( $value );
511 if ( strpos( $key, '[' ) !== false ) {
512 $keys = array_reverse( explode( '[', $key ) );
513 $key = array_pop( $keys );
515 foreach ( $keys as $k ) {
516 $k = substr( $k, 0, -1 );
517 $temp = [ $k => $temp ];
519 if ( isset( $ret[$key] ) ) {
520 $ret[$key] = array_merge( $ret[$key], $temp );
532 * Append a query string to an existing URL, which may or may not already
533 * have query string parameters already. If so, they will be combined.
536 * @param string|string[] $query String or associative array
539 function wfAppendQuery( $url, $query ) {
540 if ( is_array( $query ) ) {
541 $query = wfArrayToCgi( $query );
543 if ( $query != '' ) {
544 // Remove the fragment, if there is one
546 $hashPos = strpos( $url, '#' );
547 if ( $hashPos !== false ) {
548 $fragment = substr( $url, $hashPos );
549 $url = substr( $url, 0, $hashPos );
553 if ( false === strpos( $url, '?' ) ) {
560 // Put the fragment back
561 if ( $fragment !== false ) {
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|false 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://phabricator.wikimedia.org/T67184
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 (see T34168)
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 (see T34168)
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 ) ) {
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 (see (2)).
853 * 4) Verifies that the protocol is on the $wgUrlProtocols whitelist.
854 * 5) Rejects some invalid URLs that parse_url doesn't, e.g. the empty string or URLs starting with
855 * a line feed character.
857 * @param string $url A URL to parse
858 * @return string[]|bool Bits of the URL in an associative array, or false on failure.
860 * - scheme: URI scheme (protocol), e.g. 'http', 'mailto'. Lowercase, always present, but can
861 * be an empty string for protocol-relative URLs.
862 * - delimiter: either '://', ':' or '//'. Always present.
863 * - host: domain name / IP. Always present, but could be an empty string, e.g. for file: URLs.
864 * - user: user name, e.g. for HTTP Basic auth URLs such as http://user:pass@example.com/
865 * Missing when there is no username.
866 * - pass: password, same as above.
867 * - path: path including the leading /. Will be missing when empty (e.g. 'http://example.com')
868 * - query: query string (as a string; see wfCgiToArray() for parsing it), can be missing.
869 * - fragment: the part after #, can be missing.
871 function wfParseUrl( $url ) {
872 global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
874 // Protocol-relative URLs are handled really badly by parse_url(). It's so
875 // bad that the easiest way to handle them is to just prepend 'http:' and
876 // strip the protocol out later.
877 $wasRelative = substr( $url, 0, 2 ) == '//';
878 if ( $wasRelative ) {
881 MediaWiki\
suppressWarnings();
882 $bits = parse_url( $url );
883 MediaWiki\restoreWarnings
();
884 // parse_url() returns an array without scheme for some invalid URLs, e.g.
885 // parse_url("%0Ahttp://example.com") == [ 'host' => '%0Ahttp', 'path' => 'example.com' ]
886 if ( !$bits ||
!isset( $bits['scheme'] ) ) {
890 // parse_url() incorrectly handles schemes case-sensitively. Convert it to lowercase.
891 $bits['scheme'] = strtolower( $bits['scheme'] );
893 // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
894 if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
895 $bits['delimiter'] = '://';
896 } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
897 $bits['delimiter'] = ':';
898 // parse_url detects for news: and mailto: the host part of an url as path
899 // We have to correct this wrong detection
900 if ( isset( $bits['path'] ) ) {
901 $bits['host'] = $bits['path'];
908 /* Provide an empty host for eg. file:/// urls (see T30627) */
909 if ( !isset( $bits['host'] ) ) {
913 if ( isset( $bits['path'] ) ) {
914 /* parse_url loses the third / for file:///c:/ urls (but not on variants) */
915 if ( substr( $bits['path'], 0, 1 ) !== '/' ) {
916 $bits['path'] = '/' . $bits['path'];
923 // If the URL was protocol-relative, fix scheme and delimiter
924 if ( $wasRelative ) {
925 $bits['scheme'] = '';
926 $bits['delimiter'] = '//';
932 * Take a URL, make sure it's expanded to fully qualified, and replace any
933 * encoded non-ASCII Unicode characters with their UTF-8 original forms
934 * for more compact display and legibility for local audiences.
936 * @todo handle punycode domains too
941 function wfExpandIRI( $url ) {
942 return preg_replace_callback(
943 '/((?:%[89A-F][0-9A-F])+)/i',
944 'wfExpandIRI_callback',
950 * Private callback for wfExpandIRI
951 * @param array $matches
954 function wfExpandIRI_callback( $matches ) {
955 return urldecode( $matches[1] );
959 * Make URL indexes, appropriate for the el_index field of externallinks.
964 function wfMakeUrlIndexes( $url ) {
965 $bits = wfParseUrl( $url );
967 // Reverse the labels in the hostname, convert to lower case
968 // For emails reverse domainpart only
969 if ( $bits['scheme'] == 'mailto' ) {
970 $mailparts = explode( '@', $bits['host'], 2 );
971 if ( count( $mailparts ) === 2 ) {
972 $domainpart = strtolower( implode( '.', array_reverse( explode( '.', $mailparts[1] ) ) ) );
974 // No domain specified, don't mangle it
977 $reversedHost = $domainpart . '@' . $mailparts[0];
979 $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) );
981 // Add an extra dot to the end
982 // Why? Is it in wrong place in mailto links?
983 if ( substr( $reversedHost, -1, 1 ) !== '.' ) {
984 $reversedHost .= '.';
986 // Reconstruct the pseudo-URL
987 $prot = $bits['scheme'];
988 $index = $prot . $bits['delimiter'] . $reversedHost;
989 // Leave out user and password. Add the port, path, query and fragment
990 if ( isset( $bits['port'] ) ) {
991 $index .= ':' . $bits['port'];
993 if ( isset( $bits['path'] ) ) {
994 $index .= $bits['path'];
998 if ( isset( $bits['query'] ) ) {
999 $index .= '?' . $bits['query'];
1001 if ( isset( $bits['fragment'] ) ) {
1002 $index .= '#' . $bits['fragment'];
1005 if ( $prot == '' ) {
1006 return [ "http:$index", "https:$index" ];
1013 * Check whether a given URL has a domain that occurs in a given set of domains
1014 * @param string $url URL
1015 * @param array $domains Array of domains (strings)
1016 * @return bool True if the host part of $url ends in one of the strings in $domains
1018 function wfMatchesDomainList( $url, $domains ) {
1019 $bits = wfParseUrl( $url );
1020 if ( is_array( $bits ) && isset( $bits['host'] ) ) {
1021 $host = '.' . $bits['host'];
1022 foreach ( (array)$domains as $domain ) {
1023 $domain = '.' . $domain;
1024 if ( substr( $host, -strlen( $domain ) ) === $domain ) {
1033 * Sends a line to the debug log if enabled or, optionally, to a comment in output.
1034 * In normal operation this is a NOP.
1036 * Controlling globals:
1037 * $wgDebugLogFile - points to the log file
1038 * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
1039 * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
1041 * @since 1.25 support for additional context data
1043 * @param string $text
1044 * @param string|bool $dest Destination of the message:
1045 * - 'all': both to the log and HTML (debug toolbar or HTML comments)
1046 * - 'private': excluded from HTML output
1047 * For backward compatibility, it can also take a boolean:
1048 * - true: same as 'all'
1049 * - false: same as 'private'
1050 * @param array $context Additional logging context data
1052 function wfDebug( $text, $dest = 'all', array $context = [] ) {
1053 global $wgDebugRawPage, $wgDebugLogPrefix;
1054 global $wgDebugTimestamps, $wgRequestTime;
1056 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1060 $text = trim( $text );
1062 if ( $wgDebugTimestamps ) {
1063 $context['seconds_elapsed'] = sprintf(
1065 microtime( true ) - $wgRequestTime
1067 $context['memory_used'] = sprintf(
1069 ( memory_get_usage( true ) / ( 1024 * 1024 ) )
1073 if ( $wgDebugLogPrefix !== '' ) {
1074 $context['prefix'] = $wgDebugLogPrefix;
1076 $context['private'] = ( $dest === false ||
$dest === 'private' );
1078 $logger = LoggerFactory
::getInstance( 'wfDebug' );
1079 $logger->debug( $text, $context );
1083 * Returns true if debug logging should be suppressed if $wgDebugRawPage = false
1086 function wfIsDebugRawPage() {
1088 if ( $cache !== null ) {
1091 # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
1092 if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
1094 isset( $_SERVER['SCRIPT_NAME'] )
1095 && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
1106 * Send a line giving PHP memory usage.
1108 * @param bool $exact Print exact byte values instead of kibibytes (default: false)
1110 function wfDebugMem( $exact = false ) {
1111 $mem = memory_get_usage();
1113 $mem = floor( $mem / 1024 ) . ' KiB';
1117 wfDebug( "Memory usage: $mem\n" );
1121 * Send a line to a supplementary debug log file, if configured, or main debug
1124 * To configure a supplementary log file, set $wgDebugLogGroups[$logGroup] to
1125 * a string filename or an associative array mapping 'destination' to the
1126 * desired filename. The associative array may also contain a 'sample' key
1127 * with an integer value, specifying a sampling factor. Sampled log events
1128 * will be emitted with a 1 in N random chance.
1130 * @since 1.23 support for sampling log messages via $wgDebugLogGroups.
1131 * @since 1.25 support for additional context data
1132 * @since 1.25 sample behavior dependent on configured $wgMWLoggerDefaultSpi
1134 * @param string $logGroup
1135 * @param string $text
1136 * @param string|bool $dest Destination of the message:
1137 * - 'all': both to the log and HTML (debug toolbar or HTML comments)
1138 * - 'private': only to the specific log if set in $wgDebugLogGroups and
1139 * discarded otherwise
1140 * For backward compatibility, it can also take a boolean:
1141 * - true: same as 'all'
1142 * - false: same as 'private'
1143 * @param array $context Additional logging context data
1145 function wfDebugLog(
1146 $logGroup, $text, $dest = 'all', array $context = []
1148 $text = trim( $text );
1150 $logger = LoggerFactory
::getInstance( $logGroup );
1151 $context['private'] = ( $dest === false ||
$dest === 'private' );
1152 $logger->info( $text, $context );
1156 * Log for database errors
1158 * @since 1.25 support for additional context data
1160 * @param string $text Database error message.
1161 * @param array $context Additional logging context data
1163 function wfLogDBError( $text, array $context = [] ) {
1164 $logger = LoggerFactory
::getInstance( 'wfLogDBError' );
1165 $logger->error( trim( $text ), $context );
1169 * Throws a warning that $function is deprecated
1171 * @param string $function
1172 * @param string|bool $version Version of MediaWiki that the function
1173 * was deprecated in (Added in 1.19).
1174 * @param string|bool $component Added in 1.19.
1175 * @param int $callerOffset How far up the call stack is the original
1176 * caller. 2 = function that called the function that called
1177 * wfDeprecated (Added in 1.20)
1181 function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) {
1182 MWDebug
::deprecated( $function, $version, $component, $callerOffset +
1 );
1186 * Send a warning either to the debug log or in a PHP error depending on
1187 * $wgDevelopmentWarnings. To log warnings in production, use wfLogWarning() instead.
1189 * @param string $msg Message to send
1190 * @param int $callerOffset Number of items to go back in the backtrace to
1191 * find the correct caller (1 = function calling wfWarn, ...)
1192 * @param int $level PHP error level; defaults to E_USER_NOTICE;
1193 * only used when $wgDevelopmentWarnings is true
1195 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE
) {
1196 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'auto' );
1200 * Send a warning as a PHP error and the debug log. This is intended for logging
1201 * warnings in production. For logging development warnings, use WfWarn instead.
1203 * @param string $msg Message to send
1204 * @param int $callerOffset Number of items to go back in the backtrace to
1205 * find the correct caller (1 = function calling wfLogWarning, ...)
1206 * @param int $level PHP error level; defaults to E_USER_WARNING
1208 function wfLogWarning( $msg, $callerOffset = 1, $level = E_USER_WARNING
) {
1209 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'production' );
1213 * Log to a file without getting "file size exceeded" signals.
1215 * Can also log to TCP or UDP with the syntax udp://host:port/prefix. This will
1216 * send lines to the specified port, prefixed by the specified prefix and a space.
1217 * @since 1.25 support for additional context data
1219 * @param string $text
1220 * @param string $file Filename
1221 * @param array $context Additional logging context data
1222 * @throws MWException
1223 * @deprecated since 1.25 Use \MediaWiki\Logger\LegacyLogger::emit or UDPTransport
1225 function wfErrorLog( $text, $file, array $context = [] ) {
1226 wfDeprecated( __METHOD__
, '1.25' );
1227 $logger = LoggerFactory
::getInstance( 'wfErrorLog' );
1228 $context['destination'] = $file;
1229 $logger->info( trim( $text ), $context );
1235 function wfLogProfilingData() {
1236 global $wgDebugLogGroups, $wgDebugRawPage;
1238 $context = RequestContext
::getMain();
1239 $request = $context->getRequest();
1241 $profiler = Profiler
::instance();
1242 $profiler->setContext( $context );
1243 $profiler->logData();
1245 $config = $context->getConfig();
1246 $stats = MediaWikiServices
::getInstance()->getStatsdDataFactory();
1247 if ( $config->get( 'StatsdServer' ) && $stats->hasData() ) {
1249 $statsdServer = explode( ':', $config->get( 'StatsdServer' ) );
1250 $statsdHost = $statsdServer[0];
1251 $statsdPort = isset( $statsdServer[1] ) ?
$statsdServer[1] : 8125;
1252 $statsdSender = new SocketSender( $statsdHost, $statsdPort );
1253 $statsdClient = new SamplingStatsdClient( $statsdSender, true, false );
1254 $statsdClient->setSamplingRates( $config->get( 'StatsdSamplingRates' ) );
1255 $statsdClient->send( $stats->getData() );
1256 } catch ( Exception
$ex ) {
1257 MWExceptionHandler
::logException( $ex );
1261 # Profiling must actually be enabled...
1262 if ( $profiler instanceof ProfilerStub
) {
1266 if ( isset( $wgDebugLogGroups['profileoutput'] )
1267 && $wgDebugLogGroups['profileoutput'] === false
1269 // Explicitly disabled
1272 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1276 $ctx = [ 'elapsed' => $request->getElapsedTime() ];
1277 if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1278 $ctx['forwarded_for'] = $_SERVER['HTTP_X_FORWARDED_FOR'];
1280 if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1281 $ctx['client_ip'] = $_SERVER['HTTP_CLIENT_IP'];
1283 if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1284 $ctx['from'] = $_SERVER['HTTP_FROM'];
1286 if ( isset( $ctx['forwarded_for'] ) ||
1287 isset( $ctx['client_ip'] ) ||
1288 isset( $ctx['from'] ) ) {
1289 $ctx['proxy'] = $_SERVER['REMOTE_ADDR'];
1292 // Don't load $wgUser at this late stage just for statistics purposes
1293 // @todo FIXME: We can detect some anons even if it is not loaded.
1294 // See User::getId()
1295 $user = $context->getUser();
1296 $ctx['anon'] = $user->isItemLoaded( 'id' ) && $user->isAnon();
1298 // Command line script uses a FauxRequest object which does not have
1299 // any knowledge about an URL and throw an exception instead.
1301 $ctx['url'] = urldecode( $request->getRequestURL() );
1302 } catch ( Exception
$ignored ) {
1306 $ctx['output'] = $profiler->getOutput();
1308 $log = LoggerFactory
::getInstance( 'profileoutput' );
1309 $log->info( "Elapsed: {elapsed}; URL: <{url}>\n{output}", $ctx );
1313 * Increment a statistics counter
1315 * @param string $key
1319 function wfIncrStats( $key, $count = 1 ) {
1320 $stats = MediaWikiServices
::getInstance()->getStatsdDataFactory();
1321 $stats->updateCount( $key, $count );
1325 * Check whether the wiki is in read-only mode.
1329 function wfReadOnly() {
1330 return MediaWikiServices
::getInstance()->getReadOnlyMode()
1335 * Check if the site is in read-only mode and return the message if so
1337 * This checks wfConfiguredReadOnlyReason() and the main load balancer
1338 * for replica DB lag. This may result in DB connection being made.
1340 * @return string|bool String when in read-only mode; false otherwise
1342 function wfReadOnlyReason() {
1343 return MediaWikiServices
::getInstance()->getReadOnlyMode()
1348 * Get the value of $wgReadOnly or the contents of $wgReadOnlyFile.
1350 * @return string|bool String when in read-only mode; false otherwise
1353 function wfConfiguredReadOnlyReason() {
1354 return MediaWikiServices
::getInstance()->getConfiguredReadOnlyMode()
1359 * Return a Language object from $langcode
1361 * @param Language|string|bool $langcode Either:
1362 * - a Language object
1363 * - code of the language to get the message for, if it is
1364 * a valid code create a language for that language, if
1365 * it is a string but not a valid code then make a basic
1367 * - a boolean: if it's false then use the global object for
1368 * the current user's language (as a fallback for the old parameter
1369 * functionality), or if it is true then use global object
1370 * for the wiki's content language.
1373 function wfGetLangObj( $langcode = false ) {
1374 # Identify which language to get or create a language object for.
1375 # Using is_object here due to Stub objects.
1376 if ( is_object( $langcode ) ) {
1377 # Great, we already have the object (hopefully)!
1381 global $wgContLang, $wgLanguageCode;
1382 if ( $langcode === true ||
$langcode === $wgLanguageCode ) {
1383 # $langcode is the language code of the wikis content language object.
1384 # or it is a boolean and value is true
1389 if ( $langcode === false ||
$langcode === $wgLang->getCode() ) {
1390 # $langcode is the language code of user language object.
1391 # or it was a boolean and value is false
1395 $validCodes = array_keys( Language
::fetchLanguageNames() );
1396 if ( in_array( $langcode, $validCodes ) ) {
1397 # $langcode corresponds to a valid language.
1398 return Language
::factory( $langcode );
1401 # $langcode is a string, but not a valid language code; use content language.
1402 wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1407 * This is the function for getting translated interface messages.
1409 * @see Message class for documentation how to use them.
1410 * @see https://www.mediawiki.org/wiki/Manual:Messages_API
1412 * This function replaces all old wfMsg* functions.
1414 * @param string|string[]|MessageSpecifier $key Message key, or array of keys, or a MessageSpecifier
1415 * @param mixed $params,... Normal message parameters
1420 * @see Message::__construct
1422 function wfMessage( $key /*...*/ ) {
1423 $message = new Message( $key );
1425 // We call Message::params() to reduce code duplication
1426 $params = func_get_args();
1427 array_shift( $params );
1429 call_user_func_array( [ $message, 'params' ], $params );
1436 * This function accepts multiple message keys and returns a message instance
1437 * for the first message which is non-empty. If all messages are empty then an
1438 * instance of the first message key is returned.
1440 * @param string|string[] $keys,... Message keys
1445 * @see Message::newFallbackSequence
1447 function wfMessageFallback( /*...*/ ) {
1448 $args = func_get_args();
1449 return call_user_func_array( 'Message::newFallbackSequence', $args );
1453 * Replace message parameter keys on the given formatted output.
1455 * @param string $message
1456 * @param array $args
1460 function wfMsgReplaceArgs( $message, $args ) {
1461 # Fix windows line-endings
1462 # Some messages are split with explode("\n", $msg)
1463 $message = str_replace( "\r", '', $message );
1465 // Replace arguments
1466 if ( is_array( $args ) && $args ) {
1467 if ( is_array( $args[0] ) ) {
1468 $args = array_values( $args[0] );
1470 $replacementKeys = [];
1471 foreach ( $args as $n => $param ) {
1472 $replacementKeys['$' . ( $n +
1 )] = $param;
1474 $message = strtr( $message, $replacementKeys );
1481 * Fetch server name for use in error reporting etc.
1482 * Use real server name if available, so we know which machine
1483 * in a server farm generated the current page.
1487 function wfHostname() {
1489 if ( is_null( $host ) ) {
1490 # Hostname overriding
1491 global $wgOverrideHostname;
1492 if ( $wgOverrideHostname !== false ) {
1493 # Set static and skip any detection
1494 $host = $wgOverrideHostname;
1498 if ( function_exists( 'posix_uname' ) ) {
1499 // This function not present on Windows
1500 $uname = posix_uname();
1504 if ( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1505 $host = $uname['nodename'];
1506 } elseif ( getenv( 'COMPUTERNAME' ) ) {
1507 # Windows computer name
1508 $host = getenv( 'COMPUTERNAME' );
1510 # This may be a virtual server.
1511 $host = $_SERVER['SERVER_NAME'];
1518 * Returns a script tag that stores the amount of time it took MediaWiki to
1519 * handle the request in milliseconds as 'wgBackendResponseTime'.
1521 * If $wgShowHostnames is true, the script will also set 'wgHostname' to the
1522 * hostname of the server handling the request.
1526 function wfReportTime() {
1527 global $wgRequestTime, $wgShowHostnames;
1529 $responseTime = round( ( microtime( true ) - $wgRequestTime ) * 1000 );
1530 $reportVars = [ 'wgBackendResponseTime' => $responseTime ];
1531 if ( $wgShowHostnames ) {
1532 $reportVars['wgHostname'] = wfHostname();
1534 return Skin
::makeVariablesScript( $reportVars );
1538 * Safety wrapper for debug_backtrace().
1540 * Will return an empty array if debug_backtrace is disabled, otherwise
1541 * the output from debug_backtrace() (trimmed).
1543 * @param int $limit This parameter can be used to limit the number of stack frames returned
1545 * @return array Array of backtrace information
1547 function wfDebugBacktrace( $limit = 0 ) {
1548 static $disabled = null;
1550 if ( is_null( $disabled ) ) {
1551 $disabled = !function_exists( 'debug_backtrace' );
1553 wfDebug( "debug_backtrace() is disabled\n" );
1561 return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT
, $limit +
1 ), 1 );
1563 return array_slice( debug_backtrace(), 1 );
1568 * Get a debug backtrace as a string
1570 * @param bool|null $raw If true, the return value is plain text. If false, HTML.
1571 * Defaults to $wgCommandLineMode if unset.
1573 * @since 1.25 Supports $raw parameter.
1575 function wfBacktrace( $raw = null ) {
1576 global $wgCommandLineMode;
1578 if ( $raw === null ) {
1579 $raw = $wgCommandLineMode;
1583 $frameFormat = "%s line %s calls %s()\n";
1584 $traceFormat = "%s";
1586 $frameFormat = "<li>%s line %s calls %s()</li>\n";
1587 $traceFormat = "<ul>\n%s</ul>\n";
1590 $frames = array_map( function ( $frame ) use ( $frameFormat ) {
1591 $file = !empty( $frame['file'] ) ?
basename( $frame['file'] ) : '-';
1592 $line = isset( $frame['line'] ) ?
$frame['line'] : '-';
1593 $call = $frame['function'];
1594 if ( !empty( $frame['class'] ) ) {
1595 $call = $frame['class'] . $frame['type'] . $call;
1597 return sprintf( $frameFormat, $file, $line, $call );
1598 }, wfDebugBacktrace() );
1600 return sprintf( $traceFormat, implode( '', $frames ) );
1604 * Get the name of the function which called this function
1605 * wfGetCaller( 1 ) is the function with the wfGetCaller() call (ie. __FUNCTION__)
1606 * wfGetCaller( 2 ) [default] is the caller of the function running wfGetCaller()
1607 * wfGetCaller( 3 ) is the parent of that.
1612 function wfGetCaller( $level = 2 ) {
1613 $backtrace = wfDebugBacktrace( $level +
1 );
1614 if ( isset( $backtrace[$level] ) ) {
1615 return wfFormatStackFrame( $backtrace[$level] );
1622 * Return a string consisting of callers in the stack. Useful sometimes
1623 * for profiling specific points.
1625 * @param int $limit The maximum depth of the stack frame to return, or false for the entire stack.
1628 function wfGetAllCallers( $limit = 3 ) {
1629 $trace = array_reverse( wfDebugBacktrace() );
1630 if ( !$limit ||
$limit > count( $trace ) - 1 ) {
1631 $limit = count( $trace ) - 1;
1633 $trace = array_slice( $trace, -$limit - 1, $limit );
1634 return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1638 * Return a string representation of frame
1640 * @param array $frame
1643 function wfFormatStackFrame( $frame ) {
1644 if ( !isset( $frame['function'] ) ) {
1645 return 'NO_FUNCTION_GIVEN';
1647 return isset( $frame['class'] ) && isset( $frame['type'] ) ?
1648 $frame['class'] . $frame['type'] . $frame['function'] :
1652 /* Some generic result counters, pulled out of SearchEngine */
1657 * @param int $offset
1661 function wfShowingResults( $offset, $limit ) {
1662 return wfMessage( 'showingresults' )->numParams( $limit, $offset +
1 )->parse();
1666 * Whether the client accept gzip encoding
1668 * Uses the Accept-Encoding header to check if the client supports gzip encoding.
1669 * Use this when considering to send a gzip-encoded response to the client.
1671 * @param bool $force Forces another check even if we already have a cached result.
1674 function wfClientAcceptsGzip( $force = false ) {
1675 static $result = null;
1676 if ( $result === null ||
$force ) {
1678 if ( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
1679 # @todo FIXME: We may want to blacklist some broken browsers
1682 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
1683 $_SERVER['HTTP_ACCEPT_ENCODING'],
1687 if ( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
1691 wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
1700 * Escapes the given text so that it may be output using addWikiText()
1701 * without any linking, formatting, etc. making its way through. This
1702 * is achieved by substituting certain characters with HTML entities.
1703 * As required by the callers, "<nowiki>" is not used.
1705 * @param string $text Text to be escaped
1708 function wfEscapeWikiText( $text ) {
1709 global $wgEnableMagicLinks;
1710 static $repl = null, $repl2 = null;
1711 if ( $repl === null ||
defined( 'MW_PARSER_TEST' ) ||
defined( 'MW_PHPUNIT_TEST' ) ) {
1712 // Tests depend upon being able to change $wgEnableMagicLinks, so don't cache
1713 // in those situations
1715 '"' => '"', '&' => '&', "'" => ''', '<' => '<',
1716 '=' => '=', '>' => '>', '[' => '[', ']' => ']',
1717 '{' => '{', '|' => '|', '}' => '}', ';' => ';',
1718 "\n#" => "\n#", "\r#" => "\r#",
1719 "\n*" => "\n*", "\r*" => "\r*",
1720 "\n:" => "\n:", "\r:" => "\r:",
1721 "\n " => "\n ", "\r " => "\r ",
1722 "\n\n" => "\n ", "\r\n" => " \n",
1723 "\n\r" => "\n ", "\r\r" => "\r ",
1724 "\n\t" => "\n	", "\r\t" => "\r	", // "\n\t\n" is treated like "\n\n"
1725 "\n----" => "\n----", "\r----" => "\r----",
1726 '__' => '__', '://' => '://',
1729 $magicLinks = array_keys( array_filter( $wgEnableMagicLinks ) );
1730 // We have to catch everything "\s" matches in PCRE
1731 foreach ( $magicLinks as $magic ) {
1732 $repl["$magic "] = "$magic ";
1733 $repl["$magic\t"] = "$magic	";
1734 $repl["$magic\r"] = "$magic ";
1735 $repl["$magic\n"] = "$magic ";
1736 $repl["$magic\f"] = "$magic";
1739 // And handle protocols that don't use "://"
1740 global $wgUrlProtocols;
1742 foreach ( $wgUrlProtocols as $prot ) {
1743 if ( substr( $prot, -1 ) === ':' ) {
1744 $repl2[] = preg_quote( substr( $prot, 0, -1 ), '/' );
1747 $repl2 = $repl2 ?
'/\b(' . implode( '|', $repl2 ) . '):/i' : '/^(?!)/';
1749 $text = substr( strtr( "\n$text", $repl ), 1 );
1750 $text = preg_replace( $repl2, '$1:', $text );
1755 * Sets dest to source and returns the original value of dest
1756 * If source is NULL, it just returns the value, it doesn't set the variable
1757 * If force is true, it will set the value even if source is NULL
1759 * @param mixed &$dest
1760 * @param mixed $source
1761 * @param bool $force
1764 function wfSetVar( &$dest, $source, $force = false ) {
1766 if ( !is_null( $source ) ||
$force ) {
1773 * As for wfSetVar except setting a bit
1777 * @param bool $state
1781 function wfSetBit( &$dest, $bit, $state = true ) {
1782 $temp = (bool)( $dest & $bit );
1783 if ( !is_null( $state ) ) {
1794 * A wrapper around the PHP function var_export().
1795 * Either print it or add it to the regular output ($wgOut).
1797 * @param mixed $var A PHP variable to dump.
1799 function wfVarDump( $var ) {
1801 $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
1802 if ( headers_sent() ||
!isset( $wgOut ) ||
!is_object( $wgOut ) ) {
1805 $wgOut->addHTML( $s );
1810 * Provide a simple HTTP error.
1812 * @param int|string $code
1813 * @param string $label
1814 * @param string $desc
1816 function wfHttpError( $code, $label, $desc ) {
1818 HttpStatus
::header( $code );
1821 $wgOut->sendCacheControl();
1824 MediaWiki\HeaderCallback
::warnIfHeadersSent();
1825 header( 'Content-type: text/html; charset=utf-8' );
1826 print '<!DOCTYPE html>' .
1827 '<html><head><title>' .
1828 htmlspecialchars( $label ) .
1829 '</title></head><body><h1>' .
1830 htmlspecialchars( $label ) .
1832 nl2br( htmlspecialchars( $desc ) ) .
1833 "</p></body></html>\n";
1837 * Clear away any user-level output buffers, discarding contents.
1839 * Suitable for 'starting afresh', for instance when streaming
1840 * relatively large amounts of data without buffering, or wanting to
1841 * output image files without ob_gzhandler's compression.
1843 * The optional $resetGzipEncoding parameter controls suppression of
1844 * the Content-Encoding header sent by ob_gzhandler; by default it
1845 * is left. See comments for wfClearOutputBuffers() for why it would
1848 * Note that some PHP configuration options may add output buffer
1849 * layers which cannot be removed; these are left in place.
1851 * @param bool $resetGzipEncoding
1853 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
1854 if ( $resetGzipEncoding ) {
1855 // Suppress Content-Encoding and Content-Length
1856 // headers from 1.10+s wfOutputHandler
1857 global $wgDisableOutputCompression;
1858 $wgDisableOutputCompression = true;
1860 while ( $status = ob_get_status() ) {
1861 if ( isset( $status['flags'] ) ) {
1862 $flags = PHP_OUTPUT_HANDLER_CLEANABLE | PHP_OUTPUT_HANDLER_REMOVABLE
;
1863 $deleteable = ( $status['flags'] & $flags ) === $flags;
1864 } elseif ( isset( $status['del'] ) ) {
1865 $deleteable = $status['del'];
1867 // Guess that any PHP-internal setting can't be removed.
1868 $deleteable = $status['type'] !== 0; /* PHP_OUTPUT_HANDLER_INTERNAL */
1870 if ( !$deleteable ) {
1871 // Give up, and hope the result doesn't break
1875 if ( $status['name'] === 'MediaWikiTestCase::wfResetOutputBuffersBarrier' ) {
1876 // Unit testing barrier to prevent this function from breaking PHPUnit.
1879 if ( !ob_end_clean() ) {
1880 // Could not remove output buffer handler; abort now
1881 // to avoid getting in some kind of infinite loop.
1884 if ( $resetGzipEncoding ) {
1885 if ( $status['name'] == 'ob_gzhandler' ) {
1886 // Reset the 'Content-Encoding' field set by this handler
1887 // so we can start fresh.
1888 header_remove( 'Content-Encoding' );
1896 * More legible than passing a 'false' parameter to wfResetOutputBuffers():
1898 * Clear away output buffers, but keep the Content-Encoding header
1899 * produced by ob_gzhandler, if any.
1901 * This should be used for HTTP 304 responses, where you need to
1902 * preserve the Content-Encoding header of the real result, but
1903 * also need to suppress the output of ob_gzhandler to keep to spec
1904 * and avoid breaking Firefox in rare cases where the headers and
1905 * body are broken over two packets.
1907 function wfClearOutputBuffers() {
1908 wfResetOutputBuffers( false );
1912 * Converts an Accept-* header into an array mapping string values to quality
1915 * @param string $accept
1916 * @param string $def Default
1917 * @return float[] Associative array of string => float pairs
1919 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
1920 # No arg means accept anything (per HTTP spec)
1922 return [ $def => 1.0 ];
1927 $parts = explode( ',', $accept );
1929 foreach ( $parts as $part ) {
1930 # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
1931 $values = explode( ';', trim( $part ) );
1933 if ( count( $values ) == 1 ) {
1934 $prefs[$values[0]] = 1.0;
1935 } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
1936 $prefs[$values[0]] = floatval( $match[1] );
1944 * Checks if a given MIME type matches any of the keys in the given
1945 * array. Basic wildcards are accepted in the array keys.
1947 * Returns the matching MIME type (or wildcard) if a match, otherwise
1950 * @param string $type
1951 * @param array $avail
1955 function mimeTypeMatch( $type, $avail ) {
1956 if ( array_key_exists( $type, $avail ) ) {
1959 $mainType = explode( '/', $type )[0];
1960 if ( array_key_exists( "$mainType/*", $avail ) ) {
1961 return "$mainType/*";
1962 } elseif ( array_key_exists( '*/*', $avail ) ) {
1971 * Returns the 'best' match between a client's requested internet media types
1972 * and the server's list of available types. Each list should be an associative
1973 * array of type to preference (preference is a float between 0.0 and 1.0).
1974 * Wildcards in the types are acceptable.
1976 * @param array $cprefs Client's acceptable type list
1977 * @param array $sprefs Server's offered types
1980 * @todo FIXME: Doesn't handle params like 'text/plain; charset=UTF-8'
1981 * XXX: generalize to negotiate other stuff
1983 function wfNegotiateType( $cprefs, $sprefs ) {
1986 foreach ( array_keys( $sprefs ) as $type ) {
1987 $subType = explode( '/', $type )[1];
1988 if ( $subType != '*' ) {
1989 $ckey = mimeTypeMatch( $type, $cprefs );
1991 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1996 foreach ( array_keys( $cprefs ) as $type ) {
1997 $subType = explode( '/', $type )[1];
1998 if ( $subType != '*' && !array_key_exists( $type, $sprefs ) ) {
1999 $skey = mimeTypeMatch( $type, $sprefs );
2001 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
2009 foreach ( array_keys( $combine ) as $type ) {
2010 if ( $combine[$type] > $bestq ) {
2012 $bestq = $combine[$type];
2020 * Reference-counted warning suppression
2022 * @deprecated since 1.26, use MediaWiki\suppressWarnings() directly
2025 function wfSuppressWarnings( $end = false ) {
2026 MediaWiki\
suppressWarnings( $end );
2030 * @deprecated since 1.26, use MediaWiki\restoreWarnings() directly
2031 * Restore error level to previous value
2033 function wfRestoreWarnings() {
2034 MediaWiki\
suppressWarnings( true );
2038 * Get a timestamp string in one of various formats
2040 * @param mixed $outputtype A timestamp in one of the supported formats, the
2041 * function will autodetect which format is supplied and act accordingly.
2042 * @param mixed $ts Optional timestamp to convert, default 0 for the current time
2043 * @return string|bool String / false The same date in the format specified in $outputtype or false
2045 function wfTimestamp( $outputtype = TS_UNIX
, $ts = 0 ) {
2046 $ret = MWTimestamp
::convert( $outputtype, $ts );
2047 if ( $ret === false ) {
2048 wfDebug( "wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n" );
2054 * Return a formatted timestamp, or null if input is null.
2055 * For dealing with nullable timestamp columns in the database.
2057 * @param int $outputtype
2061 function wfTimestampOrNull( $outputtype = TS_UNIX
, $ts = null ) {
2062 if ( is_null( $ts ) ) {
2065 return wfTimestamp( $outputtype, $ts );
2070 * Convenience function; returns MediaWiki timestamp for the present time.
2074 function wfTimestampNow() {
2076 return MWTimestamp
::now( TS_MW
);
2080 * Check if the operating system is Windows
2082 * @return bool True if it's Windows, false otherwise.
2084 function wfIsWindows() {
2085 static $isWindows = null;
2086 if ( $isWindows === null ) {
2087 $isWindows = strtoupper( substr( PHP_OS
, 0, 3 ) ) === 'WIN';
2093 * Check if we are running under HHVM
2097 function wfIsHHVM() {
2098 return defined( 'HHVM_VERSION' );
2102 * Tries to get the system directory for temporary files. First
2103 * $wgTmpDirectory is checked, and then the TMPDIR, TMP, and TEMP
2104 * environment variables are then checked in sequence, then
2105 * sys_get_temp_dir(), then upload_tmp_dir from php.ini.
2107 * NOTE: When possible, use instead the tmpfile() function to create
2108 * temporary files to avoid race conditions on file creation, etc.
2112 function wfTempDir() {
2113 global $wgTmpDirectory;
2115 if ( $wgTmpDirectory !== false ) {
2116 return $wgTmpDirectory;
2119 return TempFSFile
::getUsableTempDirectory();
2123 * Make directory, and make all parent directories if they don't exist
2125 * @param string $dir Full path to directory to create
2126 * @param int $mode Chmod value to use, default is $wgDirectoryMode
2127 * @param string $caller Optional caller param for debugging.
2128 * @throws MWException
2131 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2132 global $wgDirectoryMode;
2134 if ( FileBackend
::isStoragePath( $dir ) ) { // sanity
2135 throw new MWException( __FUNCTION__
. " given storage path '$dir'." );
2138 if ( !is_null( $caller ) ) {
2139 wfDebug( "$caller: called wfMkdirParents($dir)\n" );
2142 if ( strval( $dir ) === '' ||
is_dir( $dir ) ) {
2146 $dir = str_replace( [ '\\', '/' ], DIRECTORY_SEPARATOR
, $dir );
2148 if ( is_null( $mode ) ) {
2149 $mode = $wgDirectoryMode;
2152 // Turn off the normal warning, we're doing our own below
2153 MediaWiki\
suppressWarnings();
2154 $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2155 MediaWiki\restoreWarnings
();
2158 // directory may have been created on another request since we last checked
2159 if ( is_dir( $dir ) ) {
2163 // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2164 wfLogWarning( sprintf( "failed to mkdir \"%s\" mode 0%o", $dir, $mode ) );
2170 * Remove a directory and all its content.
2171 * Does not hide error.
2172 * @param string $dir
2174 function wfRecursiveRemoveDir( $dir ) {
2175 wfDebug( __FUNCTION__
. "( $dir )\n" );
2176 // taken from https://secure.php.net/manual/en/function.rmdir.php#98622
2177 if ( is_dir( $dir ) ) {
2178 $objects = scandir( $dir );
2179 foreach ( $objects as $object ) {
2180 if ( $object != "." && $object != ".." ) {
2181 if ( filetype( $dir . '/' . $object ) == "dir" ) {
2182 wfRecursiveRemoveDir( $dir . '/' . $object );
2184 unlink( $dir . '/' . $object );
2194 * @param int $nr The number to format
2195 * @param int $acc The number of digits after the decimal point, default 2
2196 * @param bool $round Whether or not to round the value, default true
2199 function wfPercent( $nr, $acc = 2, $round = true ) {
2200 $ret = sprintf( "%.${acc}f", $nr );
2201 return $round ?
round( $ret, $acc ) . '%' : "$ret%";
2205 * Safety wrapper around ini_get() for boolean settings.
2206 * The values returned from ini_get() are pre-normalized for settings
2207 * set via php.ini or php_flag/php_admin_flag... but *not*
2208 * for those set via php_value/php_admin_value.
2210 * It's fairly common for people to use php_value instead of php_flag,
2211 * which can leave you with an 'off' setting giving a false positive
2212 * for code that just takes the ini_get() return value as a boolean.
2214 * To make things extra interesting, setting via php_value accepts
2215 * "true" and "yes" as true, but php.ini and php_flag consider them false. :)
2216 * Unrecognized values go false... again opposite PHP's own coercion
2217 * from string to bool.
2219 * Luckily, 'properly' set settings will always come back as '0' or '1',
2220 * so we only have to worry about them and the 'improper' settings.
2222 * I frickin' hate PHP... :P
2224 * @param string $setting
2227 function wfIniGetBool( $setting ) {
2228 $val = strtolower( ini_get( $setting ) );
2229 // 'on' and 'true' can't have whitespace around them, but '1' can.
2233 ||
preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2237 * Version of escapeshellarg() that works better on Windows.
2239 * Originally, this fixed the incorrect use of single quotes on Windows
2240 * (https://bugs.php.net/bug.php?id=26285) and the locale problems on Linux in
2241 * PHP 5.2.6+ (bug backported to earlier distro releases of PHP).
2243 * @param string $args,... strings to escape and glue together,
2244 * or a single array of strings parameter
2246 * @deprecated since 1.30 use MediaWiki\Shell::escape()
2248 function wfEscapeShellArg( /*...*/ ) {
2249 $args = func_get_args();
2251 return call_user_func_array( Shell
::class . '::escape', $args );
2255 * Check if wfShellExec() is effectively disabled via php.ini config
2257 * @return bool|string False or 'disabled'
2259 * @deprecated since 1.30 use MediaWiki\Shell::isDisabled()
2261 function wfShellExecDisabled() {
2262 wfDeprecated( __FUNCTION__
, '1.30' );
2263 return Shell
::isDisabled() ?
'disabled' : false;
2267 * Execute a shell command, with time and memory limits mirrored from the PHP
2268 * configuration if supported.
2270 * @param string|string[] $cmd If string, a properly shell-escaped command line,
2271 * or an array of unescaped arguments, in which case each value will be escaped
2272 * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
2273 * @param null|mixed &$retval Optional, will receive the program's exit code.
2274 * (non-zero is usually failure). If there is an error from
2275 * read, select, or proc_open(), this will be set to -1.
2276 * @param array $environ Optional environment variables which should be
2277 * added to the executed command environment.
2278 * @param array $limits Optional array with limits(filesize, memory, time, walltime)
2279 * this overwrites the global wgMaxShell* limits.
2280 * @param array $options Array of options:
2281 * - duplicateStderr: Set this to true to duplicate stderr to stdout,
2282 * including errors from limit.sh
2283 * - profileMethod: By default this function will profile based on the calling
2284 * method. Set this to a string for an alternative method to profile from
2286 * @return string Collected stdout as a string
2287 * @deprecated since 1.30 use class MediaWiki\Shell\Shell
2289 function wfShellExec( $cmd, &$retval = null, $environ = [],
2290 $limits = [], $options = []
2292 if ( Shell
::isDisabled() ) {
2294 // Backwards compatibility be upon us...
2295 return 'Unable to run external programs, proc_open() is disabled.';
2298 if ( is_array( $cmd ) ) {
2299 $cmd = Shell
::escape( $cmd );
2302 $includeStderr = isset( $options['duplicateStderr'] ) && $options['duplicateStderr'];
2303 $profileMethod = isset( $options['profileMethod'] ) ?
$options['profileMethod'] : wfGetCaller();
2306 $result = Shell
::command( [] )
2307 ->unsafeParams( (array)$cmd )
2308 ->environment( $environ )
2310 ->includeStderr( $includeStderr )
2311 ->profileMethod( $profileMethod )
2313 } catch ( ProcOpenError
$ex ) {
2318 $retval = $result->getExitCode();
2320 return $result->getStdout();
2324 * Execute a shell command, returning both stdout and stderr. Convenience
2325 * function, as all the arguments to wfShellExec can become unwieldy.
2327 * @note This also includes errors from limit.sh, e.g. if $wgMaxShellFileSize is exceeded.
2328 * @param string|string[] $cmd If string, a properly shell-escaped command line,
2329 * or an array of unescaped arguments, in which case each value will be escaped
2330 * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
2331 * @param null|mixed &$retval Optional, will receive the program's exit code.
2332 * (non-zero is usually failure)
2333 * @param array $environ Optional environment variables which should be
2334 * added to the executed command environment.
2335 * @param array $limits Optional array with limits(filesize, memory, time, walltime)
2336 * this overwrites the global wgMaxShell* limits.
2337 * @return string Collected stdout and stderr as a string
2338 * @deprecated since 1.30 use class MediaWiki\Shell\Shell
2340 function wfShellExecWithStderr( $cmd, &$retval = null, $environ = [], $limits = [] ) {
2341 return wfShellExec( $cmd, $retval, $environ, $limits,
2342 [ 'duplicateStderr' => true, 'profileMethod' => wfGetCaller() ] );
2346 * Formerly set the locale for locale-sensitive operations
2348 * This is now done in Setup.php.
2350 * @deprecated since 1.30, no longer needed
2351 * @see $wgShellLocale
2353 function wfInitShellLocale() {
2354 wfDeprecated( __FUNCTION__
, '1.30' );
2358 * Generate a shell-escaped command line string to run a MediaWiki cli script.
2359 * Note that $parameters should be a flat array and an option with an argument
2360 * should consist of two consecutive items in the array (do not use "--option value").
2362 * @param string $script MediaWiki cli script path
2363 * @param array $parameters Arguments and options to the script
2364 * @param array $options Associative array of options:
2365 * 'php': The path to the php executable
2366 * 'wrapper': Path to a PHP wrapper to handle the maintenance script
2369 function wfShellWikiCmd( $script, array $parameters = [], array $options = [] ) {
2371 // Give site config file a chance to run the script in a wrapper.
2372 // The caller may likely want to call wfBasename() on $script.
2373 Hooks
::run( 'wfShellWikiCmd', [ &$script, &$parameters, &$options ] );
2374 $cmd = isset( $options['php'] ) ?
[ $options['php'] ] : [ $wgPhpCli ];
2375 if ( isset( $options['wrapper'] ) ) {
2376 $cmd[] = $options['wrapper'];
2379 // Escape each parameter for shell
2380 return Shell
::escape( array_merge( $cmd, $parameters ) );
2384 * wfMerge attempts to merge differences between three texts.
2385 * Returns true for a clean merge and false for failure or a conflict.
2387 * @param string $old
2388 * @param string $mine
2389 * @param string $yours
2390 * @param string &$result
2393 function wfMerge( $old, $mine, $yours, &$result ) {
2396 # This check may also protect against code injection in
2397 # case of broken installations.
2398 MediaWiki\
suppressWarnings();
2399 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
2400 MediaWiki\restoreWarnings
();
2402 if ( !$haveDiff3 ) {
2403 wfDebug( "diff3 not found\n" );
2407 # Make temporary files
2409 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2410 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
2411 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
2413 # NOTE: diff3 issues a warning to stderr if any of the files does not end with
2414 # a newline character. To avoid this, we normalize the trailing whitespace before
2415 # creating the diff.
2417 fwrite( $oldtextFile, rtrim( $old ) . "\n" );
2418 fclose( $oldtextFile );
2419 fwrite( $mytextFile, rtrim( $mine ) . "\n" );
2420 fclose( $mytextFile );
2421 fwrite( $yourtextFile, rtrim( $yours ) . "\n" );
2422 fclose( $yourtextFile );
2424 # Check for a conflict
2425 $cmd = Shell
::escape( $wgDiff3, '-a', '--overlap-only', $mytextName,
2426 $oldtextName, $yourtextName );
2427 $handle = popen( $cmd, 'r' );
2429 if ( fgets( $handle, 1024 ) ) {
2437 $cmd = Shell
::escape( $wgDiff3, '-a', '-e', '--merge', $mytextName,
2438 $oldtextName, $yourtextName );
2439 $handle = popen( $cmd, 'r' );
2442 $data = fread( $handle, 8192 );
2443 if ( strlen( $data ) == 0 ) {
2449 unlink( $mytextName );
2450 unlink( $oldtextName );
2451 unlink( $yourtextName );
2453 if ( $result === '' && $old !== '' && !$conflict ) {
2454 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
2461 * Returns unified plain-text diff of two texts.
2462 * "Useful" for machine processing of diffs.
2464 * @deprecated since 1.25, use DiffEngine/UnifiedDiffFormatter directly
2466 * @param string $before The text before the changes.
2467 * @param string $after The text after the changes.
2468 * @param string $params Command-line options for the diff command.
2469 * @return string Unified diff of $before and $after
2471 function wfDiff( $before, $after, $params = '-u' ) {
2472 if ( $before == $after ) {
2477 MediaWiki\
suppressWarnings();
2478 $haveDiff = $wgDiff && file_exists( $wgDiff );
2479 MediaWiki\restoreWarnings
();
2481 # This check may also protect against code injection in
2482 # case of broken installations.
2484 wfDebug( "diff executable not found\n" );
2485 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
2486 $format = new UnifiedDiffFormatter();
2487 return $format->format( $diffs );
2490 # Make temporary files
2492 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2493 $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
2495 fwrite( $oldtextFile, $before );
2496 fclose( $oldtextFile );
2497 fwrite( $newtextFile, $after );
2498 fclose( $newtextFile );
2500 // Get the diff of the two files
2501 $cmd = "$wgDiff " . $params . ' ' . Shell
::escape( $oldtextName, $newtextName );
2503 $h = popen( $cmd, 'r' );
2505 unlink( $oldtextName );
2506 unlink( $newtextName );
2507 throw new Exception( __METHOD__
. '(): popen() failed' );
2513 $data = fread( $h, 8192 );
2514 if ( strlen( $data ) == 0 ) {
2522 unlink( $oldtextName );
2523 unlink( $newtextName );
2525 // Kill the --- and +++ lines. They're not useful.
2526 $diff_lines = explode( "\n", $diff );
2527 if ( isset( $diff_lines[0] ) && strpos( $diff_lines[0], '---' ) === 0 ) {
2528 unset( $diff_lines[0] );
2530 if ( isset( $diff_lines[1] ) && strpos( $diff_lines[1], '+++' ) === 0 ) {
2531 unset( $diff_lines[1] );
2534 $diff = implode( "\n", $diff_lines );
2540 * This function works like "use VERSION" in Perl, the program will die with a
2541 * backtrace if the current version of PHP is less than the version provided
2543 * This is useful for extensions which due to their nature are not kept in sync
2544 * with releases, and might depend on other versions of PHP than the main code
2546 * Note: PHP might die due to parsing errors in some cases before it ever
2547 * manages to call this function, such is life
2549 * @see perldoc -f use
2551 * @param string|int|float $req_ver The version to check, can be a string, an integer, or a float
2553 * @deprecated since 1.30
2555 * @throws MWException
2557 function wfUsePHP( $req_ver ) {
2558 $php_ver = PHP_VERSION
;
2560 if ( version_compare( $php_ver, (string)$req_ver, '<' ) ) {
2561 throw new MWException( "PHP $req_ver required--this is only $php_ver" );
2566 * This function works like "use VERSION" in Perl except it checks the version
2567 * of MediaWiki, the program will die with a backtrace if the current version
2568 * of MediaWiki is less than the version provided.
2570 * This is useful for extensions which due to their nature are not kept in sync
2573 * Note: Due to the behavior of PHP's version_compare() which is used in this
2574 * function, if you want to allow the 'wmf' development versions add a 'c' (or
2575 * any single letter other than 'a', 'b' or 'p') as a post-fix to your
2576 * targeted version number. For example if you wanted to allow any variation
2577 * of 1.22 use `wfUseMW( '1.22c' )`. Using an 'a' or 'b' instead of 'c' will
2578 * not result in the same comparison due to the internal logic of
2579 * version_compare().
2581 * @see perldoc -f use
2583 * @deprecated since 1.26, use the "requires" property of extension.json
2584 * @param string|int|float $req_ver The version to check, can be a string, an integer, or a float
2585 * @throws MWException
2587 function wfUseMW( $req_ver ) {
2590 if ( version_compare( $wgVersion, (string)$req_ver, '<' ) ) {
2591 throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
2596 * Return the final portion of a pathname.
2597 * Reimplemented because PHP5's "basename()" is buggy with multibyte text.
2598 * https://bugs.php.net/bug.php?id=33898
2600 * PHP's basename() only considers '\' a pathchar on Windows and Netware.
2601 * We'll consider it so always, as we don't want '\s' in our Unix paths either.
2603 * @param string $path
2604 * @param string $suffix String to remove if present
2607 function wfBaseName( $path, $suffix = '' ) {
2608 if ( $suffix == '' ) {
2611 $encSuffix = '(?:' . preg_quote( $suffix, '#' ) . ')?';
2615 if ( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
2623 * Generate a relative path name to the given file.
2624 * May explode on non-matching case-insensitive paths,
2625 * funky symlinks, etc.
2627 * @param string $path Absolute destination path including target filename
2628 * @param string $from Absolute source path, directory only
2631 function wfRelativePath( $path, $from ) {
2632 // Normalize mixed input on Windows...
2633 $path = str_replace( '/', DIRECTORY_SEPARATOR
, $path );
2634 $from = str_replace( '/', DIRECTORY_SEPARATOR
, $from );
2636 // Trim trailing slashes -- fix for drive root
2637 $path = rtrim( $path, DIRECTORY_SEPARATOR
);
2638 $from = rtrim( $from, DIRECTORY_SEPARATOR
);
2640 $pieces = explode( DIRECTORY_SEPARATOR
, dirname( $path ) );
2641 $against = explode( DIRECTORY_SEPARATOR
, $from );
2643 if ( $pieces[0] !== $against[0] ) {
2644 // Non-matching Windows drive letters?
2645 // Return a full path.
2649 // Trim off common prefix
2650 while ( count( $pieces ) && count( $against )
2651 && $pieces[0] == $against[0] ) {
2652 array_shift( $pieces );
2653 array_shift( $against );
2656 // relative dots to bump us to the parent
2657 while ( count( $against ) ) {
2658 array_unshift( $pieces, '..' );
2659 array_shift( $against );
2662 array_push( $pieces, wfBaseName( $path ) );
2664 return implode( DIRECTORY_SEPARATOR
, $pieces );
2668 * Convert an arbitrarily-long digit string from one numeric base
2669 * to another, optionally zero-padding to a minimum column width.
2671 * Supports base 2 through 36; digit values 10-36 are represented
2672 * as lowercase letters a-z. Input is case-insensitive.
2674 * @deprecated since 1.27 Use Wikimedia\base_convert() directly
2676 * @param string $input Input number
2677 * @param int $sourceBase Base of the input number
2678 * @param int $destBase Desired base of the output
2679 * @param int $pad Minimum number of digits in the output (pad with zeroes)
2680 * @param bool $lowercase Whether to output in lowercase or uppercase
2681 * @param string $engine Either "gmp", "bcmath", or "php"
2682 * @return string|bool The output number as a string, or false on error
2684 function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1,
2685 $lowercase = true, $engine = 'auto'
2687 wfDeprecated( __FUNCTION__
, '1.27' );
2688 return Wikimedia\base_convert
( $input, $sourceBase, $destBase, $pad, $lowercase, $engine );
2692 * Reset the session id
2694 * @deprecated since 1.27, use MediaWiki\Session\SessionManager instead
2697 function wfResetSessionID() {
2698 wfDeprecated( __FUNCTION__
, '1.27' );
2699 $session = SessionManager
::getGlobalSession();
2700 $delay = $session->delaySave();
2702 $session->resetId();
2704 // Make sure a session is started, since that's what the old
2705 // wfResetSessionID() did.
2706 if ( session_id() !== $session->getId() ) {
2707 wfSetupSession( $session->getId() );
2710 ScopedCallback
::consume( $delay );
2714 * Initialise php session
2716 * @deprecated since 1.27, use MediaWiki\Session\SessionManager instead.
2717 * Generally, "using" SessionManager will be calling ->getSessionById() or
2718 * ::getGlobalSession() (depending on whether you were passing $sessionId
2719 * here), then calling $session->persist().
2720 * @param bool|string $sessionId
2722 function wfSetupSession( $sessionId = false ) {
2723 wfDeprecated( __FUNCTION__
, '1.27' );
2726 session_id( $sessionId );
2729 $session = SessionManager
::getGlobalSession();
2730 $session->persist();
2732 if ( session_id() !== $session->getId() ) {
2733 session_id( $session->getId() );
2735 MediaWiki\
quietCall( 'session_start' );
2739 * Get an object from the precompiled serialized directory
2741 * @param string $name
2742 * @return mixed The variable on success, false on failure
2744 function wfGetPrecompiledData( $name ) {
2747 $file = "$IP/serialized/$name";
2748 if ( file_exists( $file ) ) {
2749 $blob = file_get_contents( $file );
2751 return unserialize( $blob );
2758 * Make a cache key for the local wiki.
2760 * @deprecated since 1.30 Call makeKey on a BagOStuff instance
2761 * @param string $args,...
2764 function wfMemcKey( /*...*/ ) {
2765 return call_user_func_array(
2766 [ ObjectCache
::getLocalClusterInstance(), 'makeKey' ],
2772 * Make a cache key for a foreign DB.
2774 * Must match what wfMemcKey() would produce in context of the foreign wiki.
2777 * @param string $prefix
2778 * @param string $args,...
2781 function wfForeignMemcKey( $db, $prefix /*...*/ ) {
2782 $args = array_slice( func_get_args(), 2 );
2783 $keyspace = $prefix ?
"$db-$prefix" : $db;
2784 return call_user_func_array(
2785 [ ObjectCache
::getLocalClusterInstance(), 'makeKeyInternal' ],
2786 [ $keyspace, $args ]
2791 * Make a cache key with database-agnostic prefix.
2793 * Doesn't have a wiki-specific namespace. Uses a generic 'global' prefix
2794 * instead. Must have a prefix as otherwise keys that use a database name
2795 * in the first segment will clash with wfMemcKey/wfForeignMemcKey.
2797 * @deprecated since 1.30 Call makeGlobalKey on a BagOStuff instance
2799 * @param string $args,...
2802 function wfGlobalCacheKey( /*...*/ ) {
2803 return call_user_func_array(
2804 [ ObjectCache
::getLocalClusterInstance(), 'makeGlobalKey' ],
2810 * Get an ASCII string identifying this wiki
2811 * This is used as a prefix in memcached keys
2815 function wfWikiID() {
2816 global $wgDBprefix, $wgDBname;
2817 if ( $wgDBprefix ) {
2818 return "$wgDBname-$wgDBprefix";
2825 * Split a wiki ID into DB name and table prefix
2827 * @param string $wiki
2831 function wfSplitWikiID( $wiki ) {
2832 $bits = explode( '-', $wiki, 2 );
2833 if ( count( $bits ) < 2 ) {
2840 * Get a Database object.
2842 * @param int $db Index of the connection to get. May be DB_MASTER for the
2843 * master (for write queries), DB_REPLICA for potentially lagged read
2844 * queries, or an integer >= 0 for a particular server.
2846 * @param string|string[] $groups Query groups. An array of group names that this query
2847 * belongs to. May contain a single string if the query is only
2850 * @param string|bool $wiki The wiki ID, or false for the current wiki
2852 * Note: multiple calls to wfGetDB(DB_REPLICA) during the course of one request
2853 * will always return the same object, unless the underlying connection or load
2854 * balancer is manually destroyed.
2856 * Note 2: use $this->getDB() in maintenance scripts that may be invoked by
2857 * updater to ensure that a proper database is being updated.
2859 * @todo Replace calls to wfGetDB with calls to LoadBalancer::getConnection()
2860 * on an injected instance of LoadBalancer.
2862 * @return \Wikimedia\Rdbms\Database
2864 function wfGetDB( $db, $groups = [], $wiki = false ) {
2865 return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
2869 * Get a load balancer object.
2871 * @deprecated since 1.27, use MediaWikiServices::getDBLoadBalancer()
2872 * or MediaWikiServices::getDBLoadBalancerFactory() instead.
2874 * @param string|bool $wiki Wiki ID, or false for the current wiki
2875 * @return \Wikimedia\Rdbms\LoadBalancer
2877 function wfGetLB( $wiki = false ) {
2878 if ( $wiki === false ) {
2879 return MediaWikiServices
::getInstance()->getDBLoadBalancer();
2881 $factory = MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
2882 return $factory->getMainLB( $wiki );
2887 * Get the load balancer factory object
2889 * @deprecated since 1.27, use MediaWikiServices::getDBLoadBalancerFactory() instead.
2891 * @return \Wikimedia\Rdbms\LBFactory
2893 function wfGetLBFactory() {
2894 return MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
2899 * Shortcut for RepoGroup::singleton()->findFile()
2901 * @param string $title String or Title object
2902 * @param array $options Associative array of options (see RepoGroup::findFile)
2903 * @return File|bool File, or false if the file does not exist
2905 function wfFindFile( $title, $options = [] ) {
2906 return RepoGroup
::singleton()->findFile( $title, $options );
2910 * Get an object referring to a locally registered file.
2911 * Returns a valid placeholder object if the file does not exist.
2913 * @param Title|string $title
2914 * @return LocalFile|null A File, or null if passed an invalid Title
2916 function wfLocalFile( $title ) {
2917 return RepoGroup
::singleton()->getLocalRepo()->newFile( $title );
2921 * Should low-performance queries be disabled?
2924 * @codeCoverageIgnore
2926 function wfQueriesMustScale() {
2927 global $wgMiserMode;
2929 ||
( SiteStats
::pages() > 100000
2930 && SiteStats
::edits() > 1000000
2931 && SiteStats
::users() > 10000 );
2935 * Get the path to a specified script file, respecting file
2936 * extensions; this is a wrapper around $wgScriptPath etc.
2937 * except for 'index' and 'load' which use $wgScript/$wgLoadScript
2939 * @param string $script Script filename, sans extension
2942 function wfScript( $script = 'index' ) {
2943 global $wgScriptPath, $wgScript, $wgLoadScript;
2944 if ( $script === 'index' ) {
2946 } elseif ( $script === 'load' ) {
2947 return $wgLoadScript;
2949 return "{$wgScriptPath}/{$script}.php";
2954 * Get the script URL.
2956 * @return string Script URL
2958 function wfGetScriptUrl() {
2959 if ( isset( $_SERVER['SCRIPT_NAME'] ) ) {
2960 /* as it was called, minus the query string.
2962 * Some sites use Apache rewrite rules to handle subdomains,
2963 * and have PHP set up in a weird way that causes PHP_SELF
2964 * to contain the rewritten URL instead of the one that the
2965 * outside world sees.
2967 * If in this mode, use SCRIPT_URL instead, which mod_rewrite
2968 * provides containing the "before" URL.
2970 return $_SERVER['SCRIPT_NAME'];
2972 return $_SERVER['URL'];
2977 * Convenience function converts boolean values into "true"
2978 * or "false" (string) values
2980 * @param bool $value
2983 function wfBoolToStr( $value ) {
2984 return $value ?
'true' : 'false';
2988 * Get a platform-independent path to the null file, e.g. /dev/null
2992 function wfGetNull() {
2993 return wfIsWindows() ?
'NUL' : '/dev/null';
2997 * Waits for the replica DBs to catch up to the master position
2999 * Use this when updating very large numbers of rows, as in maintenance scripts,
3000 * to avoid causing too much lag. Of course, this is a no-op if there are no replica DBs.
3002 * By default this waits on the main DB cluster of the current wiki.
3003 * If $cluster is set to "*" it will wait on all DB clusters, including
3004 * external ones. If the lag being waiting on is caused by the code that
3005 * does this check, it makes since to use $ifWritesSince, particularly if
3006 * cluster is "*", to avoid excess overhead.
3008 * Never call this function after a big DB write that is still in a transaction.
3009 * This only makes sense after the possible lag inducing changes were committed.
3011 * @param float|null $ifWritesSince Only wait if writes were done since this UNIX timestamp
3012 * @param string|bool $wiki Wiki identifier accepted by wfGetLB
3013 * @param string|bool $cluster Cluster name accepted by LBFactory. Default: false.
3014 * @param int|null $timeout Max wait time. Default: 1 day (cli), ~10 seconds (web)
3015 * @return bool Success (able to connect and no timeouts reached)
3016 * @deprecated since 1.27 Use LBFactory::waitForReplication
3018 function wfWaitForSlaves(
3019 $ifWritesSince = null, $wiki = false, $cluster = false, $timeout = null
3021 if ( $timeout === null ) {
3022 $timeout = ( PHP_SAPI
=== 'cli' ) ?
86400 : 10;
3025 if ( $cluster === '*' ) {
3028 } elseif ( $wiki === false ) {
3033 wfGetLBFactory()->waitForReplication( [
3035 'cluster' => $cluster,
3036 'timeout' => $timeout,
3037 // B/C: first argument used to be "max seconds of lag"; ignore such values
3038 'ifWritesSince' => ( $ifWritesSince > 1e9
) ?
$ifWritesSince : null
3040 } catch ( DBReplicationWaitError
$e ) {
3048 * Count down from $seconds to zero on the terminal, with a one-second pause
3049 * between showing each number. For use in command-line scripts.
3051 * @codeCoverageIgnore
3052 * @param int $seconds
3054 function wfCountDown( $seconds ) {
3055 for ( $i = $seconds; $i >= 0; $i-- ) {
3056 if ( $i != $seconds ) {
3057 echo str_repeat( "\x08", strlen( $i +
1 ) );
3069 * Replace all invalid characters with '-'.
3070 * Additional characters can be defined in $wgIllegalFileChars (see T22489).
3071 * By default, $wgIllegalFileChars includes ':', '/', '\'.
3073 * @param string $name Filename to process
3076 function wfStripIllegalFilenameChars( $name ) {
3077 global $wgIllegalFileChars;
3078 $illegalFileChars = $wgIllegalFileChars ?
"|[" . $wgIllegalFileChars . "]" : '';
3079 $name = preg_replace(
3080 "/[^" . Title
::legalChars() . "]" . $illegalFileChars . "/",
3084 // $wgIllegalFileChars may not include '/' and '\', so we still need to do this
3085 $name = wfBaseName( $name );
3090 * Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit
3092 * @return int Resulting value of the memory limit.
3094 function wfMemoryLimit() {
3095 global $wgMemoryLimit;
3096 $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
3097 if ( $memlimit != -1 ) {
3098 $conflimit = wfShorthandToInteger( $wgMemoryLimit );
3099 if ( $conflimit == -1 ) {
3100 wfDebug( "Removing PHP's memory limit\n" );
3101 MediaWiki\
suppressWarnings();
3102 ini_set( 'memory_limit', $conflimit );
3103 MediaWiki\restoreWarnings
();
3105 } elseif ( $conflimit > $memlimit ) {
3106 wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
3107 MediaWiki\
suppressWarnings();
3108 ini_set( 'memory_limit', $conflimit );
3109 MediaWiki\restoreWarnings
();
3117 * Set PHP's time limit to the larger of php.ini or $wgTransactionalTimeLimit
3119 * @return int Prior time limit
3122 function wfTransactionalTimeLimit() {
3123 global $wgTransactionalTimeLimit;
3125 $timeLimit = ini_get( 'max_execution_time' );
3126 // Note that CLI scripts use 0
3127 if ( $timeLimit > 0 && $wgTransactionalTimeLimit > $timeLimit ) {
3128 set_time_limit( $wgTransactionalTimeLimit );
3131 ignore_user_abort( true ); // ignore client disconnects
3137 * Converts shorthand byte notation to integer form
3139 * @param string $string
3140 * @param int $default Returned if $string is empty
3143 function wfShorthandToInteger( $string = '', $default = -1 ) {
3144 $string = trim( $string );
3145 if ( $string === '' ) {
3148 $last = $string[strlen( $string ) - 1];
3149 $val = intval( $string );
3154 // break intentionally missing
3158 // break intentionally missing
3168 * Get the normalised IETF language tag
3169 * See unit test for examples.
3170 * See mediawiki.language.bcp47 for the JavaScript implementation.
3172 * @deprecated since 1.31, use LanguageCode::bcp47() directly.
3174 * @param string $code The language code.
3175 * @return string The language code which complying with BCP 47 standards.
3177 function wfBCP47( $code ) {
3178 return LanguageCode
::bcp47( $code );
3182 * Get a specific cache object.
3184 * @param int|string $cacheType A CACHE_* constants, or other key in $wgObjectCaches
3187 function wfGetCache( $cacheType ) {
3188 return ObjectCache
::getInstance( $cacheType );
3192 * Get the main cache object
3196 function wfGetMainCache() {
3197 global $wgMainCacheType;
3198 return ObjectCache
::getInstance( $wgMainCacheType );
3202 * Get the cache object used by the message cache
3206 function wfGetMessageCacheStorage() {
3207 global $wgMessageCacheType;
3208 return ObjectCache
::getInstance( $wgMessageCacheType );
3212 * Get the cache object used by the parser cache
3214 * @deprecated since 1.30, use MediaWikiServices::getParserCache()->getCacheStorage()
3217 function wfGetParserCacheStorage() {
3218 global $wgParserCacheType;
3219 return ObjectCache
::getInstance( $wgParserCacheType );
3223 * Call hook functions defined in $wgHooks
3225 * @param string $event Event name
3226 * @param array $args Parameters passed to hook functions
3227 * @param string|null $deprecatedVersion Optionally mark hook as deprecated with version number
3229 * @return bool True if no handler aborted the hook
3230 * @deprecated since 1.25 - use Hooks::run
3232 function wfRunHooks( $event, array $args = [], $deprecatedVersion = null ) {
3233 return Hooks
::run( $event, $args, $deprecatedVersion );
3237 * Wrapper around php's unpack.
3239 * @param string $format The format string (See php's docs)
3240 * @param string $data A binary string of binary data
3241 * @param int|bool $length The minimum length of $data or false. This is to
3242 * prevent reading beyond the end of $data. false to disable the check.
3244 * Also be careful when using this function to read unsigned 32 bit integer
3245 * because php might make it negative.
3247 * @throws MWException If $data not long enough, or if unpack fails
3248 * @return array Associative array of the extracted data
3250 function wfUnpack( $format, $data, $length = false ) {
3251 if ( $length !== false ) {
3252 $realLen = strlen( $data );
3253 if ( $realLen < $length ) {
3254 throw new MWException( "Tried to use wfUnpack on a "
3255 . "string of length $realLen, but needed one "
3256 . "of at least length $length."
3261 MediaWiki\
suppressWarnings();
3262 $result = unpack( $format, $data );
3263 MediaWiki\restoreWarnings
();
3265 if ( $result === false ) {
3266 // If it cannot extract the packed data.
3267 throw new MWException( "unpack could not unpack binary data" );
3273 * Determine if an image exists on the 'bad image list'.
3275 * The format of MediaWiki:Bad_image_list is as follows:
3276 * * Only list items (lines starting with "*") are considered
3277 * * The first link on a line must be a link to a bad image
3278 * * Any subsequent links on the same line are considered to be exceptions,
3279 * i.e. articles where the image may occur inline.
3281 * @param string $name The image name to check
3282 * @param Title|bool $contextTitle The page on which the image occurs, if known
3283 * @param string $blacklist Wikitext of a file blacklist
3286 function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
3287 # Handle redirects; callers almost always hit wfFindFile() anyway,
3288 # so just use that method because it has a fast process cache.
3289 $file = wfFindFile( $name ); // get the final name
3290 $name = $file ?
$file->getTitle()->getDBkey() : $name;
3292 # Run the extension hook
3294 if ( !Hooks
::run( 'BadImage', [ $name, &$bad ] ) ) {
3298 $cache = ObjectCache
::getLocalServerInstance( 'hash' );
3299 $key = $cache->makeKey(
3300 'bad-image-list', ( $blacklist === null ) ?
'default' : md5( $blacklist )
3302 $badImages = $cache->get( $key );
3304 if ( $badImages === false ) { // cache miss
3305 if ( $blacklist === null ) {
3306 $blacklist = wfMessage( 'bad_image_list' )->inContentLanguage()->plain(); // site list
3308 # Build the list now
3310 $lines = explode( "\n", $blacklist );
3311 foreach ( $lines as $line ) {
3313 if ( substr( $line, 0, 1 ) !== '*' ) {
3319 if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
3324 $imageDBkey = false;
3325 foreach ( $m[1] as $i => $titleText ) {
3326 $title = Title
::newFromText( $titleText );
3327 if ( !is_null( $title ) ) {
3329 $imageDBkey = $title->getDBkey();
3331 $exceptions[$title->getPrefixedDBkey()] = true;
3336 if ( $imageDBkey !== false ) {
3337 $badImages[$imageDBkey] = $exceptions;
3340 $cache->set( $key, $badImages, 60 );
3343 $contextKey = $contextTitle ?
$contextTitle->getPrefixedDBkey() : false;
3344 $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
3350 * Determine whether the client at a given source IP is likely to be able to
3351 * access the wiki via HTTPS.
3353 * @param string $ip The IPv4/6 address in the normal human-readable form
3356 function wfCanIPUseHTTPS( $ip ) {
3358 Hooks
::run( 'CanIPUseHTTPS', [ $ip, &$canDo ] );
3363 * Determine input string is represents as infinity
3365 * @param string $str The string to determine
3369 function wfIsInfinity( $str ) {
3370 // These are hardcoded elsewhere in MediaWiki (e.g. mediawiki.special.block.js).
3371 $infinityValues = [ 'infinite', 'indefinite', 'infinity', 'never' ];
3372 return in_array( $str, $infinityValues );
3376 * Returns true if these thumbnail parameters match one that MediaWiki
3377 * requests from file description pages and/or parser output.
3379 * $params is considered non-standard if they involve a non-standard
3380 * width or any non-default parameters aside from width and page number.
3381 * The number of possible files with standard parameters is far less than
3382 * that of all combinations; rate-limiting for them can thus be more generious.
3385 * @param array $params
3387 * @since 1.24 Moved from thumb.php to GlobalFunctions in 1.25
3389 function wfThumbIsStandard( File
$file, array $params ) {
3390 global $wgThumbLimits, $wgImageLimits, $wgResponsiveImages;
3392 $multipliers = [ 1 ];
3393 if ( $wgResponsiveImages ) {
3394 // These available sizes are hardcoded currently elsewhere in MediaWiki.
3395 // @see Linker::processResponsiveImages
3396 $multipliers[] = 1.5;
3400 $handler = $file->getHandler();
3401 if ( !$handler ||
!isset( $params['width'] ) ) {
3406 if ( isset( $params['page'] ) ) {
3407 $basicParams['page'] = $params['page'];
3412 // Expand limits to account for multipliers
3413 foreach ( $multipliers as $multiplier ) {
3414 $thumbLimits = array_merge( $thumbLimits, array_map(
3415 function ( $width ) use ( $multiplier ) {
3416 return round( $width * $multiplier );
3419 $imageLimits = array_merge( $imageLimits, array_map(
3420 function ( $pair ) use ( $multiplier ) {
3422 round( $pair[0] * $multiplier ),
3423 round( $pair[1] * $multiplier ),
3429 // Check if the width matches one of $wgThumbLimits
3430 if ( in_array( $params['width'], $thumbLimits ) ) {
3431 $normalParams = $basicParams +
[ 'width' => $params['width'] ];
3432 // Append any default values to the map (e.g. "lossy", "lossless", ...)
3433 $handler->normaliseParams( $file, $normalParams );
3435 // If not, then check if the width matchs one of $wgImageLimits
3437 foreach ( $imageLimits as $pair ) {
3438 $normalParams = $basicParams +
[ 'width' => $pair[0], 'height' => $pair[1] ];
3439 // Decide whether the thumbnail should be scaled on width or height.
3440 // Also append any default values to the map (e.g. "lossy", "lossless", ...)
3441 $handler->normaliseParams( $file, $normalParams );
3442 // Check if this standard thumbnail size maps to the given width
3443 if ( $normalParams['width'] == $params['width'] ) {
3449 return false; // not standard for description pages
3453 // Check that the given values for non-page, non-width, params are just defaults
3454 foreach ( $params as $key => $value ) {
3455 if ( !isset( $normalParams[$key] ) ||
$normalParams[$key] != $value ) {
3464 * Merges two (possibly) 2 dimensional arrays into the target array ($baseArray).
3466 * Values that exist in both values will be combined with += (all values of the array
3467 * of $newValues will be added to the values of the array of $baseArray, while values,
3468 * that exists in both, the value of $baseArray will be used).
3470 * @param array $baseArray The array where you want to add the values of $newValues to
3471 * @param array $newValues An array with new values
3472 * @return array The combined array
3475 function wfArrayPlus2d( array $baseArray, array $newValues ) {
3476 // First merge items that are in both arrays
3477 foreach ( $baseArray as $name => &$groupVal ) {
3478 if ( isset( $newValues[$name] ) ) {
3479 $groupVal +
= $newValues[$name];
3482 // Now add items that didn't exist yet
3483 $baseArray +
= $newValues;