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\Session\SessionManager
;
30 use Wikimedia\ScopedCallback
;
31 use Wikimedia\Rdbms\LBFactory
;
33 // Hide compatibility functions from Doxygen
36 * Compatibility functions
38 * We support PHP 5.5.9 and up.
39 * Re-implementations of newer functions or functions in non-standard
40 * PHP extensions may be included here.
43 // hash_equals function only exists in PHP >= 5.6.0
44 // https://secure.php.net/hash_equals
45 if ( !function_exists( 'hash_equals' ) ) {
47 * Check whether a user-provided string is equal to a fixed-length secret string
48 * without revealing bytes of the secret string through timing differences.
50 * The usual way to compare strings (PHP's === operator or the underlying memcmp()
51 * function in C) is to compare corresponding bytes and stop at the first difference,
52 * which would take longer for a partial match than for a complete mismatch. This
53 * is not secure when one of the strings (e.g. an HMAC or token) must remain secret
54 * and the other may come from an attacker. Statistical analysis of timing measurements
55 * over many requests may allow the attacker to guess the string's bytes one at a time
56 * (and check his guesses) even if the timing differences are extremely small.
58 * When making such a security-sensitive comparison, it is essential that the sequence
59 * in which instructions are executed and memory locations are accessed not depend on
60 * the secret string's value. HOWEVER, for simplicity, we do not attempt to minimize
61 * the inevitable leakage of the string's length. That is generally known anyway as
62 * a chararacteristic of the hash function used to compute the secret value.
64 * Longer explanation: http://www.emerose.com/timing-attacks-explained
67 * @param string $known_string Fixed-length secret string to compare against
68 * @param string $user_string User-provided string
69 * @return bool True if the strings are the same, false otherwise
71 function hash_equals( $known_string, $user_string ) {
72 // Strict type checking as in PHP's native implementation
73 if ( !is_string( $known_string ) ) {
74 trigger_error( 'hash_equals(): Expected known_string to be a string, ' .
75 gettype( $known_string ) . ' given', E_USER_WARNING
);
80 if ( !is_string( $user_string ) ) {
81 trigger_error( 'hash_equals(): Expected user_string to be a string, ' .
82 gettype( $user_string ) . ' given', E_USER_WARNING
);
87 $known_string_len = strlen( $known_string );
88 if ( $known_string_len !== strlen( $user_string ) ) {
93 for ( $i = 0; $i < $known_string_len; $i++
) {
94 $result |
= ord( $known_string[$i] ) ^
ord( $user_string[$i] );
97 return ( $result === 0 );
105 * This queues an extension to be loaded through
106 * the ExtensionRegistry system.
108 * @param string $ext Name of the extension to load
109 * @param string|null $path Absolute path of where to find the extension.json file
112 function wfLoadExtension( $ext, $path = null ) {
114 global $wgExtensionDirectory;
115 $path = "$wgExtensionDirectory/$ext/extension.json";
117 ExtensionRegistry
::getInstance()->queue( $path );
121 * Load multiple extensions at once
123 * Same as wfLoadExtension, but more efficient if you
124 * are loading multiple extensions.
126 * If you want to specify custom paths, you should interact with
127 * ExtensionRegistry directly.
129 * @see wfLoadExtension
130 * @param string[] $exts Array of extension names to load
133 function wfLoadExtensions( array $exts ) {
134 global $wgExtensionDirectory;
135 $registry = ExtensionRegistry
::getInstance();
136 foreach ( $exts as $ext ) {
137 $registry->queue( "$wgExtensionDirectory/$ext/extension.json" );
144 * @see wfLoadExtension
145 * @param string $skin Name of the extension to load
146 * @param string|null $path Absolute path of where to find the skin.json file
149 function wfLoadSkin( $skin, $path = null ) {
151 global $wgStyleDirectory;
152 $path = "$wgStyleDirectory/$skin/skin.json";
154 ExtensionRegistry
::getInstance()->queue( $path );
158 * Load multiple skins at once
160 * @see wfLoadExtensions
161 * @param string[] $skins Array of extension names to load
164 function wfLoadSkins( array $skins ) {
165 global $wgStyleDirectory;
166 $registry = ExtensionRegistry
::getInstance();
167 foreach ( $skins as $skin ) {
168 $registry->queue( "$wgStyleDirectory/$skin/skin.json" );
173 * Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
178 function wfArrayDiff2( $a, $b ) {
179 return array_udiff( $a, $b, 'wfArrayDiff2_cmp' );
183 * @param array|string $a
184 * @param array|string $b
187 function wfArrayDiff2_cmp( $a, $b ) {
188 if ( is_string( $a ) && is_string( $b ) ) {
189 return strcmp( $a, $b );
190 } elseif ( count( $a ) !== count( $b ) ) {
191 return count( $a ) < count( $b ) ?
-1 : 1;
195 while ( ( list( , $valueA ) = each( $a ) ) && ( list( , $valueB ) = each( $b ) ) ) {
196 $cmp = strcmp( $valueA, $valueB );
206 * Appends to second array if $value differs from that in $default
208 * @param string|int $key
209 * @param mixed $value
210 * @param mixed $default
211 * @param array $changed Array to alter
212 * @throws MWException
214 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
215 if ( is_null( $changed ) ) {
216 throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' );
218 if ( $default[$key] !== $value ) {
219 $changed[$key] = $value;
224 * Merge arrays in the style of getUserPermissionsErrors, with duplicate removal
226 * wfMergeErrorArrays(
239 * @param array $array1,...
242 function wfMergeErrorArrays( /*...*/ ) {
243 $args = func_get_args();
245 foreach ( $args as $errors ) {
246 foreach ( $errors as $params ) {
247 $originalParams = $params;
248 if ( $params[0] instanceof MessageSpecifier
) {
250 $params = array_merge( [ $msg->getKey() ], $msg->getParams() );
252 # @todo FIXME: Sometimes get nested arrays for $params,
253 # which leads to E_NOTICEs
254 $spec = implode( "\t", $params );
255 $out[$spec] = $originalParams;
258 return array_values( $out );
262 * Insert array into another array after the specified *KEY*
264 * @param array $array The array.
265 * @param array $insert The array to insert.
266 * @param mixed $after The key to insert after
269 function wfArrayInsertAfter( array $array, array $insert, $after ) {
270 // Find the offset of the element to insert after.
271 $keys = array_keys( $array );
272 $offsetByKey = array_flip( $keys );
274 $offset = $offsetByKey[$after];
276 // Insert at the specified offset
277 $before = array_slice( $array, 0, $offset +
1, true );
278 $after = array_slice( $array, $offset +
1, count( $array ) - $offset, true );
280 $output = $before +
$insert +
$after;
286 * Recursively converts the parameter (an object) to an array with the same data
288 * @param object|array $objOrArray
289 * @param bool $recursive
292 function wfObjectToArray( $objOrArray, $recursive = true ) {
294 if ( is_object( $objOrArray ) ) {
295 $objOrArray = get_object_vars( $objOrArray );
297 foreach ( $objOrArray as $key => $value ) {
298 if ( $recursive && ( is_object( $value ) ||
is_array( $value ) ) ) {
299 $value = wfObjectToArray( $value );
302 $array[$key] = $value;
309 * Get a random decimal value between 0 and 1, in a way
310 * not likely to give duplicate values for any realistic
311 * number of articles.
313 * @note This is designed for use in relation to Special:RandomPage
314 * and the page_random database field.
318 function wfRandom() {
319 // The maximum random value is "only" 2^31-1, so get two random
320 // values to reduce the chance of dupes
321 $max = mt_getrandmax() +
1;
322 $rand = number_format( ( mt_rand() * $max +
mt_rand() ) / $max / $max, 12, '.', '' );
327 * Get a random string containing a number of pseudo-random hex characters.
329 * @note This is not secure, if you are trying to generate some sort
330 * of token please use MWCryptRand instead.
332 * @param int $length The length of the string to generate
336 function wfRandomString( $length = 32 ) {
338 for ( $n = 0; $n < $length; $n +
= 7 ) {
339 $str .= sprintf( '%07x', mt_rand() & 0xfffffff );
341 return substr( $str, 0, $length );
345 * We want some things to be included as literal characters in our title URLs
346 * for prettiness, which urlencode encodes by default. According to RFC 1738,
347 * all of the following should be safe:
351 * RFC 1738 says ~ is unsafe, however RFC 3986 considers it an unreserved
352 * character which should not be encoded. More importantly, google chrome
353 * always converts %7E back to ~, and converting it in this function can
354 * cause a redirect loop (T105265).
356 * But + is not safe because it's used to indicate a space; &= are only safe in
357 * paths and not in queries (and we don't distinguish here); ' seems kind of
358 * scary; and urlencode() doesn't touch -_. to begin with. Plus, although /
359 * is reserved, we don't care. So the list we unescape is:
363 * However, IIS7 redirects fail when the url contains a colon (see T24709),
364 * so no fancy : for IIS7.
366 * %2F in the page titles seems to fatally break for some reason.
371 function wfUrlencode( $s ) {
374 if ( is_null( $s ) ) {
379 if ( is_null( $needle ) ) {
380 $needle = [ '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F', '%7E' ];
381 if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) ||
382 ( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false )
388 $s = urlencode( $s );
391 [ ';', '@', '$', '!', '*', '(', ')', ',', '/', '~', ':' ],
399 * This function takes one or two arrays as input, and returns a CGI-style string, e.g.
400 * "days=7&limit=100". Options in the first array override options in the second.
401 * Options set to null or false will not be output.
403 * @param array $array1 ( String|Array )
404 * @param array|null $array2 ( String|Array )
405 * @param string $prefix
408 function wfArrayToCgi( $array1, $array2 = null, $prefix = '' ) {
409 if ( !is_null( $array2 ) ) {
410 $array1 = $array1 +
$array2;
414 foreach ( $array1 as $key => $value ) {
415 if ( !is_null( $value ) && $value !== false ) {
419 if ( $prefix !== '' ) {
420 $key = $prefix . "[$key]";
422 if ( is_array( $value ) ) {
424 foreach ( $value as $k => $v ) {
425 $cgi .= $firstTime ?
'' : '&';
426 if ( is_array( $v ) ) {
427 $cgi .= wfArrayToCgi( $v, null, $key . "[$k]" );
429 $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v );
434 if ( is_object( $value ) ) {
435 $value = $value->__toString();
437 $cgi .= urlencode( $key ) . '=' . urlencode( $value );
445 * This is the logical opposite of wfArrayToCgi(): it accepts a query string as
446 * its argument and returns the same string in array form. This allows compatibility
447 * with legacy functions that accept raw query strings instead of nice
448 * arrays. Of course, keys and values are urldecode()d.
450 * @param string $query Query string
451 * @return string[] Array version of input
453 function wfCgiToArray( $query ) {
454 if ( isset( $query[0] ) && $query[0] == '?' ) {
455 $query = substr( $query, 1 );
457 $bits = explode( '&', $query );
459 foreach ( $bits as $bit ) {
463 if ( strpos( $bit, '=' ) === false ) {
464 // Pieces like &qwerty become 'qwerty' => '' (at least this is what php does)
468 list( $key, $value ) = explode( '=', $bit );
470 $key = urldecode( $key );
471 $value = urldecode( $value );
472 if ( strpos( $key, '[' ) !== false ) {
473 $keys = array_reverse( explode( '[', $key ) );
474 $key = array_pop( $keys );
476 foreach ( $keys as $k ) {
477 $k = substr( $k, 0, -1 );
478 $temp = [ $k => $temp ];
480 if ( isset( $ret[$key] ) ) {
481 $ret[$key] = array_merge( $ret[$key], $temp );
493 * Append a query string to an existing URL, which may or may not already
494 * have query string parameters already. If so, they will be combined.
497 * @param string|string[] $query String or associative array
500 function wfAppendQuery( $url, $query ) {
501 if ( is_array( $query ) ) {
502 $query = wfArrayToCgi( $query );
504 if ( $query != '' ) {
505 // Remove the fragment, if there is one
507 $hashPos = strpos( $url, '#' );
508 if ( $hashPos !== false ) {
509 $fragment = substr( $url, $hashPos );
510 $url = substr( $url, 0, $hashPos );
514 if ( false === strpos( $url, '?' ) ) {
521 // Put the fragment back
522 if ( $fragment !== false ) {
530 * Expand a potentially local URL to a fully-qualified URL. Assumes $wgServer
533 * The meaning of the PROTO_* constants is as follows:
534 * PROTO_HTTP: Output a URL starting with http://
535 * PROTO_HTTPS: Output a URL starting with https://
536 * PROTO_RELATIVE: Output a URL starting with // (protocol-relative URL)
537 * PROTO_CURRENT: Output a URL starting with either http:// or https:// , depending
538 * on which protocol was used for the current incoming request
539 * PROTO_CANONICAL: For URLs without a domain, like /w/index.php , use $wgCanonicalServer.
540 * For protocol-relative URLs, use the protocol of $wgCanonicalServer
541 * PROTO_INTERNAL: Like PROTO_CANONICAL, but uses $wgInternalServer instead of $wgCanonicalServer
543 * @todo this won't work with current-path-relative URLs
544 * like "subdir/foo.html", etc.
546 * @param string $url Either fully-qualified or a local path + query
547 * @param string $defaultProto One of the PROTO_* constants. Determines the
548 * protocol to use if $url or $wgServer is protocol-relative
549 * @return string|false Fully-qualified URL, current-path-relative URL or false if
550 * no valid URL can be constructed
552 function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT
) {
553 global $wgServer, $wgCanonicalServer, $wgInternalServer, $wgRequest,
555 if ( $defaultProto === PROTO_CANONICAL
) {
556 $serverUrl = $wgCanonicalServer;
557 } elseif ( $defaultProto === PROTO_INTERNAL
&& $wgInternalServer !== false ) {
558 // Make $wgInternalServer fall back to $wgServer if not set
559 $serverUrl = $wgInternalServer;
561 $serverUrl = $wgServer;
562 if ( $defaultProto === PROTO_CURRENT
) {
563 $defaultProto = $wgRequest->getProtocol() . '://';
567 // Analyze $serverUrl to obtain its protocol
568 $bits = wfParseUrl( $serverUrl );
569 $serverHasProto = $bits && $bits['scheme'] != '';
571 if ( $defaultProto === PROTO_CANONICAL ||
$defaultProto === PROTO_INTERNAL
) {
572 if ( $serverHasProto ) {
573 $defaultProto = $bits['scheme'] . '://';
575 // $wgCanonicalServer or $wgInternalServer doesn't have a protocol.
576 // This really isn't supposed to happen. Fall back to HTTP in this
578 $defaultProto = PROTO_HTTP
;
582 $defaultProtoWithoutSlashes = substr( $defaultProto, 0, -2 );
584 if ( substr( $url, 0, 2 ) == '//' ) {
585 $url = $defaultProtoWithoutSlashes . $url;
586 } elseif ( substr( $url, 0, 1 ) == '/' ) {
587 // If $serverUrl is protocol-relative, prepend $defaultProtoWithoutSlashes,
588 // otherwise leave it alone.
589 $url = ( $serverHasProto ?
'' : $defaultProtoWithoutSlashes ) . $serverUrl . $url;
592 $bits = wfParseUrl( $url );
594 // ensure proper port for HTTPS arrives in URL
595 // https://phabricator.wikimedia.org/T67184
596 if ( $defaultProto === PROTO_HTTPS
&& $wgHttpsPort != 443 ) {
597 $bits['port'] = $wgHttpsPort;
600 if ( $bits && isset( $bits['path'] ) ) {
601 $bits['path'] = wfRemoveDotSegments( $bits['path'] );
602 return wfAssembleUrl( $bits );
606 } elseif ( substr( $url, 0, 1 ) != '/' ) {
607 # URL is a relative path
608 return wfRemoveDotSegments( $url );
611 # Expanded URL is not valid.
616 * This function will reassemble a URL parsed with wfParseURL. This is useful
617 * if you need to edit part of a URL and put it back together.
619 * This is the basic structure used (brackets contain keys for $urlParts):
620 * [scheme][delimiter][user]:[pass]@[host]:[port][path]?[query]#[fragment]
622 * @todo Need to integrate this into wfExpandUrl (see T34168)
625 * @param array $urlParts URL parts, as output from wfParseUrl
626 * @return string URL assembled from its component parts
628 function wfAssembleUrl( $urlParts ) {
631 if ( isset( $urlParts['delimiter'] ) ) {
632 if ( isset( $urlParts['scheme'] ) ) {
633 $result .= $urlParts['scheme'];
636 $result .= $urlParts['delimiter'];
639 if ( isset( $urlParts['host'] ) ) {
640 if ( isset( $urlParts['user'] ) ) {
641 $result .= $urlParts['user'];
642 if ( isset( $urlParts['pass'] ) ) {
643 $result .= ':' . $urlParts['pass'];
648 $result .= $urlParts['host'];
650 if ( isset( $urlParts['port'] ) ) {
651 $result .= ':' . $urlParts['port'];
655 if ( isset( $urlParts['path'] ) ) {
656 $result .= $urlParts['path'];
659 if ( isset( $urlParts['query'] ) ) {
660 $result .= '?' . $urlParts['query'];
663 if ( isset( $urlParts['fragment'] ) ) {
664 $result .= '#' . $urlParts['fragment'];
671 * Remove all dot-segments in the provided URL path. For example,
672 * '/a/./b/../c/' becomes '/a/c/'. For details on the algorithm, please see
673 * RFC3986 section 5.2.4.
675 * @todo Need to integrate this into wfExpandUrl (see T34168)
677 * @param string $urlPath URL path, potentially containing dot-segments
678 * @return string URL path with all dot-segments removed
680 function wfRemoveDotSegments( $urlPath ) {
683 $inputLength = strlen( $urlPath );
685 while ( $inputOffset < $inputLength ) {
686 $prefixLengthOne = substr( $urlPath, $inputOffset, 1 );
687 $prefixLengthTwo = substr( $urlPath, $inputOffset, 2 );
688 $prefixLengthThree = substr( $urlPath, $inputOffset, 3 );
689 $prefixLengthFour = substr( $urlPath, $inputOffset, 4 );
692 if ( $prefixLengthTwo == './' ) {
693 # Step A, remove leading "./"
695 } elseif ( $prefixLengthThree == '../' ) {
696 # Step A, remove leading "../"
698 } elseif ( ( $prefixLengthTwo == '/.' ) && ( $inputOffset +
2 == $inputLength ) ) {
699 # Step B, replace leading "/.$" with "/"
701 $urlPath[$inputOffset] = '/';
702 } elseif ( $prefixLengthThree == '/./' ) {
703 # Step B, replace leading "/./" with "/"
705 } elseif ( $prefixLengthThree == '/..' && ( $inputOffset +
3 == $inputLength ) ) {
706 # Step C, replace leading "/..$" with "/" and
707 # remove last path component in output
709 $urlPath[$inputOffset] = '/';
711 } elseif ( $prefixLengthFour == '/../' ) {
712 # Step C, replace leading "/../" with "/" and
713 # remove last path component in output
716 } elseif ( ( $prefixLengthOne == '.' ) && ( $inputOffset +
1 == $inputLength ) ) {
717 # Step D, remove "^.$"
719 } elseif ( ( $prefixLengthTwo == '..' ) && ( $inputOffset +
2 == $inputLength ) ) {
720 # Step D, remove "^..$"
723 # Step E, move leading path segment to output
724 if ( $prefixLengthOne == '/' ) {
725 $slashPos = strpos( $urlPath, '/', $inputOffset +
1 );
727 $slashPos = strpos( $urlPath, '/', $inputOffset );
729 if ( $slashPos === false ) {
730 $output .= substr( $urlPath, $inputOffset );
731 $inputOffset = $inputLength;
733 $output .= substr( $urlPath, $inputOffset, $slashPos - $inputOffset );
734 $inputOffset +
= $slashPos - $inputOffset;
739 $slashPos = strrpos( $output, '/' );
740 if ( $slashPos === false ) {
743 $output = substr( $output, 0, $slashPos );
752 * Returns a regular expression of url protocols
754 * @param bool $includeProtocolRelative If false, remove '//' from the returned protocol list.
755 * DO NOT USE this directly, use wfUrlProtocolsWithoutProtRel() instead
758 function wfUrlProtocols( $includeProtocolRelative = true ) {
759 global $wgUrlProtocols;
761 // Cache return values separately based on $includeProtocolRelative
762 static $withProtRel = null, $withoutProtRel = null;
763 $cachedValue = $includeProtocolRelative ?
$withProtRel : $withoutProtRel;
764 if ( !is_null( $cachedValue ) ) {
768 // Support old-style $wgUrlProtocols strings, for backwards compatibility
769 // with LocalSettings files from 1.5
770 if ( is_array( $wgUrlProtocols ) ) {
772 foreach ( $wgUrlProtocols as $protocol ) {
773 // Filter out '//' if !$includeProtocolRelative
774 if ( $includeProtocolRelative ||
$protocol !== '//' ) {
775 $protocols[] = preg_quote( $protocol, '/' );
779 $retval = implode( '|', $protocols );
781 // Ignore $includeProtocolRelative in this case
782 // This case exists for pre-1.6 compatibility, and we can safely assume
783 // that '//' won't appear in a pre-1.6 config because protocol-relative
784 // URLs weren't supported until 1.18
785 $retval = $wgUrlProtocols;
788 // Cache return value
789 if ( $includeProtocolRelative ) {
790 $withProtRel = $retval;
792 $withoutProtRel = $retval;
798 * Like wfUrlProtocols(), but excludes '//' from the protocol list. Use this if
799 * you need a regex that matches all URL protocols but does not match protocol-
803 function wfUrlProtocolsWithoutProtRel() {
804 return wfUrlProtocols( false );
808 * parse_url() work-alike, but non-broken. Differences:
810 * 1) Does not raise warnings on bad URLs (just returns false).
811 * 2) Handles protocols that don't use :// (e.g., mailto: and news:, as well as
812 * protocol-relative URLs) correctly.
813 * 3) Adds a "delimiter" element to the array, either '://', ':' or '//' (see (2)).
815 * @param string $url A URL to parse
816 * @return string[]|bool Bits of the URL in an associative array, per PHP docs, false on failure
818 function wfParseUrl( $url ) {
819 global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
821 // Protocol-relative URLs are handled really badly by parse_url(). It's so
822 // bad that the easiest way to handle them is to just prepend 'http:' and
823 // strip the protocol out later.
824 $wasRelative = substr( $url, 0, 2 ) == '//';
825 if ( $wasRelative ) {
828 MediaWiki\
suppressWarnings();
829 $bits = parse_url( $url );
830 MediaWiki\restoreWarnings
();
831 // parse_url() returns an array without scheme for some invalid URLs, e.g.
832 // parse_url("%0Ahttp://example.com") == [ 'host' => '%0Ahttp', 'path' => 'example.com' ]
833 if ( !$bits ||
!isset( $bits['scheme'] ) ) {
837 // parse_url() incorrectly handles schemes case-sensitively. Convert it to lowercase.
838 $bits['scheme'] = strtolower( $bits['scheme'] );
840 // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
841 if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
842 $bits['delimiter'] = '://';
843 } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
844 $bits['delimiter'] = ':';
845 // parse_url detects for news: and mailto: the host part of an url as path
846 // We have to correct this wrong detection
847 if ( isset( $bits['path'] ) ) {
848 $bits['host'] = $bits['path'];
855 /* Provide an empty host for eg. file:/// urls (see T30627) */
856 if ( !isset( $bits['host'] ) ) {
860 if ( isset( $bits['path'] ) ) {
861 /* parse_url loses the third / for file:///c:/ urls (but not on variants) */
862 if ( substr( $bits['path'], 0, 1 ) !== '/' ) {
863 $bits['path'] = '/' . $bits['path'];
870 // If the URL was protocol-relative, fix scheme and delimiter
871 if ( $wasRelative ) {
872 $bits['scheme'] = '';
873 $bits['delimiter'] = '//';
879 * Take a URL, make sure it's expanded to fully qualified, and replace any
880 * encoded non-ASCII Unicode characters with their UTF-8 original forms
881 * for more compact display and legibility for local audiences.
883 * @todo handle punycode domains too
888 function wfExpandIRI( $url ) {
889 return preg_replace_callback(
890 '/((?:%[89A-F][0-9A-F])+)/i',
891 'wfExpandIRI_callback',
897 * Private callback for wfExpandIRI
898 * @param array $matches
901 function wfExpandIRI_callback( $matches ) {
902 return urldecode( $matches[1] );
906 * Make URL indexes, appropriate for the el_index field of externallinks.
911 function wfMakeUrlIndexes( $url ) {
912 $bits = wfParseUrl( $url );
914 // Reverse the labels in the hostname, convert to lower case
915 // For emails reverse domainpart only
916 if ( $bits['scheme'] == 'mailto' ) {
917 $mailparts = explode( '@', $bits['host'], 2 );
918 if ( count( $mailparts ) === 2 ) {
919 $domainpart = strtolower( implode( '.', array_reverse( explode( '.', $mailparts[1] ) ) ) );
921 // No domain specified, don't mangle it
924 $reversedHost = $domainpart . '@' . $mailparts[0];
926 $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) );
928 // Add an extra dot to the end
929 // Why? Is it in wrong place in mailto links?
930 if ( substr( $reversedHost, -1, 1 ) !== '.' ) {
931 $reversedHost .= '.';
933 // Reconstruct the pseudo-URL
934 $prot = $bits['scheme'];
935 $index = $prot . $bits['delimiter'] . $reversedHost;
936 // Leave out user and password. Add the port, path, query and fragment
937 if ( isset( $bits['port'] ) ) {
938 $index .= ':' . $bits['port'];
940 if ( isset( $bits['path'] ) ) {
941 $index .= $bits['path'];
945 if ( isset( $bits['query'] ) ) {
946 $index .= '?' . $bits['query'];
948 if ( isset( $bits['fragment'] ) ) {
949 $index .= '#' . $bits['fragment'];
953 return [ "http:$index", "https:$index" ];
960 * Check whether a given URL has a domain that occurs in a given set of domains
961 * @param string $url URL
962 * @param array $domains Array of domains (strings)
963 * @return bool True if the host part of $url ends in one of the strings in $domains
965 function wfMatchesDomainList( $url, $domains ) {
966 $bits = wfParseUrl( $url );
967 if ( is_array( $bits ) && isset( $bits['host'] ) ) {
968 $host = '.' . $bits['host'];
969 foreach ( (array)$domains as $domain ) {
970 $domain = '.' . $domain;
971 if ( substr( $host, -strlen( $domain ) ) === $domain ) {
980 * Sends a line to the debug log if enabled or, optionally, to a comment in output.
981 * In normal operation this is a NOP.
983 * Controlling globals:
984 * $wgDebugLogFile - points to the log file
985 * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
986 * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
988 * @since 1.25 support for additional context data
990 * @param string $text
991 * @param string|bool $dest Destination of the message:
992 * - 'all': both to the log and HTML (debug toolbar or HTML comments)
993 * - 'private': excluded from HTML output
994 * For backward compatibility, it can also take a boolean:
995 * - true: same as 'all'
996 * - false: same as 'private'
997 * @param array $context Additional logging context data
999 function wfDebug( $text, $dest = 'all', array $context = [] ) {
1000 global $wgDebugRawPage, $wgDebugLogPrefix;
1001 global $wgDebugTimestamps, $wgRequestTime;
1003 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1007 $text = trim( $text );
1009 if ( $wgDebugTimestamps ) {
1010 $context['seconds_elapsed'] = sprintf(
1012 microtime( true ) - $wgRequestTime
1014 $context['memory_used'] = sprintf(
1016 ( memory_get_usage( true ) / ( 1024 * 1024 ) )
1020 if ( $wgDebugLogPrefix !== '' ) {
1021 $context['prefix'] = $wgDebugLogPrefix;
1023 $context['private'] = ( $dest === false ||
$dest === 'private' );
1025 $logger = LoggerFactory
::getInstance( 'wfDebug' );
1026 $logger->debug( $text, $context );
1030 * Returns true if debug logging should be suppressed if $wgDebugRawPage = false
1033 function wfIsDebugRawPage() {
1035 if ( $cache !== null ) {
1038 # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
1039 if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
1041 isset( $_SERVER['SCRIPT_NAME'] )
1042 && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
1053 * Send a line giving PHP memory usage.
1055 * @param bool $exact Print exact byte values instead of kibibytes (default: false)
1057 function wfDebugMem( $exact = false ) {
1058 $mem = memory_get_usage();
1060 $mem = floor( $mem / 1024 ) . ' KiB';
1064 wfDebug( "Memory usage: $mem\n" );
1068 * Send a line to a supplementary debug log file, if configured, or main debug
1071 * To configure a supplementary log file, set $wgDebugLogGroups[$logGroup] to
1072 * a string filename or an associative array mapping 'destination' to the
1073 * desired filename. The associative array may also contain a 'sample' key
1074 * with an integer value, specifying a sampling factor. Sampled log events
1075 * will be emitted with a 1 in N random chance.
1077 * @since 1.23 support for sampling log messages via $wgDebugLogGroups.
1078 * @since 1.25 support for additional context data
1079 * @since 1.25 sample behavior dependent on configured $wgMWLoggerDefaultSpi
1081 * @param string $logGroup
1082 * @param string $text
1083 * @param string|bool $dest Destination of the message:
1084 * - 'all': both to the log and HTML (debug toolbar or HTML comments)
1085 * - 'private': only to the specific log if set in $wgDebugLogGroups and
1086 * discarded otherwise
1087 * For backward compatibility, it can also take a boolean:
1088 * - true: same as 'all'
1089 * - false: same as 'private'
1090 * @param array $context Additional logging context data
1092 function wfDebugLog(
1093 $logGroup, $text, $dest = 'all', array $context = []
1095 $text = trim( $text );
1097 $logger = LoggerFactory
::getInstance( $logGroup );
1098 $context['private'] = ( $dest === false ||
$dest === 'private' );
1099 $logger->info( $text, $context );
1103 * Log for database errors
1105 * @since 1.25 support for additional context data
1107 * @param string $text Database error message.
1108 * @param array $context Additional logging context data
1110 function wfLogDBError( $text, array $context = [] ) {
1111 $logger = LoggerFactory
::getInstance( 'wfLogDBError' );
1112 $logger->error( trim( $text ), $context );
1116 * Throws a warning that $function is deprecated
1118 * @param string $function
1119 * @param string|bool $version Version of MediaWiki that the function
1120 * was deprecated in (Added in 1.19).
1121 * @param string|bool $component Added in 1.19.
1122 * @param int $callerOffset How far up the call stack is the original
1123 * caller. 2 = function that called the function that called
1124 * wfDeprecated (Added in 1.20)
1128 function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) {
1129 MWDebug
::deprecated( $function, $version, $component, $callerOffset +
1 );
1133 * Send a warning either to the debug log or in a PHP error depending on
1134 * $wgDevelopmentWarnings. To log warnings in production, use wfLogWarning() instead.
1136 * @param string $msg Message to send
1137 * @param int $callerOffset Number of items to go back in the backtrace to
1138 * find the correct caller (1 = function calling wfWarn, ...)
1139 * @param int $level PHP error level; defaults to E_USER_NOTICE;
1140 * only used when $wgDevelopmentWarnings is true
1142 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE
) {
1143 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'auto' );
1147 * Send a warning as a PHP error and the debug log. This is intended for logging
1148 * warnings in production. For logging development warnings, use WfWarn instead.
1150 * @param string $msg Message to send
1151 * @param int $callerOffset Number of items to go back in the backtrace to
1152 * find the correct caller (1 = function calling wfLogWarning, ...)
1153 * @param int $level PHP error level; defaults to E_USER_WARNING
1155 function wfLogWarning( $msg, $callerOffset = 1, $level = E_USER_WARNING
) {
1156 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'production' );
1160 * Log to a file without getting "file size exceeded" signals.
1162 * Can also log to TCP or UDP with the syntax udp://host:port/prefix. This will
1163 * send lines to the specified port, prefixed by the specified prefix and a space.
1164 * @since 1.25 support for additional context data
1166 * @param string $text
1167 * @param string $file Filename
1168 * @param array $context Additional logging context data
1169 * @throws MWException
1170 * @deprecated since 1.25 Use \MediaWiki\Logger\LegacyLogger::emit or UDPTransport
1172 function wfErrorLog( $text, $file, array $context = [] ) {
1173 wfDeprecated( __METHOD__
, '1.25' );
1174 $logger = LoggerFactory
::getInstance( 'wfErrorLog' );
1175 $context['destination'] = $file;
1176 $logger->info( trim( $text ), $context );
1182 function wfLogProfilingData() {
1183 global $wgDebugLogGroups, $wgDebugRawPage;
1185 $context = RequestContext
::getMain();
1186 $request = $context->getRequest();
1188 $profiler = Profiler
::instance();
1189 $profiler->setContext( $context );
1190 $profiler->logData();
1192 $config = $context->getConfig();
1193 if ( $config->get( 'StatsdServer' ) ) {
1195 $statsdServer = explode( ':', $config->get( 'StatsdServer' ) );
1196 $statsdHost = $statsdServer[0];
1197 $statsdPort = isset( $statsdServer[1] ) ?
$statsdServer[1] : 8125;
1198 $statsdSender = new SocketSender( $statsdHost, $statsdPort );
1199 $statsdClient = new SamplingStatsdClient( $statsdSender, true, false );
1200 $statsdClient->setSamplingRates( $config->get( 'StatsdSamplingRates' ) );
1201 $statsdClient->send( $context->getStats()->getBuffer() );
1202 } catch ( Exception
$ex ) {
1203 MWExceptionHandler
::logException( $ex );
1207 # Profiling must actually be enabled...
1208 if ( $profiler instanceof ProfilerStub
) {
1212 if ( isset( $wgDebugLogGroups['profileoutput'] )
1213 && $wgDebugLogGroups['profileoutput'] === false
1215 // Explicitly disabled
1218 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1222 $ctx = [ 'elapsed' => $request->getElapsedTime() ];
1223 if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1224 $ctx['forwarded_for'] = $_SERVER['HTTP_X_FORWARDED_FOR'];
1226 if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1227 $ctx['client_ip'] = $_SERVER['HTTP_CLIENT_IP'];
1229 if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1230 $ctx['from'] = $_SERVER['HTTP_FROM'];
1232 if ( isset( $ctx['forwarded_for'] ) ||
1233 isset( $ctx['client_ip'] ) ||
1234 isset( $ctx['from'] ) ) {
1235 $ctx['proxy'] = $_SERVER['REMOTE_ADDR'];
1238 // Don't load $wgUser at this late stage just for statistics purposes
1239 // @todo FIXME: We can detect some anons even if it is not loaded.
1240 // See User::getId()
1241 $user = $context->getUser();
1242 $ctx['anon'] = $user->isItemLoaded( 'id' ) && $user->isAnon();
1244 // Command line script uses a FauxRequest object which does not have
1245 // any knowledge about an URL and throw an exception instead.
1247 $ctx['url'] = urldecode( $request->getRequestURL() );
1248 } catch ( Exception
$ignored ) {
1252 $ctx['output'] = $profiler->getOutput();
1254 $log = LoggerFactory
::getInstance( 'profileoutput' );
1255 $log->info( "Elapsed: {elapsed}; URL: <{url}>\n{output}", $ctx );
1259 * Increment a statistics counter
1261 * @param string $key
1265 function wfIncrStats( $key, $count = 1 ) {
1266 $stats = RequestContext
::getMain()->getStats();
1267 $stats->updateCount( $key, $count );
1271 * Check whether the wiki is in read-only mode.
1275 function wfReadOnly() {
1276 return wfReadOnlyReason() !== false;
1280 * Check if the site is in read-only mode and return the message if so
1282 * This checks wfConfiguredReadOnlyReason() and the main load balancer
1283 * for replica DB lag. This may result in DB connection being made.
1285 * @return string|bool String when in read-only mode; false otherwise
1287 function wfReadOnlyReason() {
1288 $readOnly = wfConfiguredReadOnlyReason();
1289 if ( $readOnly !== false ) {
1293 static $lbReadOnly = null;
1294 if ( $lbReadOnly === null ) {
1295 // Callers use this method to be aware that data presented to a user
1296 // may be very stale and thus allowing submissions can be problematic.
1297 $lbReadOnly = wfGetLB()->getReadOnlyReason();
1304 * Get the value of $wgReadOnly or the contents of $wgReadOnlyFile.
1306 * @return string|bool String when in read-only mode; false otherwise
1309 function wfConfiguredReadOnlyReason() {
1310 global $wgReadOnly, $wgReadOnlyFile;
1312 if ( $wgReadOnly === null ) {
1313 // Set $wgReadOnly for faster access next time
1314 if ( is_file( $wgReadOnlyFile ) && filesize( $wgReadOnlyFile ) > 0 ) {
1315 $wgReadOnly = file_get_contents( $wgReadOnlyFile );
1317 $wgReadOnly = false;
1325 * Return a Language object from $langcode
1327 * @param Language|string|bool $langcode Either:
1328 * - a Language object
1329 * - code of the language to get the message for, if it is
1330 * a valid code create a language for that language, if
1331 * it is a string but not a valid code then make a basic
1333 * - a boolean: if it's false then use the global object for
1334 * the current user's language (as a fallback for the old parameter
1335 * functionality), or if it is true then use global object
1336 * for the wiki's content language.
1339 function wfGetLangObj( $langcode = false ) {
1340 # Identify which language to get or create a language object for.
1341 # Using is_object here due to Stub objects.
1342 if ( is_object( $langcode ) ) {
1343 # Great, we already have the object (hopefully)!
1347 global $wgContLang, $wgLanguageCode;
1348 if ( $langcode === true ||
$langcode === $wgLanguageCode ) {
1349 # $langcode is the language code of the wikis content language object.
1350 # or it is a boolean and value is true
1355 if ( $langcode === false ||
$langcode === $wgLang->getCode() ) {
1356 # $langcode is the language code of user language object.
1357 # or it was a boolean and value is false
1361 $validCodes = array_keys( Language
::fetchLanguageNames() );
1362 if ( in_array( $langcode, $validCodes ) ) {
1363 # $langcode corresponds to a valid language.
1364 return Language
::factory( $langcode );
1367 # $langcode is a string, but not a valid language code; use content language.
1368 wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1373 * This is the function for getting translated interface messages.
1375 * @see Message class for documentation how to use them.
1376 * @see https://www.mediawiki.org/wiki/Manual:Messages_API
1378 * This function replaces all old wfMsg* functions.
1380 * @param string|string[]|MessageSpecifier $key Message key, or array of keys, or a MessageSpecifier
1381 * @param mixed $params,... Normal message parameters
1386 * @see Message::__construct
1388 function wfMessage( $key /*...*/ ) {
1389 $message = new Message( $key );
1391 // We call Message::params() to reduce code duplication
1392 $params = func_get_args();
1393 array_shift( $params );
1395 call_user_func_array( [ $message, 'params' ], $params );
1402 * This function accepts multiple message keys and returns a message instance
1403 * for the first message which is non-empty. If all messages are empty then an
1404 * instance of the first message key is returned.
1406 * @param string|string[] $keys,... Message keys
1411 * @see Message::newFallbackSequence
1413 function wfMessageFallback( /*...*/ ) {
1414 $args = func_get_args();
1415 return call_user_func_array( 'Message::newFallbackSequence', $args );
1419 * Replace message parameter keys on the given formatted output.
1421 * @param string $message
1422 * @param array $args
1426 function wfMsgReplaceArgs( $message, $args ) {
1427 # Fix windows line-endings
1428 # Some messages are split with explode("\n", $msg)
1429 $message = str_replace( "\r", '', $message );
1431 // Replace arguments
1432 if ( is_array( $args ) && $args ) {
1433 if ( is_array( $args[0] ) ) {
1434 $args = array_values( $args[0] );
1436 $replacementKeys = [];
1437 foreach ( $args as $n => $param ) {
1438 $replacementKeys['$' . ( $n +
1 )] = $param;
1440 $message = strtr( $message, $replacementKeys );
1447 * Fetch server name for use in error reporting etc.
1448 * Use real server name if available, so we know which machine
1449 * in a server farm generated the current page.
1453 function wfHostname() {
1455 if ( is_null( $host ) ) {
1457 # Hostname overriding
1458 global $wgOverrideHostname;
1459 if ( $wgOverrideHostname !== false ) {
1460 # Set static and skip any detection
1461 $host = $wgOverrideHostname;
1465 if ( function_exists( 'posix_uname' ) ) {
1466 // This function not present on Windows
1467 $uname = posix_uname();
1471 if ( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1472 $host = $uname['nodename'];
1473 } elseif ( getenv( 'COMPUTERNAME' ) ) {
1474 # Windows computer name
1475 $host = getenv( 'COMPUTERNAME' );
1477 # This may be a virtual server.
1478 $host = $_SERVER['SERVER_NAME'];
1485 * Returns a script tag that stores the amount of time it took MediaWiki to
1486 * handle the request in milliseconds as 'wgBackendResponseTime'.
1488 * If $wgShowHostnames is true, the script will also set 'wgHostname' to the
1489 * hostname of the server handling the request.
1493 function wfReportTime() {
1494 global $wgRequestTime, $wgShowHostnames;
1496 $responseTime = round( ( microtime( true ) - $wgRequestTime ) * 1000 );
1497 $reportVars = [ 'wgBackendResponseTime' => $responseTime ];
1498 if ( $wgShowHostnames ) {
1499 $reportVars['wgHostname'] = wfHostname();
1501 return Skin
::makeVariablesScript( $reportVars );
1505 * Safety wrapper for debug_backtrace().
1507 * Will return an empty array if debug_backtrace is disabled, otherwise
1508 * the output from debug_backtrace() (trimmed).
1510 * @param int $limit This parameter can be used to limit the number of stack frames returned
1512 * @return array Array of backtrace information
1514 function wfDebugBacktrace( $limit = 0 ) {
1515 static $disabled = null;
1517 if ( is_null( $disabled ) ) {
1518 $disabled = !function_exists( 'debug_backtrace' );
1520 wfDebug( "debug_backtrace() is disabled\n" );
1528 return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT
, $limit +
1 ), 1 );
1530 return array_slice( debug_backtrace(), 1 );
1535 * Get a debug backtrace as a string
1537 * @param bool|null $raw If true, the return value is plain text. If false, HTML.
1538 * Defaults to $wgCommandLineMode if unset.
1540 * @since 1.25 Supports $raw parameter.
1542 function wfBacktrace( $raw = null ) {
1543 global $wgCommandLineMode;
1545 if ( $raw === null ) {
1546 $raw = $wgCommandLineMode;
1550 $frameFormat = "%s line %s calls %s()\n";
1551 $traceFormat = "%s";
1553 $frameFormat = "<li>%s line %s calls %s()</li>\n";
1554 $traceFormat = "<ul>\n%s</ul>\n";
1557 $frames = array_map( function ( $frame ) use ( $frameFormat ) {
1558 $file = !empty( $frame['file'] ) ?
basename( $frame['file'] ) : '-';
1559 $line = isset( $frame['line'] ) ?
$frame['line'] : '-';
1560 $call = $frame['function'];
1561 if ( !empty( $frame['class'] ) ) {
1562 $call = $frame['class'] . $frame['type'] . $call;
1564 return sprintf( $frameFormat, $file, $line, $call );
1565 }, wfDebugBacktrace() );
1567 return sprintf( $traceFormat, implode( '', $frames ) );
1571 * Get the name of the function which called this function
1572 * wfGetCaller( 1 ) is the function with the wfGetCaller() call (ie. __FUNCTION__)
1573 * wfGetCaller( 2 ) [default] is the caller of the function running wfGetCaller()
1574 * wfGetCaller( 3 ) is the parent of that.
1579 function wfGetCaller( $level = 2 ) {
1580 $backtrace = wfDebugBacktrace( $level +
1 );
1581 if ( isset( $backtrace[$level] ) ) {
1582 return wfFormatStackFrame( $backtrace[$level] );
1589 * Return a string consisting of callers in the stack. Useful sometimes
1590 * for profiling specific points.
1592 * @param int $limit The maximum depth of the stack frame to return, or false for the entire stack.
1595 function wfGetAllCallers( $limit = 3 ) {
1596 $trace = array_reverse( wfDebugBacktrace() );
1597 if ( !$limit ||
$limit > count( $trace ) - 1 ) {
1598 $limit = count( $trace ) - 1;
1600 $trace = array_slice( $trace, -$limit - 1, $limit );
1601 return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1605 * Return a string representation of frame
1607 * @param array $frame
1610 function wfFormatStackFrame( $frame ) {
1611 if ( !isset( $frame['function'] ) ) {
1612 return 'NO_FUNCTION_GIVEN';
1614 return isset( $frame['class'] ) && isset( $frame['type'] ) ?
1615 $frame['class'] . $frame['type'] . $frame['function'] :
1619 /* Some generic result counters, pulled out of SearchEngine */
1624 * @param int $offset
1628 function wfShowingResults( $offset, $limit ) {
1629 return wfMessage( 'showingresults' )->numParams( $limit, $offset +
1 )->parse();
1633 * Whether the client accept gzip encoding
1635 * Uses the Accept-Encoding header to check if the client supports gzip encoding.
1636 * Use this when considering to send a gzip-encoded response to the client.
1638 * @param bool $force Forces another check even if we already have a cached result.
1641 function wfClientAcceptsGzip( $force = false ) {
1642 static $result = null;
1643 if ( $result === null ||
$force ) {
1645 if ( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
1646 # @todo FIXME: We may want to blacklist some broken browsers
1649 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
1650 $_SERVER['HTTP_ACCEPT_ENCODING'],
1654 if ( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
1658 wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
1667 * Escapes the given text so that it may be output using addWikiText()
1668 * without any linking, formatting, etc. making its way through. This
1669 * is achieved by substituting certain characters with HTML entities.
1670 * As required by the callers, "<nowiki>" is not used.
1672 * @param string $text Text to be escaped
1675 function wfEscapeWikiText( $text ) {
1676 global $wgEnableMagicLinks;
1677 static $repl = null, $repl2 = null;
1678 if ( $repl === null ||
defined( 'MW_PARSER_TEST' ) ||
defined( 'MW_PHPUNIT_TEST' ) ) {
1679 // Tests depend upon being able to change $wgEnableMagicLinks, so don't cache
1680 // in those situations
1682 '"' => '"', '&' => '&', "'" => ''', '<' => '<',
1683 '=' => '=', '>' => '>', '[' => '[', ']' => ']',
1684 '{' => '{', '|' => '|', '}' => '}', ';' => ';',
1685 "\n#" => "\n#", "\r#" => "\r#",
1686 "\n*" => "\n*", "\r*" => "\r*",
1687 "\n:" => "\n:", "\r:" => "\r:",
1688 "\n " => "\n ", "\r " => "\r ",
1689 "\n\n" => "\n ", "\r\n" => " \n",
1690 "\n\r" => "\n ", "\r\r" => "\r ",
1691 "\n\t" => "\n	", "\r\t" => "\r	", // "\n\t\n" is treated like "\n\n"
1692 "\n----" => "\n----", "\r----" => "\r----",
1693 '__' => '__', '://' => '://',
1696 $magicLinks = array_keys( array_filter( $wgEnableMagicLinks ) );
1697 // We have to catch everything "\s" matches in PCRE
1698 foreach ( $magicLinks as $magic ) {
1699 $repl["$magic "] = "$magic ";
1700 $repl["$magic\t"] = "$magic	";
1701 $repl["$magic\r"] = "$magic ";
1702 $repl["$magic\n"] = "$magic ";
1703 $repl["$magic\f"] = "$magic";
1706 // And handle protocols that don't use "://"
1707 global $wgUrlProtocols;
1709 foreach ( $wgUrlProtocols as $prot ) {
1710 if ( substr( $prot, -1 ) === ':' ) {
1711 $repl2[] = preg_quote( substr( $prot, 0, -1 ), '/' );
1714 $repl2 = $repl2 ?
'/\b(' . implode( '|', $repl2 ) . '):/i' : '/^(?!)/';
1716 $text = substr( strtr( "\n$text", $repl ), 1 );
1717 $text = preg_replace( $repl2, '$1:', $text );
1722 * Sets dest to source and returns the original value of dest
1723 * If source is NULL, it just returns the value, it doesn't set the variable
1724 * If force is true, it will set the value even if source is NULL
1726 * @param mixed $dest
1727 * @param mixed $source
1728 * @param bool $force
1731 function wfSetVar( &$dest, $source, $force = false ) {
1733 if ( !is_null( $source ) ||
$force ) {
1740 * As for wfSetVar except setting a bit
1744 * @param bool $state
1748 function wfSetBit( &$dest, $bit, $state = true ) {
1749 $temp = (bool)( $dest & $bit );
1750 if ( !is_null( $state ) ) {
1761 * A wrapper around the PHP function var_export().
1762 * Either print it or add it to the regular output ($wgOut).
1764 * @param mixed $var A PHP variable to dump.
1766 function wfVarDump( $var ) {
1768 $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
1769 if ( headers_sent() ||
!isset( $wgOut ) ||
!is_object( $wgOut ) ) {
1772 $wgOut->addHTML( $s );
1777 * Provide a simple HTTP error.
1779 * @param int|string $code
1780 * @param string $label
1781 * @param string $desc
1783 function wfHttpError( $code, $label, $desc ) {
1785 HttpStatus
::header( $code );
1788 $wgOut->sendCacheControl();
1791 header( 'Content-type: text/html; charset=utf-8' );
1792 print '<!DOCTYPE html>' .
1793 '<html><head><title>' .
1794 htmlspecialchars( $label ) .
1795 '</title></head><body><h1>' .
1796 htmlspecialchars( $label ) .
1798 nl2br( htmlspecialchars( $desc ) ) .
1799 "</p></body></html>\n";
1803 * Clear away any user-level output buffers, discarding contents.
1805 * Suitable for 'starting afresh', for instance when streaming
1806 * relatively large amounts of data without buffering, or wanting to
1807 * output image files without ob_gzhandler's compression.
1809 * The optional $resetGzipEncoding parameter controls suppression of
1810 * the Content-Encoding header sent by ob_gzhandler; by default it
1811 * is left. See comments for wfClearOutputBuffers() for why it would
1814 * Note that some PHP configuration options may add output buffer
1815 * layers which cannot be removed; these are left in place.
1817 * @param bool $resetGzipEncoding
1819 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
1820 if ( $resetGzipEncoding ) {
1821 // Suppress Content-Encoding and Content-Length
1822 // headers from 1.10+s wfOutputHandler
1823 global $wgDisableOutputCompression;
1824 $wgDisableOutputCompression = true;
1826 while ( $status = ob_get_status() ) {
1827 if ( isset( $status['flags'] ) ) {
1828 $flags = PHP_OUTPUT_HANDLER_CLEANABLE | PHP_OUTPUT_HANDLER_REMOVABLE
;
1829 $deleteable = ( $status['flags'] & $flags ) === $flags;
1830 } elseif ( isset( $status['del'] ) ) {
1831 $deleteable = $status['del'];
1833 // Guess that any PHP-internal setting can't be removed.
1834 $deleteable = $status['type'] !== 0; /* PHP_OUTPUT_HANDLER_INTERNAL */
1836 if ( !$deleteable ) {
1837 // Give up, and hope the result doesn't break
1841 if ( $status['name'] === 'MediaWikiTestCase::wfResetOutputBuffersBarrier' ) {
1842 // Unit testing barrier to prevent this function from breaking PHPUnit.
1845 if ( !ob_end_clean() ) {
1846 // Could not remove output buffer handler; abort now
1847 // to avoid getting in some kind of infinite loop.
1850 if ( $resetGzipEncoding ) {
1851 if ( $status['name'] == 'ob_gzhandler' ) {
1852 // Reset the 'Content-Encoding' field set by this handler
1853 // so we can start fresh.
1854 header_remove( 'Content-Encoding' );
1862 * More legible than passing a 'false' parameter to wfResetOutputBuffers():
1864 * Clear away output buffers, but keep the Content-Encoding header
1865 * produced by ob_gzhandler, if any.
1867 * This should be used for HTTP 304 responses, where you need to
1868 * preserve the Content-Encoding header of the real result, but
1869 * also need to suppress the output of ob_gzhandler to keep to spec
1870 * and avoid breaking Firefox in rare cases where the headers and
1871 * body are broken over two packets.
1873 function wfClearOutputBuffers() {
1874 wfResetOutputBuffers( false );
1878 * Converts an Accept-* header into an array mapping string values to quality
1881 * @param string $accept
1882 * @param string $def Default
1883 * @return float[] Associative array of string => float pairs
1885 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
1886 # No arg means accept anything (per HTTP spec)
1888 return [ $def => 1.0 ];
1893 $parts = explode( ',', $accept );
1895 foreach ( $parts as $part ) {
1896 # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
1897 $values = explode( ';', trim( $part ) );
1899 if ( count( $values ) == 1 ) {
1900 $prefs[$values[0]] = 1.0;
1901 } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
1902 $prefs[$values[0]] = floatval( $match[1] );
1910 * Checks if a given MIME type matches any of the keys in the given
1911 * array. Basic wildcards are accepted in the array keys.
1913 * Returns the matching MIME type (or wildcard) if a match, otherwise
1916 * @param string $type
1917 * @param array $avail
1921 function mimeTypeMatch( $type, $avail ) {
1922 if ( array_key_exists( $type, $avail ) ) {
1925 $mainType = explode( '/', $type )[0];
1926 if ( array_key_exists( "$mainType/*", $avail ) ) {
1927 return "$mainType/*";
1928 } elseif ( array_key_exists( '*/*', $avail ) ) {
1937 * Returns the 'best' match between a client's requested internet media types
1938 * and the server's list of available types. Each list should be an associative
1939 * array of type to preference (preference is a float between 0.0 and 1.0).
1940 * Wildcards in the types are acceptable.
1942 * @param array $cprefs Client's acceptable type list
1943 * @param array $sprefs Server's offered types
1946 * @todo FIXME: Doesn't handle params like 'text/plain; charset=UTF-8'
1947 * XXX: generalize to negotiate other stuff
1949 function wfNegotiateType( $cprefs, $sprefs ) {
1952 foreach ( array_keys( $sprefs ) as $type ) {
1953 $subType = explode( '/', $type )[1];
1954 if ( $subType != '*' ) {
1955 $ckey = mimeTypeMatch( $type, $cprefs );
1957 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1962 foreach ( array_keys( $cprefs ) as $type ) {
1963 $subType = explode( '/', $type )[1];
1964 if ( $subType != '*' && !array_key_exists( $type, $sprefs ) ) {
1965 $skey = mimeTypeMatch( $type, $sprefs );
1967 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1975 foreach ( array_keys( $combine ) as $type ) {
1976 if ( $combine[$type] > $bestq ) {
1978 $bestq = $combine[$type];
1986 * Reference-counted warning suppression
1988 * @deprecated since 1.26, use MediaWiki\suppressWarnings() directly
1991 function wfSuppressWarnings( $end = false ) {
1992 MediaWiki\
suppressWarnings( $end );
1996 * @deprecated since 1.26, use MediaWiki\restoreWarnings() directly
1997 * Restore error level to previous value
1999 function wfRestoreWarnings() {
2000 MediaWiki\
suppressWarnings( true );
2004 * Get a timestamp string in one of various formats
2006 * @param mixed $outputtype A timestamp in one of the supported formats, the
2007 * function will autodetect which format is supplied and act accordingly.
2008 * @param mixed $ts Optional timestamp to convert, default 0 for the current time
2009 * @return string|bool String / false The same date in the format specified in $outputtype or false
2011 function wfTimestamp( $outputtype = TS_UNIX
, $ts = 0 ) {
2012 $ret = MWTimestamp
::convert( $outputtype, $ts );
2013 if ( $ret === false ) {
2014 wfDebug( "wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n" );
2020 * Return a formatted timestamp, or null if input is null.
2021 * For dealing with nullable timestamp columns in the database.
2023 * @param int $outputtype
2027 function wfTimestampOrNull( $outputtype = TS_UNIX
, $ts = null ) {
2028 if ( is_null( $ts ) ) {
2031 return wfTimestamp( $outputtype, $ts );
2036 * Convenience function; returns MediaWiki timestamp for the present time.
2040 function wfTimestampNow() {
2042 return MWTimestamp
::now( TS_MW
);
2046 * Check if the operating system is Windows
2048 * @return bool True if it's Windows, false otherwise.
2050 function wfIsWindows() {
2051 static $isWindows = null;
2052 if ( $isWindows === null ) {
2053 $isWindows = strtoupper( substr( PHP_OS
, 0, 3 ) ) === 'WIN';
2059 * Check if we are running under HHVM
2063 function wfIsHHVM() {
2064 return defined( 'HHVM_VERSION' );
2068 * Tries to get the system directory for temporary files. First
2069 * $wgTmpDirectory is checked, and then the TMPDIR, TMP, and TEMP
2070 * environment variables are then checked in sequence, then
2071 * sys_get_temp_dir(), then upload_tmp_dir from php.ini.
2073 * NOTE: When possible, use instead the tmpfile() function to create
2074 * temporary files to avoid race conditions on file creation, etc.
2078 function wfTempDir() {
2079 global $wgTmpDirectory;
2081 if ( $wgTmpDirectory !== false ) {
2082 return $wgTmpDirectory;
2085 return TempFSFile
::getUsableTempDirectory();
2089 * Make directory, and make all parent directories if they don't exist
2091 * @param string $dir Full path to directory to create
2092 * @param int $mode Chmod value to use, default is $wgDirectoryMode
2093 * @param string $caller Optional caller param for debugging.
2094 * @throws MWException
2097 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2098 global $wgDirectoryMode;
2100 if ( FileBackend
::isStoragePath( $dir ) ) { // sanity
2101 throw new MWException( __FUNCTION__
. " given storage path '$dir'." );
2104 if ( !is_null( $caller ) ) {
2105 wfDebug( "$caller: called wfMkdirParents($dir)\n" );
2108 if ( strval( $dir ) === '' ||
is_dir( $dir ) ) {
2112 $dir = str_replace( [ '\\', '/' ], DIRECTORY_SEPARATOR
, $dir );
2114 if ( is_null( $mode ) ) {
2115 $mode = $wgDirectoryMode;
2118 // Turn off the normal warning, we're doing our own below
2119 MediaWiki\
suppressWarnings();
2120 $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2121 MediaWiki\restoreWarnings
();
2124 // directory may have been created on another request since we last checked
2125 if ( is_dir( $dir ) ) {
2129 // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2130 wfLogWarning( sprintf( "failed to mkdir \"%s\" mode 0%o", $dir, $mode ) );
2136 * Remove a directory and all its content.
2137 * Does not hide error.
2138 * @param string $dir
2140 function wfRecursiveRemoveDir( $dir ) {
2141 wfDebug( __FUNCTION__
. "( $dir )\n" );
2142 // taken from https://secure.php.net/manual/en/function.rmdir.php#98622
2143 if ( is_dir( $dir ) ) {
2144 $objects = scandir( $dir );
2145 foreach ( $objects as $object ) {
2146 if ( $object != "." && $object != ".." ) {
2147 if ( filetype( $dir . '/' . $object ) == "dir" ) {
2148 wfRecursiveRemoveDir( $dir . '/' . $object );
2150 unlink( $dir . '/' . $object );
2160 * @param int $nr The number to format
2161 * @param int $acc The number of digits after the decimal point, default 2
2162 * @param bool $round Whether or not to round the value, default true
2165 function wfPercent( $nr, $acc = 2, $round = true ) {
2166 $ret = sprintf( "%.${acc}f", $nr );
2167 return $round ?
round( $ret, $acc ) . '%' : "$ret%";
2171 * Safety wrapper around ini_get() for boolean settings.
2172 * The values returned from ini_get() are pre-normalized for settings
2173 * set via php.ini or php_flag/php_admin_flag... but *not*
2174 * for those set via php_value/php_admin_value.
2176 * It's fairly common for people to use php_value instead of php_flag,
2177 * which can leave you with an 'off' setting giving a false positive
2178 * for code that just takes the ini_get() return value as a boolean.
2180 * To make things extra interesting, setting via php_value accepts
2181 * "true" and "yes" as true, but php.ini and php_flag consider them false. :)
2182 * Unrecognized values go false... again opposite PHP's own coercion
2183 * from string to bool.
2185 * Luckily, 'properly' set settings will always come back as '0' or '1',
2186 * so we only have to worry about them and the 'improper' settings.
2188 * I frickin' hate PHP... :P
2190 * @param string $setting
2193 function wfIniGetBool( $setting ) {
2194 $val = strtolower( ini_get( $setting ) );
2195 // 'on' and 'true' can't have whitespace around them, but '1' can.
2199 ||
preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2203 * Version of escapeshellarg() that works better on Windows.
2205 * Originally, this fixed the incorrect use of single quotes on Windows
2206 * (https://bugs.php.net/bug.php?id=26285) and the locale problems on Linux in
2207 * PHP 5.2.6+ (bug backported to earlier distro releases of PHP).
2209 * @param string ... strings to escape and glue together, or a single array of strings parameter
2212 function wfEscapeShellArg( /*...*/ ) {
2213 wfInitShellLocale();
2215 $args = func_get_args();
2216 if ( count( $args ) === 1 && is_array( reset( $args ) ) ) {
2217 // If only one argument has been passed, and that argument is an array,
2218 // treat it as a list of arguments
2219 $args = reset( $args );
2224 foreach ( $args as $arg ) {
2231 if ( wfIsWindows() ) {
2232 // Escaping for an MSVC-style command line parser and CMD.EXE
2233 // @codingStandardsIgnoreStart For long URLs
2235 // * https://web.archive.org/web/20020708081031/http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
2236 // * https://technet.microsoft.com/en-us/library/cc723564.aspx
2239 // Double the backslashes before any double quotes. Escape the double quotes.
2240 // @codingStandardsIgnoreEnd
2241 $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE
);
2244 foreach ( $tokens as $token ) {
2245 if ( $iteration %
2 == 1 ) {
2246 // Delimiter, a double quote preceded by zero or more slashes
2247 $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
2248 } elseif ( $iteration %
4 == 2 ) {
2249 // ^ in $token will be outside quotes, need to be escaped
2250 $arg .= str_replace( '^', '^^', $token );
2251 } else { // $iteration % 4 == 0
2252 // ^ in $token will appear inside double quotes, so leave as is
2257 // Double the backslashes before the end of the string, because
2258 // we will soon add a quote
2260 if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
2261 $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
2264 // Add surrounding quotes
2265 $retVal .= '"' . $arg . '"';
2267 $retVal .= escapeshellarg( $arg );
2274 * Check if wfShellExec() is effectively disabled via php.ini config
2276 * @return bool|string False or 'disabled'
2279 function wfShellExecDisabled() {
2280 static $disabled = null;
2281 if ( is_null( $disabled ) ) {
2282 if ( !function_exists( 'proc_open' ) ) {
2283 wfDebug( "proc_open() is disabled\n" );
2284 $disabled = 'disabled';
2293 * Execute a shell command, with time and memory limits mirrored from the PHP
2294 * configuration if supported.
2296 * @param string|string[] $cmd If string, a properly shell-escaped command line,
2297 * or an array of unescaped arguments, in which case each value will be escaped
2298 * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
2299 * @param null|mixed &$retval Optional, will receive the program's exit code.
2300 * (non-zero is usually failure). If there is an error from
2301 * read, select, or proc_open(), this will be set to -1.
2302 * @param array $environ Optional environment variables which should be
2303 * added to the executed command environment.
2304 * @param array $limits Optional array with limits(filesize, memory, time, walltime)
2305 * this overwrites the global wgMaxShell* limits.
2306 * @param array $options Array of options:
2307 * - duplicateStderr: Set this to true to duplicate stderr to stdout,
2308 * including errors from limit.sh
2309 * - profileMethod: By default this function will profile based on the calling
2310 * method. Set this to a string for an alternative method to profile from
2312 * @return string Collected stdout as a string
2314 function wfShellExec( $cmd, &$retval = null, $environ = [],
2315 $limits = [], $options = []
2317 global $IP, $wgMaxShellMemory, $wgMaxShellFileSize, $wgMaxShellTime,
2318 $wgMaxShellWallClockTime, $wgShellCgroup;
2320 $disabled = wfShellExecDisabled();
2323 return 'Unable to run external programs, proc_open() is disabled.';
2326 $includeStderr = isset( $options['duplicateStderr'] ) && $options['duplicateStderr'];
2327 $profileMethod = isset( $options['profileMethod'] ) ?
$options['profileMethod'] : wfGetCaller();
2329 wfInitShellLocale();
2332 foreach ( $environ as $k => $v ) {
2333 if ( wfIsWindows() ) {
2334 /* Surrounding a set in quotes (method used by wfEscapeShellArg) makes the quotes themselves
2335 * appear in the environment variable, so we must use carat escaping as documented in
2336 * https://technet.microsoft.com/en-us/library/cc723564.aspx
2337 * Note however that the quote isn't listed there, but is needed, and the parentheses
2338 * are listed there but doesn't appear to need it.
2340 $envcmd .= "set $k=" . preg_replace( '/([&|()<>^"])/', '^\\1', $v ) . '&& ';
2342 /* Assume this is a POSIX shell, thus required to accept variable assignments before the command
2343 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_09_01
2345 $envcmd .= "$k=" . escapeshellarg( $v ) . ' ';
2348 if ( is_array( $cmd ) ) {
2349 $cmd = wfEscapeShellArg( $cmd );
2352 $cmd = $envcmd . $cmd;
2354 $useLogPipe = false;
2355 if ( is_executable( '/bin/bash' ) ) {
2356 $time = intval( isset( $limits['time'] ) ?
$limits['time'] : $wgMaxShellTime );
2357 if ( isset( $limits['walltime'] ) ) {
2358 $wallTime = intval( $limits['walltime'] );
2359 } elseif ( isset( $limits['time'] ) ) {
2362 $wallTime = intval( $wgMaxShellWallClockTime );
2364 $mem = intval( isset( $limits['memory'] ) ?
$limits['memory'] : $wgMaxShellMemory );
2365 $filesize = intval( isset( $limits['filesize'] ) ?
$limits['filesize'] : $wgMaxShellFileSize );
2367 if ( $time > 0 ||
$mem > 0 ||
$filesize > 0 ||
$wallTime > 0 ) {
2368 $cmd = '/bin/bash ' . escapeshellarg( "$IP/includes/limit.sh" ) . ' ' .
2369 escapeshellarg( $cmd ) . ' ' .
2371 "MW_INCLUDE_STDERR=" . ( $includeStderr ?
'1' : '' ) . ';' .
2372 "MW_CPU_LIMIT=$time; " .
2373 'MW_CGROUP=' . escapeshellarg( $wgShellCgroup ) . '; ' .
2374 "MW_MEM_LIMIT=$mem; " .
2375 "MW_FILE_SIZE_LIMIT=$filesize; " .
2376 "MW_WALL_CLOCK_LIMIT=$wallTime; " .
2377 "MW_USE_LOG_PIPE=yes"
2380 } elseif ( $includeStderr ) {
2383 } elseif ( $includeStderr ) {
2386 wfDebug( "wfShellExec: $cmd\n" );
2388 // Don't try to execute commands that exceed Linux's MAX_ARG_STRLEN.
2389 // Other platforms may be more accomodating, but we don't want to be
2390 // accomodating, because very long commands probably include user
2391 // input. See T129506.
2392 if ( strlen( $cmd ) > SHELL_MAX_ARG_STRLEN
) {
2393 throw new Exception( __METHOD__
.
2394 '(): total length of $cmd must not exceed SHELL_MAX_ARG_STRLEN' );
2398 0 => [ 'file', 'php://stdin', 'r' ],
2399 1 => [ 'pipe', 'w' ],
2400 2 => [ 'file', 'php://stderr', 'w' ] ];
2401 if ( $useLogPipe ) {
2402 $desc[3] = [ 'pipe', 'w' ];
2405 $scoped = Profiler
::instance()->scopedProfileIn( __FUNCTION__
. '-' . $profileMethod );
2406 $proc = proc_open( $cmd, $desc, $pipes );
2408 wfDebugLog( 'exec', "proc_open() failed: $cmd" );
2412 $outBuffer = $logBuffer = '';
2417 /* According to the documentation, it is possible for stream_select()
2418 * to fail due to EINTR. I haven't managed to induce this in testing
2419 * despite sending various signals. If it did happen, the error
2420 * message would take the form:
2422 * stream_select(): unable to select [4]: Interrupted system call (max_fd=5)
2424 * where [4] is the value of the macro EINTR and "Interrupted system
2425 * call" is string which according to the Linux manual is "possibly"
2426 * localised according to LC_MESSAGES.
2428 $eintr = defined( 'SOCKET_EINTR' ) ? SOCKET_EINTR
: 4;
2429 $eintrMessage = "stream_select(): unable to select [$eintr]";
2435 while ( $running === true ||
$numReadyPipes !== 0 ) {
2437 $status = proc_get_status( $proc );
2438 // If the process has terminated, switch to nonblocking selects
2439 // for getting any data still waiting to be read.
2440 if ( !$status['running'] ) {
2446 $readyPipes = $pipes;
2449 // @codingStandardsIgnoreStart Generic.PHP.NoSilencedErrors.Discouraged
2450 @trigger_error
( '' );
2451 $numReadyPipes = @stream_select
( $readyPipes, $emptyArray, $emptyArray, $timeout );
2452 if ( $numReadyPipes === false ) {
2453 // @codingStandardsIgnoreEnd
2454 $error = error_get_last();
2455 if ( strncmp( $error['message'], $eintrMessage, strlen( $eintrMessage ) ) == 0 ) {
2458 trigger_error( $error['message'], E_USER_WARNING
);
2459 $logMsg = $error['message'];
2463 foreach ( $readyPipes as $fd => $pipe ) {
2464 $block = fread( $pipe, 65536 );
2465 if ( $block === '' ) {
2467 fclose( $pipes[$fd] );
2468 unset( $pipes[$fd] );
2472 } elseif ( $block === false ) {
2474 $logMsg = "Error reading from pipe";
2476 } elseif ( $fd == 1 ) {
2478 $outBuffer .= $block;
2479 } elseif ( $fd == 3 ) {
2481 $logBuffer .= $block;
2482 if ( strpos( $block, "\n" ) !== false ) {
2483 $lines = explode( "\n", $logBuffer );
2484 $logBuffer = array_pop( $lines );
2485 foreach ( $lines as $line ) {
2486 wfDebugLog( 'exec', $line );
2493 foreach ( $pipes as $pipe ) {
2497 // Use the status previously collected if possible, since proc_get_status()
2498 // just calls waitpid() which will not return anything useful the second time.
2500 $status = proc_get_status( $proc );
2503 if ( $logMsg !== false ) {
2504 // Read/select error
2506 proc_close( $proc );
2507 } elseif ( $status['signaled'] ) {
2508 $logMsg = "Exited with signal {$status['termsig']}";
2509 $retval = 128 +
$status['termsig'];
2510 proc_close( $proc );
2512 if ( $status['running'] ) {
2513 $retval = proc_close( $proc );
2515 $retval = $status['exitcode'];
2516 proc_close( $proc );
2518 if ( $retval == 127 ) {
2519 $logMsg = "Possibly missing executable file";
2520 } elseif ( $retval >= 129 && $retval <= 192 ) {
2521 $logMsg = "Probably exited with signal " . ( $retval - 128 );
2525 if ( $logMsg !== false ) {
2526 wfDebugLog( 'exec', "$logMsg: $cmd" );
2533 * Execute a shell command, returning both stdout and stderr. Convenience
2534 * function, as all the arguments to wfShellExec can become unwieldy.
2536 * @note This also includes errors from limit.sh, e.g. if $wgMaxShellFileSize is exceeded.
2537 * @param string|string[] $cmd If string, a properly shell-escaped command line,
2538 * or an array of unescaped arguments, in which case each value will be escaped
2539 * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
2540 * @param null|mixed &$retval Optional, will receive the program's exit code.
2541 * (non-zero is usually failure)
2542 * @param array $environ Optional environment variables which should be
2543 * added to the executed command environment.
2544 * @param array $limits Optional array with limits(filesize, memory, time, walltime)
2545 * this overwrites the global wgMaxShell* limits.
2546 * @return string Collected stdout and stderr as a string
2548 function wfShellExecWithStderr( $cmd, &$retval = null, $environ = [], $limits = [] ) {
2549 return wfShellExec( $cmd, $retval, $environ, $limits,
2550 [ 'duplicateStderr' => true, 'profileMethod' => wfGetCaller() ] );
2554 * Workaround for https://bugs.php.net/bug.php?id=45132
2555 * escapeshellarg() destroys non-ASCII characters if LANG is not a UTF-8 locale
2557 function wfInitShellLocale() {
2558 static $done = false;
2563 global $wgShellLocale;
2564 putenv( "LC_CTYPE=$wgShellLocale" );
2565 setlocale( LC_CTYPE
, $wgShellLocale );
2569 * Generate a shell-escaped command line string to run a MediaWiki cli script.
2570 * Note that $parameters should be a flat array and an option with an argument
2571 * should consist of two consecutive items in the array (do not use "--option value").
2573 * @param string $script MediaWiki cli script path
2574 * @param array $parameters Arguments and options to the script
2575 * @param array $options Associative array of options:
2576 * 'php': The path to the php executable
2577 * 'wrapper': Path to a PHP wrapper to handle the maintenance script
2580 function wfShellWikiCmd( $script, array $parameters = [], array $options = [] ) {
2582 // Give site config file a chance to run the script in a wrapper.
2583 // The caller may likely want to call wfBasename() on $script.
2584 Hooks
::run( 'wfShellWikiCmd', [ &$script, &$parameters, &$options ] );
2585 $cmd = isset( $options['php'] ) ?
[ $options['php'] ] : [ $wgPhpCli ];
2586 if ( isset( $options['wrapper'] ) ) {
2587 $cmd[] = $options['wrapper'];
2590 // Escape each parameter for shell
2591 return wfEscapeShellArg( array_merge( $cmd, $parameters ) );
2595 * wfMerge attempts to merge differences between three texts.
2596 * Returns true for a clean merge and false for failure or a conflict.
2598 * @param string $old
2599 * @param string $mine
2600 * @param string $yours
2601 * @param string $result
2604 function wfMerge( $old, $mine, $yours, &$result ) {
2607 # This check may also protect against code injection in
2608 # case of broken installations.
2609 MediaWiki\
suppressWarnings();
2610 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
2611 MediaWiki\restoreWarnings
();
2613 if ( !$haveDiff3 ) {
2614 wfDebug( "diff3 not found\n" );
2618 # Make temporary files
2620 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2621 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
2622 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
2624 # NOTE: diff3 issues a warning to stderr if any of the files does not end with
2625 # a newline character. To avoid this, we normalize the trailing whitespace before
2626 # creating the diff.
2628 fwrite( $oldtextFile, rtrim( $old ) . "\n" );
2629 fclose( $oldtextFile );
2630 fwrite( $mytextFile, rtrim( $mine ) . "\n" );
2631 fclose( $mytextFile );
2632 fwrite( $yourtextFile, rtrim( $yours ) . "\n" );
2633 fclose( $yourtextFile );
2635 # Check for a conflict
2636 $cmd = wfEscapeShellArg( $wgDiff3, '-a', '--overlap-only', $mytextName,
2637 $oldtextName, $yourtextName );
2638 $handle = popen( $cmd, 'r' );
2640 if ( fgets( $handle, 1024 ) ) {
2648 $cmd = wfEscapeShellArg( $wgDiff3, '-a', '-e', '--merge', $mytextName,
2649 $oldtextName, $yourtextName );
2650 $handle = popen( $cmd, 'r' );
2653 $data = fread( $handle, 8192 );
2654 if ( strlen( $data ) == 0 ) {
2660 unlink( $mytextName );
2661 unlink( $oldtextName );
2662 unlink( $yourtextName );
2664 if ( $result === '' && $old !== '' && !$conflict ) {
2665 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
2672 * Returns unified plain-text diff of two texts.
2673 * "Useful" for machine processing of diffs.
2675 * @deprecated since 1.25, use DiffEngine/UnifiedDiffFormatter directly
2677 * @param string $before The text before the changes.
2678 * @param string $after The text after the changes.
2679 * @param string $params Command-line options for the diff command.
2680 * @return string Unified diff of $before and $after
2682 function wfDiff( $before, $after, $params = '-u' ) {
2683 if ( $before == $after ) {
2688 MediaWiki\
suppressWarnings();
2689 $haveDiff = $wgDiff && file_exists( $wgDiff );
2690 MediaWiki\restoreWarnings
();
2692 # This check may also protect against code injection in
2693 # case of broken installations.
2695 wfDebug( "diff executable not found\n" );
2696 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
2697 $format = new UnifiedDiffFormatter();
2698 return $format->format( $diffs );
2701 # Make temporary files
2703 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2704 $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
2706 fwrite( $oldtextFile, $before );
2707 fclose( $oldtextFile );
2708 fwrite( $newtextFile, $after );
2709 fclose( $newtextFile );
2711 // Get the diff of the two files
2712 $cmd = "$wgDiff " . $params . ' ' . wfEscapeShellArg( $oldtextName, $newtextName );
2714 $h = popen( $cmd, 'r' );
2716 unlink( $oldtextName );
2717 unlink( $newtextName );
2718 throw new Exception( __METHOD__
. '(): popen() failed' );
2724 $data = fread( $h, 8192 );
2725 if ( strlen( $data ) == 0 ) {
2733 unlink( $oldtextName );
2734 unlink( $newtextName );
2736 // Kill the --- and +++ lines. They're not useful.
2737 $diff_lines = explode( "\n", $diff );
2738 if ( isset( $diff_lines[0] ) && strpos( $diff_lines[0], '---' ) === 0 ) {
2739 unset( $diff_lines[0] );
2741 if ( isset( $diff_lines[1] ) && strpos( $diff_lines[1], '+++' ) === 0 ) {
2742 unset( $diff_lines[1] );
2745 $diff = implode( "\n", $diff_lines );
2751 * This function works like "use VERSION" in Perl, the program will die with a
2752 * backtrace if the current version of PHP is less than the version provided
2754 * This is useful for extensions which due to their nature are not kept in sync
2755 * with releases, and might depend on other versions of PHP than the main code
2757 * Note: PHP might die due to parsing errors in some cases before it ever
2758 * manages to call this function, such is life
2760 * @see perldoc -f use
2762 * @param string|int|float $req_ver The version to check, can be a string, an integer, or a float
2763 * @throws MWException
2765 function wfUsePHP( $req_ver ) {
2766 $php_ver = PHP_VERSION
;
2768 if ( version_compare( $php_ver, (string)$req_ver, '<' ) ) {
2769 throw new MWException( "PHP $req_ver required--this is only $php_ver" );
2774 * This function works like "use VERSION" in Perl except it checks the version
2775 * of MediaWiki, the program will die with a backtrace if the current version
2776 * of MediaWiki is less than the version provided.
2778 * This is useful for extensions which due to their nature are not kept in sync
2781 * Note: Due to the behavior of PHP's version_compare() which is used in this
2782 * function, if you want to allow the 'wmf' development versions add a 'c' (or
2783 * any single letter other than 'a', 'b' or 'p') as a post-fix to your
2784 * targeted version number. For example if you wanted to allow any variation
2785 * of 1.22 use `wfUseMW( '1.22c' )`. Using an 'a' or 'b' instead of 'c' will
2786 * not result in the same comparison due to the internal logic of
2787 * version_compare().
2789 * @see perldoc -f use
2791 * @deprecated since 1.26, use the "requires' property of extension.json
2792 * @param string|int|float $req_ver The version to check, can be a string, an integer, or a float
2793 * @throws MWException
2795 function wfUseMW( $req_ver ) {
2798 if ( version_compare( $wgVersion, (string)$req_ver, '<' ) ) {
2799 throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
2804 * Return the final portion of a pathname.
2805 * Reimplemented because PHP5's "basename()" is buggy with multibyte text.
2806 * https://bugs.php.net/bug.php?id=33898
2808 * PHP's basename() only considers '\' a pathchar on Windows and Netware.
2809 * We'll consider it so always, as we don't want '\s' in our Unix paths either.
2811 * @param string $path
2812 * @param string $suffix String to remove if present
2815 function wfBaseName( $path, $suffix = '' ) {
2816 if ( $suffix == '' ) {
2819 $encSuffix = '(?:' . preg_quote( $suffix, '#' ) . ')?';
2823 if ( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
2831 * Generate a relative path name to the given file.
2832 * May explode on non-matching case-insensitive paths,
2833 * funky symlinks, etc.
2835 * @param string $path Absolute destination path including target filename
2836 * @param string $from Absolute source path, directory only
2839 function wfRelativePath( $path, $from ) {
2840 // Normalize mixed input on Windows...
2841 $path = str_replace( '/', DIRECTORY_SEPARATOR
, $path );
2842 $from = str_replace( '/', DIRECTORY_SEPARATOR
, $from );
2844 // Trim trailing slashes -- fix for drive root
2845 $path = rtrim( $path, DIRECTORY_SEPARATOR
);
2846 $from = rtrim( $from, DIRECTORY_SEPARATOR
);
2848 $pieces = explode( DIRECTORY_SEPARATOR
, dirname( $path ) );
2849 $against = explode( DIRECTORY_SEPARATOR
, $from );
2851 if ( $pieces[0] !== $against[0] ) {
2852 // Non-matching Windows drive letters?
2853 // Return a full path.
2857 // Trim off common prefix
2858 while ( count( $pieces ) && count( $against )
2859 && $pieces[0] == $against[0] ) {
2860 array_shift( $pieces );
2861 array_shift( $against );
2864 // relative dots to bump us to the parent
2865 while ( count( $against ) ) {
2866 array_unshift( $pieces, '..' );
2867 array_shift( $against );
2870 array_push( $pieces, wfBaseName( $path ) );
2872 return implode( DIRECTORY_SEPARATOR
, $pieces );
2876 * Convert an arbitrarily-long digit string from one numeric base
2877 * to another, optionally zero-padding to a minimum column width.
2879 * Supports base 2 through 36; digit values 10-36 are represented
2880 * as lowercase letters a-z. Input is case-insensitive.
2882 * @deprecated since 1.27 Use Wikimedia\base_convert() directly
2884 * @param string $input Input number
2885 * @param int $sourceBase Base of the input number
2886 * @param int $destBase Desired base of the output
2887 * @param int $pad Minimum number of digits in the output (pad with zeroes)
2888 * @param bool $lowercase Whether to output in lowercase or uppercase
2889 * @param string $engine Either "gmp", "bcmath", or "php"
2890 * @return string|bool The output number as a string, or false on error
2892 function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1,
2893 $lowercase = true, $engine = 'auto'
2895 return Wikimedia\base_convert
( $input, $sourceBase, $destBase, $pad, $lowercase, $engine );
2899 * @deprecated since 1.27, PHP's session generation isn't used with
2900 * MediaWiki\Session\SessionManager
2902 function wfFixSessionID() {
2903 wfDeprecated( __FUNCTION__
, '1.27' );
2907 * Reset the session id
2909 * @deprecated since 1.27, use MediaWiki\Session\SessionManager instead
2912 function wfResetSessionID() {
2913 wfDeprecated( __FUNCTION__
, '1.27' );
2914 $session = SessionManager
::getGlobalSession();
2915 $delay = $session->delaySave();
2917 $session->resetId();
2919 // Make sure a session is started, since that's what the old
2920 // wfResetSessionID() did.
2921 if ( session_id() !== $session->getId() ) {
2922 wfSetupSession( $session->getId() );
2925 ScopedCallback
::consume( $delay );
2929 * Initialise php session
2931 * @deprecated since 1.27, use MediaWiki\Session\SessionManager instead.
2932 * Generally, "using" SessionManager will be calling ->getSessionById() or
2933 * ::getGlobalSession() (depending on whether you were passing $sessionId
2934 * here), then calling $session->persist().
2935 * @param bool|string $sessionId
2937 function wfSetupSession( $sessionId = false ) {
2938 wfDeprecated( __FUNCTION__
, '1.27' );
2941 session_id( $sessionId );
2944 $session = SessionManager
::getGlobalSession();
2945 $session->persist();
2947 if ( session_id() !== $session->getId() ) {
2948 session_id( $session->getId() );
2950 MediaWiki\
quietCall( 'session_start' );
2954 * Get an object from the precompiled serialized directory
2956 * @param string $name
2957 * @return mixed The variable on success, false on failure
2959 function wfGetPrecompiledData( $name ) {
2962 $file = "$IP/serialized/$name";
2963 if ( file_exists( $file ) ) {
2964 $blob = file_get_contents( $file );
2966 return unserialize( $blob );
2973 * Make a cache key for the local wiki.
2975 * @param string $args,...
2978 function wfMemcKey( /*...*/ ) {
2979 return call_user_func_array(
2980 [ ObjectCache
::getLocalClusterInstance(), 'makeKey' ],
2986 * Make a cache key for a foreign DB.
2988 * Must match what wfMemcKey() would produce in context of the foreign wiki.
2991 * @param string $prefix
2992 * @param string $args,...
2995 function wfForeignMemcKey( $db, $prefix /*...*/ ) {
2996 $args = array_slice( func_get_args(), 2 );
2997 $keyspace = $prefix ?
"$db-$prefix" : $db;
2998 return call_user_func_array(
2999 [ ObjectCache
::getLocalClusterInstance(), 'makeKeyInternal' ],
3000 [ $keyspace, $args ]
3005 * Make a cache key with database-agnostic prefix.
3007 * Doesn't have a wiki-specific namespace. Uses a generic 'global' prefix
3008 * instead. Must have a prefix as otherwise keys that use a database name
3009 * in the first segment will clash with wfMemcKey/wfForeignMemcKey.
3012 * @param string $args,...
3015 function wfGlobalCacheKey( /*...*/ ) {
3016 return call_user_func_array(
3017 [ ObjectCache
::getLocalClusterInstance(), 'makeGlobalKey' ],
3023 * Get an ASCII string identifying this wiki
3024 * This is used as a prefix in memcached keys
3028 function wfWikiID() {
3029 global $wgDBprefix, $wgDBname;
3030 if ( $wgDBprefix ) {
3031 return "$wgDBname-$wgDBprefix";
3038 * Split a wiki ID into DB name and table prefix
3040 * @param string $wiki
3044 function wfSplitWikiID( $wiki ) {
3045 $bits = explode( '-', $wiki, 2 );
3046 if ( count( $bits ) < 2 ) {
3053 * Get a Database object.
3055 * @param int $db Index of the connection to get. May be DB_MASTER for the
3056 * master (for write queries), DB_REPLICA for potentially lagged read
3057 * queries, or an integer >= 0 for a particular server.
3059 * @param string|string[] $groups Query groups. An array of group names that this query
3060 * belongs to. May contain a single string if the query is only
3063 * @param string|bool $wiki The wiki ID, or false for the current wiki
3065 * Note: multiple calls to wfGetDB(DB_REPLICA) during the course of one request
3066 * will always return the same object, unless the underlying connection or load
3067 * balancer is manually destroyed.
3069 * Note 2: use $this->getDB() in maintenance scripts that may be invoked by
3070 * updater to ensure that a proper database is being updated.
3072 * @todo Replace calls to wfGetDB with calls to LoadBalancer::getConnection()
3073 * on an injected instance of LoadBalancer.
3077 function wfGetDB( $db, $groups = [], $wiki = false ) {
3078 return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
3082 * Get a load balancer object.
3084 * @deprecated since 1.27, use MediaWikiServices::getDBLoadBalancer()
3085 * or MediaWikiServices::getDBLoadBalancerFactory() instead.
3087 * @param string|bool $wiki Wiki ID, or false for the current wiki
3088 * @return LoadBalancer
3090 function wfGetLB( $wiki = false ) {
3091 if ( $wiki === false ) {
3092 return \MediaWiki\MediaWikiServices
::getInstance()->getDBLoadBalancer();
3094 $factory = \MediaWiki\MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
3095 return $factory->getMainLB( $wiki );
3100 * Get the load balancer factory object
3102 * @deprecated since 1.27, use MediaWikiServices::getDBLoadBalancerFactory() instead.
3106 function wfGetLBFactory() {
3107 return \MediaWiki\MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
3112 * Shortcut for RepoGroup::singleton()->findFile()
3114 * @param string $title String or Title object
3115 * @param array $options Associative array of options (see RepoGroup::findFile)
3116 * @return File|bool File, or false if the file does not exist
3118 function wfFindFile( $title, $options = [] ) {
3119 return RepoGroup
::singleton()->findFile( $title, $options );
3123 * Get an object referring to a locally registered file.
3124 * Returns a valid placeholder object if the file does not exist.
3126 * @param Title|string $title
3127 * @return LocalFile|null A File, or null if passed an invalid Title
3129 function wfLocalFile( $title ) {
3130 return RepoGroup
::singleton()->getLocalRepo()->newFile( $title );
3134 * Should low-performance queries be disabled?
3137 * @codeCoverageIgnore
3139 function wfQueriesMustScale() {
3140 global $wgMiserMode;
3142 ||
( SiteStats
::pages() > 100000
3143 && SiteStats
::edits() > 1000000
3144 && SiteStats
::users() > 10000 );
3148 * Get the path to a specified script file, respecting file
3149 * extensions; this is a wrapper around $wgScriptPath etc.
3150 * except for 'index' and 'load' which use $wgScript/$wgLoadScript
3152 * @param string $script Script filename, sans extension
3155 function wfScript( $script = 'index' ) {
3156 global $wgScriptPath, $wgScript, $wgLoadScript;
3157 if ( $script === 'index' ) {
3159 } elseif ( $script === 'load' ) {
3160 return $wgLoadScript;
3162 return "{$wgScriptPath}/{$script}.php";
3167 * Get the script URL.
3169 * @return string Script URL
3171 function wfGetScriptUrl() {
3172 if ( isset( $_SERVER['SCRIPT_NAME'] ) ) {
3173 /* as it was called, minus the query string.
3175 * Some sites use Apache rewrite rules to handle subdomains,
3176 * and have PHP set up in a weird way that causes PHP_SELF
3177 * to contain the rewritten URL instead of the one that the
3178 * outside world sees.
3180 * If in this mode, use SCRIPT_URL instead, which mod_rewrite
3181 * provides containing the "before" URL.
3183 return $_SERVER['SCRIPT_NAME'];
3185 return $_SERVER['URL'];
3190 * Convenience function converts boolean values into "true"
3191 * or "false" (string) values
3193 * @param bool $value
3196 function wfBoolToStr( $value ) {
3197 return $value ?
'true' : 'false';
3201 * Get a platform-independent path to the null file, e.g. /dev/null
3205 function wfGetNull() {
3206 return wfIsWindows() ?
'NUL' : '/dev/null';
3210 * Waits for the replica DBs to catch up to the master position
3212 * Use this when updating very large numbers of rows, as in maintenance scripts,
3213 * to avoid causing too much lag. Of course, this is a no-op if there are no replica DBs.
3215 * By default this waits on the main DB cluster of the current wiki.
3216 * If $cluster is set to "*" it will wait on all DB clusters, including
3217 * external ones. If the lag being waiting on is caused by the code that
3218 * does this check, it makes since to use $ifWritesSince, particularly if
3219 * cluster is "*", to avoid excess overhead.
3221 * Never call this function after a big DB write that is still in a transaction.
3222 * This only makes sense after the possible lag inducing changes were committed.
3224 * @param float|null $ifWritesSince Only wait if writes were done since this UNIX timestamp
3225 * @param string|bool $wiki Wiki identifier accepted by wfGetLB
3226 * @param string|bool $cluster Cluster name accepted by LBFactory. Default: false.
3227 * @param int|null $timeout Max wait time. Default: 1 day (cli), ~10 seconds (web)
3228 * @return bool Success (able to connect and no timeouts reached)
3229 * @deprecated since 1.27 Use LBFactory::waitForReplication
3231 function wfWaitForSlaves(
3232 $ifWritesSince = null, $wiki = false, $cluster = false, $timeout = null
3234 if ( $timeout === null ) {
3235 $timeout = ( PHP_SAPI
=== 'cli' ) ?
86400 : 10;
3238 if ( $cluster === '*' ) {
3241 } elseif ( $wiki === false ) {
3246 wfGetLBFactory()->waitForReplication( [
3248 'cluster' => $cluster,
3249 'timeout' => $timeout,
3250 // B/C: first argument used to be "max seconds of lag"; ignore such values
3251 'ifWritesSince' => ( $ifWritesSince > 1e9
) ?
$ifWritesSince : null
3253 } catch ( DBReplicationWaitError
$e ) {
3261 * Count down from $seconds to zero on the terminal, with a one-second pause
3262 * between showing each number. For use in command-line scripts.
3264 * @codeCoverageIgnore
3265 * @param int $seconds
3267 function wfCountDown( $seconds ) {
3268 for ( $i = $seconds; $i >= 0; $i-- ) {
3269 if ( $i != $seconds ) {
3270 echo str_repeat( "\x08", strlen( $i +
1 ) );
3282 * Replace all invalid characters with '-'.
3283 * Additional characters can be defined in $wgIllegalFileChars (see T22489).
3284 * By default, $wgIllegalFileChars includes ':', '/', '\'.
3286 * @param string $name Filename to process
3289 function wfStripIllegalFilenameChars( $name ) {
3290 global $wgIllegalFileChars;
3291 $illegalFileChars = $wgIllegalFileChars ?
"|[" . $wgIllegalFileChars . "]" : '';
3292 $name = preg_replace(
3293 "/[^" . Title
::legalChars() . "]" . $illegalFileChars . "/",
3297 // $wgIllegalFileChars may not include '/' and '\', so we still need to do this
3298 $name = wfBaseName( $name );
3303 * Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit
3305 * @return int Resulting value of the memory limit.
3307 function wfMemoryLimit() {
3308 global $wgMemoryLimit;
3309 $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
3310 if ( $memlimit != -1 ) {
3311 $conflimit = wfShorthandToInteger( $wgMemoryLimit );
3312 if ( $conflimit == -1 ) {
3313 wfDebug( "Removing PHP's memory limit\n" );
3314 MediaWiki\
suppressWarnings();
3315 ini_set( 'memory_limit', $conflimit );
3316 MediaWiki\restoreWarnings
();
3318 } elseif ( $conflimit > $memlimit ) {
3319 wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
3320 MediaWiki\
suppressWarnings();
3321 ini_set( 'memory_limit', $conflimit );
3322 MediaWiki\restoreWarnings
();
3330 * Set PHP's time limit to the larger of php.ini or $wgTransactionalTimeLimit
3332 * @return int Prior time limit
3335 function wfTransactionalTimeLimit() {
3336 global $wgTransactionalTimeLimit;
3338 $timeLimit = ini_get( 'max_execution_time' );
3339 // Note that CLI scripts use 0
3340 if ( $timeLimit > 0 && $wgTransactionalTimeLimit > $timeLimit ) {
3341 set_time_limit( $wgTransactionalTimeLimit );
3344 ignore_user_abort( true ); // ignore client disconnects
3350 * Converts shorthand byte notation to integer form
3352 * @param string $string
3353 * @param int $default Returned if $string is empty
3356 function wfShorthandToInteger( $string = '', $default = -1 ) {
3357 $string = trim( $string );
3358 if ( $string === '' ) {
3361 $last = $string[strlen( $string ) - 1];
3362 $val = intval( $string );
3367 // break intentionally missing
3371 // break intentionally missing
3381 * Get the normalised IETF language tag
3382 * See unit test for examples.
3384 * @param string $code The language code.
3385 * @return string The language code which complying with BCP 47 standards.
3387 function wfBCP47( $code ) {
3388 $codeSegment = explode( '-', $code );
3390 foreach ( $codeSegment as $segNo => $seg ) {
3391 // when previous segment is x, it is a private segment and should be lc
3392 if ( $segNo > 0 && strtolower( $codeSegment[( $segNo - 1 )] ) == 'x' ) {
3393 $codeBCP[$segNo] = strtolower( $seg );
3394 // ISO 3166 country code
3395 } elseif ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) {
3396 $codeBCP[$segNo] = strtoupper( $seg );
3397 // ISO 15924 script code
3398 } elseif ( ( strlen( $seg ) == 4 ) && ( $segNo > 0 ) ) {
3399 $codeBCP[$segNo] = ucfirst( strtolower( $seg ) );
3400 // Use lowercase for other cases
3402 $codeBCP[$segNo] = strtolower( $seg );
3405 $langCode = implode( '-', $codeBCP );
3410 * Get a specific cache object.
3412 * @param int|string $cacheType A CACHE_* constants, or other key in $wgObjectCaches
3415 function wfGetCache( $cacheType ) {
3416 return ObjectCache
::getInstance( $cacheType );
3420 * Get the main cache object
3424 function wfGetMainCache() {
3425 global $wgMainCacheType;
3426 return ObjectCache
::getInstance( $wgMainCacheType );
3430 * Get the cache object used by the message cache
3434 function wfGetMessageCacheStorage() {
3435 global $wgMessageCacheType;
3436 return ObjectCache
::getInstance( $wgMessageCacheType );
3440 * Get the cache object used by the parser cache
3444 function wfGetParserCacheStorage() {
3445 global $wgParserCacheType;
3446 return ObjectCache
::getInstance( $wgParserCacheType );
3450 * Call hook functions defined in $wgHooks
3452 * @param string $event Event name
3453 * @param array $args Parameters passed to hook functions
3454 * @param string|null $deprecatedVersion Optionally mark hook as deprecated with version number
3456 * @return bool True if no handler aborted the hook
3457 * @deprecated since 1.25 - use Hooks::run
3459 function wfRunHooks( $event, array $args = [], $deprecatedVersion = null ) {
3460 return Hooks
::run( $event, $args, $deprecatedVersion );
3464 * Wrapper around php's unpack.
3466 * @param string $format The format string (See php's docs)
3467 * @param string $data A binary string of binary data
3468 * @param int|bool $length The minimum length of $data or false. This is to
3469 * prevent reading beyond the end of $data. false to disable the check.
3471 * Also be careful when using this function to read unsigned 32 bit integer
3472 * because php might make it negative.
3474 * @throws MWException If $data not long enough, or if unpack fails
3475 * @return array Associative array of the extracted data
3477 function wfUnpack( $format, $data, $length = false ) {
3478 if ( $length !== false ) {
3479 $realLen = strlen( $data );
3480 if ( $realLen < $length ) {
3481 throw new MWException( "Tried to use wfUnpack on a "
3482 . "string of length $realLen, but needed one "
3483 . "of at least length $length."
3488 MediaWiki\
suppressWarnings();
3489 $result = unpack( $format, $data );
3490 MediaWiki\restoreWarnings
();
3492 if ( $result === false ) {
3493 // If it cannot extract the packed data.
3494 throw new MWException( "unpack could not unpack binary data" );
3500 * Determine if an image exists on the 'bad image list'.
3502 * The format of MediaWiki:Bad_image_list is as follows:
3503 * * Only list items (lines starting with "*") are considered
3504 * * The first link on a line must be a link to a bad image
3505 * * Any subsequent links on the same line are considered to be exceptions,
3506 * i.e. articles where the image may occur inline.
3508 * @param string $name The image name to check
3509 * @param Title|bool $contextTitle The page on which the image occurs, if known
3510 * @param string $blacklist Wikitext of a file blacklist
3513 function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
3514 # Handle redirects; callers almost always hit wfFindFile() anyway,
3515 # so just use that method because it has a fast process cache.
3516 $file = wfFindFile( $name ); // get the final name
3517 $name = $file ?
$file->getTitle()->getDBkey() : $name;
3519 # Run the extension hook
3521 if ( !Hooks
::run( 'BadImage', [ $name, &$bad ] ) ) {
3525 $cache = ObjectCache
::getLocalServerInstance( 'hash' );
3526 $key = wfMemcKey( 'bad-image-list', ( $blacklist === null ) ?
'default' : md5( $blacklist ) );
3527 $badImages = $cache->get( $key );
3529 if ( $badImages === false ) { // cache miss
3530 if ( $blacklist === null ) {
3531 $blacklist = wfMessage( 'bad_image_list' )->inContentLanguage()->plain(); // site list
3533 # Build the list now
3535 $lines = explode( "\n", $blacklist );
3536 foreach ( $lines as $line ) {
3538 if ( substr( $line, 0, 1 ) !== '*' ) {
3544 if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
3549 $imageDBkey = false;
3550 foreach ( $m[1] as $i => $titleText ) {
3551 $title = Title
::newFromText( $titleText );
3552 if ( !is_null( $title ) ) {
3554 $imageDBkey = $title->getDBkey();
3556 $exceptions[$title->getPrefixedDBkey()] = true;
3561 if ( $imageDBkey !== false ) {
3562 $badImages[$imageDBkey] = $exceptions;
3565 $cache->set( $key, $badImages, 60 );
3568 $contextKey = $contextTitle ?
$contextTitle->getPrefixedDBkey() : false;
3569 $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
3575 * Determine whether the client at a given source IP is likely to be able to
3576 * access the wiki via HTTPS.
3578 * @param string $ip The IPv4/6 address in the normal human-readable form
3581 function wfCanIPUseHTTPS( $ip ) {
3583 Hooks
::run( 'CanIPUseHTTPS', [ $ip, &$canDo ] );
3588 * Determine input string is represents as infinity
3590 * @param string $str The string to determine
3594 function wfIsInfinity( $str ) {
3595 $infinityValues = [ 'infinite', 'indefinite', 'infinity', 'never' ];
3596 return in_array( $str, $infinityValues );
3600 * Returns true if these thumbnail parameters match one that MediaWiki
3601 * requests from file description pages and/or parser output.
3603 * $params is considered non-standard if they involve a non-standard
3604 * width or any non-default parameters aside from width and page number.
3605 * The number of possible files with standard parameters is far less than
3606 * that of all combinations; rate-limiting for them can thus be more generious.
3609 * @param array $params
3611 * @since 1.24 Moved from thumb.php to GlobalFunctions in 1.25
3613 function wfThumbIsStandard( File
$file, array $params ) {
3614 global $wgThumbLimits, $wgImageLimits, $wgResponsiveImages;
3616 $multipliers = [ 1 ];
3617 if ( $wgResponsiveImages ) {
3618 // These available sizes are hardcoded currently elsewhere in MediaWiki.
3619 // @see Linker::processResponsiveImages
3620 $multipliers[] = 1.5;
3624 $handler = $file->getHandler();
3625 if ( !$handler ||
!isset( $params['width'] ) ) {
3630 if ( isset( $params['page'] ) ) {
3631 $basicParams['page'] = $params['page'];
3636 // Expand limits to account for multipliers
3637 foreach ( $multipliers as $multiplier ) {
3638 $thumbLimits = array_merge( $thumbLimits, array_map(
3639 function ( $width ) use ( $multiplier ) {
3640 return round( $width * $multiplier );
3643 $imageLimits = array_merge( $imageLimits, array_map(
3644 function ( $pair ) use ( $multiplier ) {
3646 round( $pair[0] * $multiplier ),
3647 round( $pair[1] * $multiplier ),
3653 // Check if the width matches one of $wgThumbLimits
3654 if ( in_array( $params['width'], $thumbLimits ) ) {
3655 $normalParams = $basicParams +
[ 'width' => $params['width'] ];
3656 // Append any default values to the map (e.g. "lossy", "lossless", ...)
3657 $handler->normaliseParams( $file, $normalParams );
3659 // If not, then check if the width matchs one of $wgImageLimits
3661 foreach ( $imageLimits as $pair ) {
3662 $normalParams = $basicParams +
[ 'width' => $pair[0], 'height' => $pair[1] ];
3663 // Decide whether the thumbnail should be scaled on width or height.
3664 // Also append any default values to the map (e.g. "lossy", "lossless", ...)
3665 $handler->normaliseParams( $file, $normalParams );
3666 // Check if this standard thumbnail size maps to the given width
3667 if ( $normalParams['width'] == $params['width'] ) {
3673 return false; // not standard for description pages
3677 // Check that the given values for non-page, non-width, params are just defaults
3678 foreach ( $params as $key => $value ) {
3679 if ( !isset( $normalParams[$key] ) ||
$normalParams[$key] != $value ) {
3688 * Merges two (possibly) 2 dimensional arrays into the target array ($baseArray).
3690 * Values that exist in both values will be combined with += (all values of the array
3691 * of $newValues will be added to the values of the array of $baseArray, while values,
3692 * that exists in both, the value of $baseArray will be used).
3694 * @param array $baseArray The array where you want to add the values of $newValues to
3695 * @param array $newValues An array with new values
3696 * @return array The combined array
3699 function wfArrayPlus2d( array $baseArray, array $newValues ) {
3700 // First merge items that are in both arrays
3701 foreach ( $baseArray as $name => &$groupVal ) {
3702 if ( isset( $newValues[$name] ) ) {
3703 $groupVal +
= $newValues[$name];
3706 // Now add items that didn't exist yet
3707 $baseArray +
= $newValues;