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 MediaWiki\Logger\LoggerFactory
;
28 use MediaWiki\ProcOpenError
;
29 use MediaWiki\Session\SessionManager
;
30 use MediaWiki\MediaWikiServices
;
31 use MediaWiki\Shell\Shell
;
32 use Wikimedia\ScopedCallback
;
33 use Wikimedia\WrappedString
;
38 * This queues an extension to be loaded through
39 * the ExtensionRegistry system.
41 * @param string $ext Name of the extension to load
42 * @param string|null $path Absolute path of where to find the extension.json file
45 function wfLoadExtension( $ext, $path = null ) {
47 global $wgExtensionDirectory;
48 $path = "$wgExtensionDirectory/$ext/extension.json";
50 ExtensionRegistry
::getInstance()->queue( $path );
54 * Load multiple extensions at once
56 * Same as wfLoadExtension, but more efficient if you
57 * are loading multiple extensions.
59 * If you want to specify custom paths, you should interact with
60 * ExtensionRegistry directly.
62 * @see wfLoadExtension
63 * @param string[] $exts Array of extension names to load
66 function wfLoadExtensions( array $exts ) {
67 global $wgExtensionDirectory;
68 $registry = ExtensionRegistry
::getInstance();
69 foreach ( $exts as $ext ) {
70 $registry->queue( "$wgExtensionDirectory/$ext/extension.json" );
77 * @see wfLoadExtension
78 * @param string $skin Name of the extension to load
79 * @param string|null $path Absolute path of where to find the skin.json file
82 function wfLoadSkin( $skin, $path = null ) {
84 global $wgStyleDirectory;
85 $path = "$wgStyleDirectory/$skin/skin.json";
87 ExtensionRegistry
::getInstance()->queue( $path );
91 * Load multiple skins at once
93 * @see wfLoadExtensions
94 * @param string[] $skins Array of extension names to load
97 function wfLoadSkins( array $skins ) {
98 global $wgStyleDirectory;
99 $registry = ExtensionRegistry
::getInstance();
100 foreach ( $skins as $skin ) {
101 $registry->queue( "$wgStyleDirectory/$skin/skin.json" );
106 * Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
111 function wfArrayDiff2( $a, $b ) {
112 return array_udiff( $a, $b, 'wfArrayDiff2_cmp' );
116 * @param array|string $a
117 * @param array|string $b
120 function wfArrayDiff2_cmp( $a, $b ) {
121 if ( is_string( $a ) && is_string( $b ) ) {
122 return strcmp( $a, $b );
123 } elseif ( count( $a ) !== count( $b ) ) {
124 return count( $a ) <=> count( $b );
128 while ( key( $a ) !== null && key( $b ) !== null ) {
129 $valueA = current( $a );
130 $valueB = current( $b );
131 $cmp = strcmp( $valueA, $valueB );
143 * @deprecated since 1.32, use array_filter() with ARRAY_FILTER_USE_BOTH directly
146 * @param callable $callback Will be called with the array value and key (in that order) and
147 * should return a bool which will determine whether the array element is kept.
150 function wfArrayFilter( array $arr, callable
$callback ) {
151 return array_filter( $arr, $callback, ARRAY_FILTER_USE_BOTH
);
155 * @deprecated since 1.32, use array_filter() with ARRAY_FILTER_USE_KEY directly
158 * @param callable $callback Will be called with the array key and should return a bool which
159 * will determine whether the array element is kept.
162 function wfArrayFilterByKey( array $arr, callable
$callback ) {
163 return array_filter( $arr, $callback, ARRAY_FILTER_USE_KEY
);
167 * Appends to second array if $value differs from that in $default
169 * @param string|int $key
170 * @param mixed $value
171 * @param mixed $default
172 * @param array &$changed Array to alter
173 * @throws MWException
175 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
176 if ( is_null( $changed ) ) {
177 throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' );
179 if ( $default[$key] !== $value ) {
180 $changed[$key] = $value;
185 * Merge arrays in the style of getUserPermissionsErrors, with duplicate removal
187 * wfMergeErrorArrays(
200 * @param array ...$args
203 function wfMergeErrorArrays( ...$args ) {
205 foreach ( $args as $errors ) {
206 foreach ( $errors as $params ) {
207 $originalParams = $params;
208 if ( $params[0] instanceof MessageSpecifier
) {
210 $params = array_merge( [ $msg->getKey() ], $msg->getParams() );
212 # @todo FIXME: Sometimes get nested arrays for $params,
213 # which leads to E_NOTICEs
214 $spec = implode( "\t", $params );
215 $out[$spec] = $originalParams;
218 return array_values( $out );
222 * Insert array into another array after the specified *KEY*
224 * @param array $array The array.
225 * @param array $insert The array to insert.
226 * @param mixed $after The key to insert after
229 function wfArrayInsertAfter( array $array, array $insert, $after ) {
230 // Find the offset of the element to insert after.
231 $keys = array_keys( $array );
232 $offsetByKey = array_flip( $keys );
234 $offset = $offsetByKey[$after];
236 // Insert at the specified offset
237 $before = array_slice( $array, 0, $offset +
1, true );
238 $after = array_slice( $array, $offset +
1, count( $array ) - $offset, true );
240 $output = $before +
$insert +
$after;
246 * Recursively converts the parameter (an object) to an array with the same data
248 * @param object|array $objOrArray
249 * @param bool $recursive
252 function wfObjectToArray( $objOrArray, $recursive = true ) {
254 if ( is_object( $objOrArray ) ) {
255 $objOrArray = get_object_vars( $objOrArray );
257 foreach ( $objOrArray as $key => $value ) {
258 if ( $recursive && ( is_object( $value ) ||
is_array( $value ) ) ) {
259 $value = wfObjectToArray( $value );
262 $array[$key] = $value;
269 * Get a random decimal value in the domain of [0, 1), in a way
270 * not likely to give duplicate values for any realistic
271 * number of articles.
273 * @note This is designed for use in relation to Special:RandomPage
274 * and the page_random database field.
278 function wfRandom() {
279 // The maximum random value is "only" 2^31-1, so get two random
280 // values to reduce the chance of dupes
281 $max = mt_getrandmax() +
1;
282 $rand = number_format( ( mt_rand() * $max +
mt_rand() ) / $max / $max, 12, '.', '' );
287 * Get a random string containing a number of pseudo-random hex characters.
289 * @note This is not secure, if you are trying to generate some sort
290 * of token please use MWCryptRand instead.
292 * @param int $length The length of the string to generate
296 function wfRandomString( $length = 32 ) {
298 for ( $n = 0; $n < $length; $n +
= 7 ) {
299 $str .= sprintf( '%07x', mt_rand() & 0xfffffff );
301 return substr( $str, 0, $length );
305 * We want some things to be included as literal characters in our title URLs
306 * for prettiness, which urlencode encodes by default. According to RFC 1738,
307 * all of the following should be safe:
311 * RFC 1738 says ~ is unsafe, however RFC 3986 considers it an unreserved
312 * character which should not be encoded. More importantly, google chrome
313 * always converts %7E back to ~, and converting it in this function can
314 * cause a redirect loop (T105265).
316 * But + is not safe because it's used to indicate a space; &= are only safe in
317 * paths and not in queries (and we don't distinguish here); ' seems kind of
318 * scary; and urlencode() doesn't touch -_. to begin with. Plus, although /
319 * is reserved, we don't care. So the list we unescape is:
323 * However, IIS7 redirects fail when the url contains a colon (see T24709),
324 * so no fancy : for IIS7.
326 * %2F in the page titles seems to fatally break for some reason.
331 function wfUrlencode( $s ) {
334 if ( is_null( $s ) ) {
339 if ( is_null( $needle ) ) {
340 $needle = [ '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F', '%7E' ];
341 if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) ||
342 ( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false )
348 $s = urlencode( $s );
351 [ ';', '@', '$', '!', '*', '(', ')', ',', '/', '~', ':' ],
359 * This function takes one or two arrays as input, and returns a CGI-style string, e.g.
360 * "days=7&limit=100". Options in the first array override options in the second.
361 * Options set to null or false will not be output.
363 * @param array $array1 ( String|Array )
364 * @param array|null $array2 ( String|Array )
365 * @param string $prefix
368 function wfArrayToCgi( $array1, $array2 = null, $prefix = '' ) {
369 if ( !is_null( $array2 ) ) {
370 $array1 = $array1 +
$array2;
374 foreach ( $array1 as $key => $value ) {
375 if ( !is_null( $value ) && $value !== false ) {
379 if ( $prefix !== '' ) {
380 $key = $prefix . "[$key]";
382 if ( is_array( $value ) ) {
384 foreach ( $value as $k => $v ) {
385 $cgi .= $firstTime ?
'' : '&';
386 if ( is_array( $v ) ) {
387 $cgi .= wfArrayToCgi( $v, null, $key . "[$k]" );
389 $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v );
394 if ( is_object( $value ) ) {
395 $value = $value->__toString();
397 $cgi .= urlencode( $key ) . '=' . urlencode( $value );
405 * This is the logical opposite of wfArrayToCgi(): it accepts a query string as
406 * its argument and returns the same string in array form. This allows compatibility
407 * with legacy functions that accept raw query strings instead of nice
408 * arrays. Of course, keys and values are urldecode()d.
410 * @param string $query Query string
411 * @return string[] Array version of input
413 function wfCgiToArray( $query ) {
414 if ( isset( $query[0] ) && $query[0] == '?' ) {
415 $query = substr( $query, 1 );
417 $bits = explode( '&', $query );
419 foreach ( $bits as $bit ) {
423 if ( strpos( $bit, '=' ) === false ) {
424 // Pieces like &qwerty become 'qwerty' => '' (at least this is what php does)
428 list( $key, $value ) = explode( '=', $bit );
430 $key = urldecode( $key );
431 $value = urldecode( $value );
432 if ( strpos( $key, '[' ) !== false ) {
433 $keys = array_reverse( explode( '[', $key ) );
434 $key = array_pop( $keys );
436 foreach ( $keys as $k ) {
437 $k = substr( $k, 0, -1 );
438 $temp = [ $k => $temp ];
440 if ( isset( $ret[$key] ) ) {
441 $ret[$key] = array_merge( $ret[$key], $temp );
453 * Append a query string to an existing URL, which may or may not already
454 * have query string parameters already. If so, they will be combined.
457 * @param string|string[] $query String or associative array
460 function wfAppendQuery( $url, $query ) {
461 if ( is_array( $query ) ) {
462 $query = wfArrayToCgi( $query );
464 if ( $query != '' ) {
465 // Remove the fragment, if there is one
467 $hashPos = strpos( $url, '#' );
468 if ( $hashPos !== false ) {
469 $fragment = substr( $url, $hashPos );
470 $url = substr( $url, 0, $hashPos );
474 if ( strpos( $url, '?' ) === false ) {
481 // Put the fragment back
482 if ( $fragment !== false ) {
490 * Expand a potentially local URL to a fully-qualified URL. Assumes $wgServer
493 * The meaning of the PROTO_* constants is as follows:
494 * PROTO_HTTP: Output a URL starting with http://
495 * PROTO_HTTPS: Output a URL starting with https://
496 * PROTO_RELATIVE: Output a URL starting with // (protocol-relative URL)
497 * PROTO_CURRENT: Output a URL starting with either http:// or https:// , depending
498 * on which protocol was used for the current incoming request
499 * PROTO_CANONICAL: For URLs without a domain, like /w/index.php , use $wgCanonicalServer.
500 * For protocol-relative URLs, use the protocol of $wgCanonicalServer
501 * PROTO_INTERNAL: Like PROTO_CANONICAL, but uses $wgInternalServer instead of $wgCanonicalServer
503 * @todo this won't work with current-path-relative URLs
504 * like "subdir/foo.html", etc.
506 * @param string $url Either fully-qualified or a local path + query
507 * @param string|int|null $defaultProto One of the PROTO_* constants. Determines the
508 * protocol to use if $url or $wgServer is protocol-relative
509 * @return string|false Fully-qualified URL, current-path-relative URL or false if
510 * no valid URL can be constructed
512 function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT
) {
513 global $wgServer, $wgCanonicalServer, $wgInternalServer, $wgRequest,
515 if ( $defaultProto === PROTO_CANONICAL
) {
516 $serverUrl = $wgCanonicalServer;
517 } elseif ( $defaultProto === PROTO_INTERNAL
&& $wgInternalServer !== false ) {
518 // Make $wgInternalServer fall back to $wgServer if not set
519 $serverUrl = $wgInternalServer;
521 $serverUrl = $wgServer;
522 if ( $defaultProto === PROTO_CURRENT
) {
523 $defaultProto = $wgRequest->getProtocol() . '://';
527 // Analyze $serverUrl to obtain its protocol
528 $bits = wfParseUrl( $serverUrl );
529 $serverHasProto = $bits && $bits['scheme'] != '';
531 if ( $defaultProto === PROTO_CANONICAL ||
$defaultProto === PROTO_INTERNAL
) {
532 if ( $serverHasProto ) {
533 $defaultProto = $bits['scheme'] . '://';
535 // $wgCanonicalServer or $wgInternalServer doesn't have a protocol.
536 // This really isn't supposed to happen. Fall back to HTTP in this
538 $defaultProto = PROTO_HTTP
;
542 $defaultProtoWithoutSlashes = substr( $defaultProto, 0, -2 );
544 if ( substr( $url, 0, 2 ) == '//' ) {
545 $url = $defaultProtoWithoutSlashes . $url;
546 } elseif ( substr( $url, 0, 1 ) == '/' ) {
547 // If $serverUrl is protocol-relative, prepend $defaultProtoWithoutSlashes,
548 // otherwise leave it alone.
549 if ( $serverHasProto ) {
550 $url = $serverUrl . $url;
552 // If an HTTPS URL is synthesized from a protocol-relative $wgServer, allow the
553 // user to override the port number (T67184)
554 if ( $defaultProto === PROTO_HTTPS
&& $wgHttpsPort != 443 ) {
555 if ( isset( $bits['port'] ) ) {
556 throw new Exception( 'A protocol-relative $wgServer may not contain a port number' );
558 $url = $defaultProtoWithoutSlashes . $serverUrl . ':' . $wgHttpsPort . $url;
560 $url = $defaultProtoWithoutSlashes . $serverUrl . $url;
565 $bits = wfParseUrl( $url );
567 if ( $bits && isset( $bits['path'] ) ) {
568 $bits['path'] = wfRemoveDotSegments( $bits['path'] );
569 return wfAssembleUrl( $bits );
573 } elseif ( substr( $url, 0, 1 ) != '/' ) {
574 # URL is a relative path
575 return wfRemoveDotSegments( $url );
578 # Expanded URL is not valid.
583 * Get the wiki's "server", i.e. the protocol and host part of the URL, with a
584 * protocol specified using a PROTO_* constant as in wfExpandUrl()
587 * @param string|int|null $proto One of the PROTO_* constants.
588 * @return string The URL
590 function wfGetServerUrl( $proto ) {
591 $url = wfExpandUrl( '/', $proto );
592 return substr( $url, 0, -1 );
596 * This function will reassemble a URL parsed with wfParseURL. This is useful
597 * if you need to edit part of a URL and put it back together.
599 * This is the basic structure used (brackets contain keys for $urlParts):
600 * [scheme][delimiter][user]:[pass]@[host]:[port][path]?[query]#[fragment]
602 * @todo Need to integrate this into wfExpandUrl (see T34168)
605 * @param array $urlParts URL parts, as output from wfParseUrl
606 * @return string URL assembled from its component parts
608 function wfAssembleUrl( $urlParts ) {
611 if ( isset( $urlParts['delimiter'] ) ) {
612 if ( isset( $urlParts['scheme'] ) ) {
613 $result .= $urlParts['scheme'];
616 $result .= $urlParts['delimiter'];
619 if ( isset( $urlParts['host'] ) ) {
620 if ( isset( $urlParts['user'] ) ) {
621 $result .= $urlParts['user'];
622 if ( isset( $urlParts['pass'] ) ) {
623 $result .= ':' . $urlParts['pass'];
628 $result .= $urlParts['host'];
630 if ( isset( $urlParts['port'] ) ) {
631 $result .= ':' . $urlParts['port'];
635 if ( isset( $urlParts['path'] ) ) {
636 $result .= $urlParts['path'];
639 if ( isset( $urlParts['query'] ) ) {
640 $result .= '?' . $urlParts['query'];
643 if ( isset( $urlParts['fragment'] ) ) {
644 $result .= '#' . $urlParts['fragment'];
651 * Remove all dot-segments in the provided URL path. For example,
652 * '/a/./b/../c/' becomes '/a/c/'. For details on the algorithm, please see
653 * RFC3986 section 5.2.4.
655 * @todo Need to integrate this into wfExpandUrl (see T34168)
659 * @param string $urlPath URL path, potentially containing dot-segments
660 * @return string URL path with all dot-segments removed
662 function wfRemoveDotSegments( $urlPath ) {
665 $inputLength = strlen( $urlPath );
667 while ( $inputOffset < $inputLength ) {
668 $prefixLengthOne = substr( $urlPath, $inputOffset, 1 );
669 $prefixLengthTwo = substr( $urlPath, $inputOffset, 2 );
670 $prefixLengthThree = substr( $urlPath, $inputOffset, 3 );
671 $prefixLengthFour = substr( $urlPath, $inputOffset, 4 );
674 if ( $prefixLengthTwo == './' ) {
675 # Step A, remove leading "./"
677 } elseif ( $prefixLengthThree == '../' ) {
678 # Step A, remove leading "../"
680 } elseif ( ( $prefixLengthTwo == '/.' ) && ( $inputOffset +
2 == $inputLength ) ) {
681 # Step B, replace leading "/.$" with "/"
683 $urlPath[$inputOffset] = '/';
684 } elseif ( $prefixLengthThree == '/./' ) {
685 # Step B, replace leading "/./" with "/"
687 } elseif ( $prefixLengthThree == '/..' && ( $inputOffset +
3 == $inputLength ) ) {
688 # Step C, replace leading "/..$" with "/" and
689 # remove last path component in output
691 $urlPath[$inputOffset] = '/';
693 } elseif ( $prefixLengthFour == '/../' ) {
694 # Step C, replace leading "/../" with "/" and
695 # remove last path component in output
698 } elseif ( ( $prefixLengthOne == '.' ) && ( $inputOffset +
1 == $inputLength ) ) {
699 # Step D, remove "^.$"
701 } elseif ( ( $prefixLengthTwo == '..' ) && ( $inputOffset +
2 == $inputLength ) ) {
702 # Step D, remove "^..$"
705 # Step E, move leading path segment to output
706 if ( $prefixLengthOne == '/' ) {
707 $slashPos = strpos( $urlPath, '/', $inputOffset +
1 );
709 $slashPos = strpos( $urlPath, '/', $inputOffset );
711 if ( $slashPos === false ) {
712 $output .= substr( $urlPath, $inputOffset );
713 $inputOffset = $inputLength;
715 $output .= substr( $urlPath, $inputOffset, $slashPos - $inputOffset );
716 $inputOffset +
= $slashPos - $inputOffset;
721 $slashPos = strrpos( $output, '/' );
722 if ( $slashPos === false ) {
725 $output = substr( $output, 0, $slashPos );
734 * Returns a regular expression of url protocols
736 * @param bool $includeProtocolRelative If false, remove '//' from the returned protocol list.
737 * DO NOT USE this directly, use wfUrlProtocolsWithoutProtRel() instead
740 function wfUrlProtocols( $includeProtocolRelative = true ) {
741 global $wgUrlProtocols;
743 // Cache return values separately based on $includeProtocolRelative
744 static $withProtRel = null, $withoutProtRel = null;
745 $cachedValue = $includeProtocolRelative ?
$withProtRel : $withoutProtRel;
746 if ( !is_null( $cachedValue ) ) {
750 // Support old-style $wgUrlProtocols strings, for backwards compatibility
751 // with LocalSettings files from 1.5
752 if ( is_array( $wgUrlProtocols ) ) {
754 foreach ( $wgUrlProtocols as $protocol ) {
755 // Filter out '//' if !$includeProtocolRelative
756 if ( $includeProtocolRelative ||
$protocol !== '//' ) {
757 $protocols[] = preg_quote( $protocol, '/' );
761 $retval = implode( '|', $protocols );
763 // Ignore $includeProtocolRelative in this case
764 // This case exists for pre-1.6 compatibility, and we can safely assume
765 // that '//' won't appear in a pre-1.6 config because protocol-relative
766 // URLs weren't supported until 1.18
767 $retval = $wgUrlProtocols;
770 // Cache return value
771 if ( $includeProtocolRelative ) {
772 $withProtRel = $retval;
774 $withoutProtRel = $retval;
780 * Like wfUrlProtocols(), but excludes '//' from the protocol list. Use this if
781 * you need a regex that matches all URL protocols but does not match protocol-
785 function wfUrlProtocolsWithoutProtRel() {
786 return wfUrlProtocols( false );
790 * parse_url() work-alike, but non-broken. Differences:
792 * 1) Does not raise warnings on bad URLs (just returns false).
793 * 2) Handles protocols that don't use :// (e.g., mailto: and news:, as well as
794 * protocol-relative URLs) correctly.
795 * 3) Adds a "delimiter" element to the array (see (2)).
796 * 4) Verifies that the protocol is on the $wgUrlProtocols whitelist.
797 * 5) Rejects some invalid URLs that parse_url doesn't, e.g. the empty string or URLs starting with
798 * a line feed character.
800 * @param string $url A URL to parse
801 * @return string[]|bool Bits of the URL in an associative array, or false on failure.
803 * - scheme: URI scheme (protocol), e.g. 'http', 'mailto'. Lowercase, always present, but can
804 * be an empty string for protocol-relative URLs.
805 * - delimiter: either '://', ':' or '//'. Always present.
806 * - host: domain name / IP. Always present, but could be an empty string, e.g. for file: URLs.
807 * - user: user name, e.g. for HTTP Basic auth URLs such as http://user:pass@example.com/
808 * Missing when there is no username.
809 * - pass: password, same as above.
810 * - path: path including the leading /. Will be missing when empty (e.g. 'http://example.com')
811 * - query: query string (as a string; see wfCgiToArray() for parsing it), can be missing.
812 * - fragment: the part after #, can be missing.
814 function wfParseUrl( $url ) {
815 global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
817 // Protocol-relative URLs are handled really badly by parse_url(). It's so
818 // bad that the easiest way to handle them is to just prepend 'http:' and
819 // strip the protocol out later.
820 $wasRelative = substr( $url, 0, 2 ) == '//';
821 if ( $wasRelative ) {
824 Wikimedia\
suppressWarnings();
825 $bits = parse_url( $url );
826 Wikimedia\restoreWarnings
();
827 // parse_url() returns an array without scheme for some invalid URLs, e.g.
828 // parse_url("%0Ahttp://example.com") == [ 'host' => '%0Ahttp', 'path' => 'example.com' ]
829 if ( !$bits ||
!isset( $bits['scheme'] ) ) {
833 // parse_url() incorrectly handles schemes case-sensitively. Convert it to lowercase.
834 $bits['scheme'] = strtolower( $bits['scheme'] );
836 // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
837 if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
838 $bits['delimiter'] = '://';
839 } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
840 $bits['delimiter'] = ':';
841 // parse_url detects for news: and mailto: the host part of an url as path
842 // We have to correct this wrong detection
843 if ( isset( $bits['path'] ) ) {
844 $bits['host'] = $bits['path'];
851 /* Provide an empty host for eg. file:/// urls (see T30627) */
852 if ( !isset( $bits['host'] ) ) {
856 if ( isset( $bits['path'] ) ) {
857 /* parse_url loses the third / for file:///c:/ urls (but not on variants) */
858 if ( substr( $bits['path'], 0, 1 ) !== '/' ) {
859 $bits['path'] = '/' . $bits['path'];
866 // If the URL was protocol-relative, fix scheme and delimiter
867 if ( $wasRelative ) {
868 $bits['scheme'] = '';
869 $bits['delimiter'] = '//';
875 * Take a URL, make sure it's expanded to fully qualified, and replace any
876 * encoded non-ASCII Unicode characters with their UTF-8 original forms
877 * for more compact display and legibility for local audiences.
879 * @todo handle punycode domains too
884 function wfExpandIRI( $url ) {
885 return preg_replace_callback(
886 '/((?:%[89A-F][0-9A-F])+)/i',
887 function ( array $matches ) {
888 return urldecode( $matches[1] );
895 * Make URL indexes, appropriate for the el_index field of externallinks.
897 * @deprecated since 1.33, use LinkFilter::makeIndexes() instead
901 function wfMakeUrlIndexes( $url ) {
902 wfDeprecated( __FUNCTION__
, '1.33' );
903 return LinkFilter
::makeIndexes( $url );
907 * Check whether a given URL has a domain that occurs in a given set of domains
909 * @param array $domains Array of domains (strings)
910 * @return bool True if the host part of $url ends in one of the strings in $domains
912 function wfMatchesDomainList( $url, $domains ) {
913 $bits = wfParseUrl( $url );
914 if ( is_array( $bits ) && isset( $bits['host'] ) ) {
915 $host = '.' . $bits['host'];
916 foreach ( (array)$domains as $domain ) {
917 $domain = '.' . $domain;
918 if ( substr( $host, -strlen( $domain ) ) === $domain ) {
927 * Sends a line to the debug log if enabled or, optionally, to a comment in output.
928 * In normal operation this is a NOP.
930 * Controlling globals:
931 * $wgDebugLogFile - points to the log file
932 * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
933 * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
935 * @since 1.25 support for additional context data
937 * @param string $text
938 * @param string|bool $dest Destination of the message:
939 * - 'all': both to the log and HTML (debug toolbar or HTML comments)
940 * - 'private': excluded from HTML output
941 * For backward compatibility, it can also take a boolean:
942 * - true: same as 'all'
943 * - false: same as 'private'
944 * @param array $context Additional logging context data
946 function wfDebug( $text, $dest = 'all', array $context = [] ) {
947 global $wgDebugRawPage, $wgDebugLogPrefix;
948 global $wgDebugTimestamps;
950 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
954 $text = trim( $text );
956 if ( $wgDebugTimestamps ) {
957 $context['seconds_elapsed'] = sprintf(
959 microtime( true ) - $_SERVER['REQUEST_TIME_FLOAT']
961 $context['memory_used'] = sprintf(
963 ( memory_get_usage( true ) / ( 1024 * 1024 ) )
967 if ( $wgDebugLogPrefix !== '' ) {
968 $context['prefix'] = $wgDebugLogPrefix;
970 $context['private'] = ( $dest === false ||
$dest === 'private' );
972 $logger = LoggerFactory
::getInstance( 'wfDebug' );
973 $logger->debug( $text, $context );
977 * Returns true if debug logging should be suppressed if $wgDebugRawPage = false
980 function wfIsDebugRawPage() {
982 if ( $cache !== null ) {
985 // Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
986 // phpcs:ignore MediaWiki.Usage.SuperGlobalsUsage.SuperGlobals
987 if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
989 isset( $_SERVER['SCRIPT_NAME'] )
990 && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
1001 * Send a line giving PHP memory usage.
1003 * @param bool $exact Print exact byte values instead of kibibytes (default: false)
1005 function wfDebugMem( $exact = false ) {
1006 $mem = memory_get_usage();
1008 $mem = floor( $mem / 1024 ) . ' KiB';
1012 wfDebug( "Memory usage: $mem\n" );
1016 * Send a line to a supplementary debug log file, if configured, or main debug
1019 * To configure a supplementary log file, set $wgDebugLogGroups[$logGroup] to
1020 * a string filename or an associative array mapping 'destination' to the
1021 * desired filename. The associative array may also contain a 'sample' key
1022 * with an integer value, specifying a sampling factor. Sampled log events
1023 * will be emitted with a 1 in N random chance.
1025 * @since 1.23 support for sampling log messages via $wgDebugLogGroups.
1026 * @since 1.25 support for additional context data
1027 * @since 1.25 sample behavior dependent on configured $wgMWLoggerDefaultSpi
1029 * @param string $logGroup
1030 * @param string $text
1031 * @param string|bool $dest Destination of the message:
1032 * - 'all': both to the log and HTML (debug toolbar or HTML comments)
1033 * - 'private': only to the specific log if set in $wgDebugLogGroups and
1034 * discarded otherwise
1035 * For backward compatibility, it can also take a boolean:
1036 * - true: same as 'all'
1037 * - false: same as 'private'
1038 * @param array $context Additional logging context data
1040 function wfDebugLog(
1041 $logGroup, $text, $dest = 'all', array $context = []
1043 $text = trim( $text );
1045 $logger = LoggerFactory
::getInstance( $logGroup );
1046 $context['private'] = ( $dest === false ||
$dest === 'private' );
1047 $logger->info( $text, $context );
1051 * Log for database errors
1053 * @since 1.25 support for additional context data
1055 * @param string $text Database error message.
1056 * @param array $context Additional logging context data
1058 function wfLogDBError( $text, array $context = [] ) {
1059 $logger = LoggerFactory
::getInstance( 'wfLogDBError' );
1060 $logger->error( trim( $text ), $context );
1064 * Throws a warning that $function is deprecated
1066 * @param string $function Function that is deprecated.
1067 * @param string|bool $version Version of MediaWiki that the function
1068 * was deprecated in (Added in 1.19).
1069 * @param string|bool $component Component to which the function belongs.
1070 * If false, it is assumed the function is in MediaWiki core (Added in 1.19).
1071 * @param int $callerOffset How far up the call stack is the original
1072 * caller. 2 = function that called the function that called
1073 * wfDeprecated (Added in 1.20).
1075 function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) {
1076 MWDebug
::deprecated( $function, $version, $component, $callerOffset +
1 );
1080 * Send a warning either to the debug log or in a PHP error depending on
1081 * $wgDevelopmentWarnings. To log warnings in production, use wfLogWarning() instead.
1083 * @param string $msg Message to send
1084 * @param int $callerOffset Number of items to go back in the backtrace to
1085 * find the correct caller (1 = function calling wfWarn, ...)
1086 * @param int $level PHP error level; defaults to E_USER_NOTICE;
1087 * only used when $wgDevelopmentWarnings is true
1089 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE
) {
1090 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'auto' );
1094 * Send a warning as a PHP error and the debug log. This is intended for logging
1095 * warnings in production. For logging development warnings, use WfWarn instead.
1097 * @param string $msg Message to send
1098 * @param int $callerOffset Number of items to go back in the backtrace to
1099 * find the correct caller (1 = function calling wfLogWarning, ...)
1100 * @param int $level PHP error level; defaults to E_USER_WARNING
1102 function wfLogWarning( $msg, $callerOffset = 1, $level = E_USER_WARNING
) {
1103 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'production' );
1108 * @todo Move logic to MediaWiki.php
1110 function wfLogProfilingData() {
1111 global $wgDebugLogGroups, $wgDebugRawPage;
1113 $context = RequestContext
::getMain();
1114 $request = $context->getRequest();
1116 $profiler = Profiler
::instance();
1117 $profiler->setContext( $context );
1118 $profiler->logData();
1120 // Send out any buffered statsd metrics as needed
1121 MediaWiki
::emitBufferedStatsdData(
1122 MediaWikiServices
::getInstance()->getStatsdDataFactory(),
1123 $context->getConfig()
1126 // Profiling must actually be enabled...
1127 if ( $profiler instanceof ProfilerStub
) {
1131 if ( isset( $wgDebugLogGroups['profileoutput'] )
1132 && $wgDebugLogGroups['profileoutput'] === false
1134 // Explicitly disabled
1137 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1141 $ctx = [ 'elapsed' => $request->getElapsedTime() ];
1142 if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1143 $ctx['forwarded_for'] = $_SERVER['HTTP_X_FORWARDED_FOR'];
1145 if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1146 $ctx['client_ip'] = $_SERVER['HTTP_CLIENT_IP'];
1148 if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1149 $ctx['from'] = $_SERVER['HTTP_FROM'];
1151 if ( isset( $ctx['forwarded_for'] ) ||
1152 isset( $ctx['client_ip'] ) ||
1153 isset( $ctx['from'] ) ) {
1154 $ctx['proxy'] = $_SERVER['REMOTE_ADDR'];
1157 // Don't load $wgUser at this late stage just for statistics purposes
1158 // @todo FIXME: We can detect some anons even if it is not loaded.
1159 // See User::getId()
1160 $user = $context->getUser();
1161 $ctx['anon'] = $user->isItemLoaded( 'id' ) && $user->isAnon();
1163 // Command line script uses a FauxRequest object which does not have
1164 // any knowledge about an URL and throw an exception instead.
1166 $ctx['url'] = urldecode( $request->getRequestURL() );
1167 } catch ( Exception
$ignored ) {
1171 $ctx['output'] = $profiler->getOutput();
1173 $log = LoggerFactory
::getInstance( 'profileoutput' );
1174 $log->info( "Elapsed: {elapsed}; URL: <{url}>\n{output}", $ctx );
1178 * Increment a statistics counter
1180 * @param string $key
1184 function wfIncrStats( $key, $count = 1 ) {
1185 $stats = MediaWikiServices
::getInstance()->getStatsdDataFactory();
1186 $stats->updateCount( $key, $count );
1190 * Check whether the wiki is in read-only mode.
1194 function wfReadOnly() {
1195 return MediaWikiServices
::getInstance()->getReadOnlyMode()
1200 * Check if the site is in read-only mode and return the message if so
1202 * This checks wfConfiguredReadOnlyReason() and the main load balancer
1203 * for replica DB lag. This may result in DB connection being made.
1205 * @return string|bool String when in read-only mode; false otherwise
1207 function wfReadOnlyReason() {
1208 return MediaWikiServices
::getInstance()->getReadOnlyMode()
1213 * Get the value of $wgReadOnly or the contents of $wgReadOnlyFile.
1215 * @return string|bool String when in read-only mode; false otherwise
1218 function wfConfiguredReadOnlyReason() {
1219 return MediaWikiServices
::getInstance()->getConfiguredReadOnlyMode()
1224 * Return a Language object from $langcode
1226 * @param Language|string|bool $langcode Either:
1227 * - a Language object
1228 * - code of the language to get the message for, if it is
1229 * a valid code create a language for that language, if
1230 * it is a string but not a valid code then make a basic
1232 * - a boolean: if it's false then use the global object for
1233 * the current user's language (as a fallback for the old parameter
1234 * functionality), or if it is true then use global object
1235 * for the wiki's content language.
1238 function wfGetLangObj( $langcode = false ) {
1239 # Identify which language to get or create a language object for.
1240 # Using is_object here due to Stub objects.
1241 if ( is_object( $langcode ) ) {
1242 # Great, we already have the object (hopefully)!
1246 global $wgLanguageCode;
1247 if ( $langcode === true ||
$langcode === $wgLanguageCode ) {
1248 # $langcode is the language code of the wikis content language object.
1249 # or it is a boolean and value is true
1250 return MediaWikiServices
::getInstance()->getContentLanguage();
1254 if ( $langcode === false ||
$langcode === $wgLang->getCode() ) {
1255 # $langcode is the language code of user language object.
1256 # or it was a boolean and value is false
1260 $validCodes = array_keys( Language
::fetchLanguageNames() );
1261 if ( in_array( $langcode, $validCodes ) ) {
1262 # $langcode corresponds to a valid language.
1263 return Language
::factory( $langcode );
1266 # $langcode is a string, but not a valid language code; use content language.
1267 wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1268 return MediaWikiServices
::getInstance()->getContentLanguage();
1272 * This is the function for getting translated interface messages.
1274 * @see Message class for documentation how to use them.
1275 * @see https://www.mediawiki.org/wiki/Manual:Messages_API
1277 * This function replaces all old wfMsg* functions.
1279 * @param string|string[]|MessageSpecifier $key Message key, or array of keys, or a MessageSpecifier
1280 * @param string|string[] ...$params Normal message parameters
1285 * @see Message::__construct
1287 function wfMessage( $key, ...$params ) {
1288 $message = new Message( $key );
1290 // We call Message::params() to reduce code duplication
1292 $message->params( ...$params );
1299 * This function accepts multiple message keys and returns a message instance
1300 * for the first message which is non-empty. If all messages are empty then an
1301 * instance of the first message key is returned.
1303 * @param string ...$keys Message keys
1308 * @see Message::newFallbackSequence
1310 function wfMessageFallback( ...$keys ) {
1311 return Message
::newFallbackSequence( ...$keys );
1315 * Replace message parameter keys on the given formatted output.
1317 * @param string $message
1318 * @param array $args
1322 function wfMsgReplaceArgs( $message, $args ) {
1323 # Fix windows line-endings
1324 # Some messages are split with explode("\n", $msg)
1325 $message = str_replace( "\r", '', $message );
1327 // Replace arguments
1328 if ( is_array( $args ) && $args ) {
1329 if ( is_array( $args[0] ) ) {
1330 $args = array_values( $args[0] );
1332 $replacementKeys = [];
1333 foreach ( $args as $n => $param ) {
1334 $replacementKeys['$' . ( $n +
1 )] = $param;
1336 $message = strtr( $message, $replacementKeys );
1343 * Fetch server name for use in error reporting etc.
1344 * Use real server name if available, so we know which machine
1345 * in a server farm generated the current page.
1349 function wfHostname() {
1351 if ( is_null( $host ) ) {
1352 # Hostname overriding
1353 global $wgOverrideHostname;
1354 if ( $wgOverrideHostname !== false ) {
1355 # Set static and skip any detection
1356 $host = $wgOverrideHostname;
1360 if ( function_exists( 'posix_uname' ) ) {
1361 // This function not present on Windows
1362 $uname = posix_uname();
1366 if ( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1367 $host = $uname['nodename'];
1368 } elseif ( getenv( 'COMPUTERNAME' ) ) {
1369 # Windows computer name
1370 $host = getenv( 'COMPUTERNAME' );
1372 # This may be a virtual server.
1373 $host = $_SERVER['SERVER_NAME'];
1380 * Returns a script tag that stores the amount of time it took MediaWiki to
1381 * handle the request in milliseconds as 'wgBackendResponseTime'.
1383 * If $wgShowHostnames is true, the script will also set 'wgHostname' to the
1384 * hostname of the server handling the request.
1386 * @param string|null $nonce Value from OutputPage::getCSPNonce
1387 * @return string|WrappedString HTML
1389 function wfReportTime( $nonce = null ) {
1390 global $wgShowHostnames;
1392 $elapsed = ( microtime( true ) - $_SERVER['REQUEST_TIME_FLOAT'] );
1393 // seconds to milliseconds
1394 $responseTime = round( $elapsed * 1000 );
1395 $reportVars = [ 'wgBackendResponseTime' => $responseTime ];
1396 if ( $wgShowHostnames ) {
1397 $reportVars['wgHostname'] = wfHostname();
1399 return Skin
::makeVariablesScript( $reportVars, $nonce );
1403 * Safety wrapper for debug_backtrace().
1405 * Will return an empty array if debug_backtrace is disabled, otherwise
1406 * the output from debug_backtrace() (trimmed).
1408 * @param int $limit This parameter can be used to limit the number of stack frames returned
1410 * @return array Array of backtrace information
1412 function wfDebugBacktrace( $limit = 0 ) {
1413 static $disabled = null;
1415 if ( is_null( $disabled ) ) {
1416 $disabled = !function_exists( 'debug_backtrace' );
1418 wfDebug( "debug_backtrace() is disabled\n" );
1426 return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT
, $limit +
1 ), 1 );
1428 return array_slice( debug_backtrace(), 1 );
1433 * Get a debug backtrace as a string
1435 * @param bool|null $raw If true, the return value is plain text. If false, HTML.
1436 * Defaults to $wgCommandLineMode if unset.
1438 * @since 1.25 Supports $raw parameter.
1440 function wfBacktrace( $raw = null ) {
1441 global $wgCommandLineMode;
1443 if ( $raw === null ) {
1444 $raw = $wgCommandLineMode;
1448 $frameFormat = "%s line %s calls %s()\n";
1449 $traceFormat = "%s";
1451 $frameFormat = "<li>%s line %s calls %s()</li>\n";
1452 $traceFormat = "<ul>\n%s</ul>\n";
1455 $frames = array_map( function ( $frame ) use ( $frameFormat ) {
1456 $file = !empty( $frame['file'] ) ?
basename( $frame['file'] ) : '-';
1457 $line = $frame['line'] ??
'-';
1458 $call = $frame['function'];
1459 if ( !empty( $frame['class'] ) ) {
1460 $call = $frame['class'] . $frame['type'] . $call;
1462 return sprintf( $frameFormat, $file, $line, $call );
1463 }, wfDebugBacktrace() );
1465 return sprintf( $traceFormat, implode( '', $frames ) );
1469 * Get the name of the function which called this function
1470 * wfGetCaller( 1 ) is the function with the wfGetCaller() call (ie. __FUNCTION__)
1471 * wfGetCaller( 2 ) [default] is the caller of the function running wfGetCaller()
1472 * wfGetCaller( 3 ) is the parent of that.
1477 function wfGetCaller( $level = 2 ) {
1478 $backtrace = wfDebugBacktrace( $level +
1 );
1479 if ( isset( $backtrace[$level] ) ) {
1480 return wfFormatStackFrame( $backtrace[$level] );
1487 * Return a string consisting of callers in the stack. Useful sometimes
1488 * for profiling specific points.
1490 * @param int $limit The maximum depth of the stack frame to return, or false for the entire stack.
1493 function wfGetAllCallers( $limit = 3 ) {
1494 $trace = array_reverse( wfDebugBacktrace() );
1495 if ( !$limit ||
$limit > count( $trace ) - 1 ) {
1496 $limit = count( $trace ) - 1;
1498 $trace = array_slice( $trace, -$limit - 1, $limit );
1499 return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1503 * Return a string representation of frame
1505 * @param array $frame
1508 function wfFormatStackFrame( $frame ) {
1509 if ( !isset( $frame['function'] ) ) {
1510 return 'NO_FUNCTION_GIVEN';
1512 return isset( $frame['class'] ) && isset( $frame['type'] ) ?
1513 $frame['class'] . $frame['type'] . $frame['function'] :
1517 /* Some generic result counters, pulled out of SearchEngine */
1522 * @param int $offset
1526 function wfShowingResults( $offset, $limit ) {
1527 return wfMessage( 'showingresults' )->numParams( $limit, $offset +
1 )->parse();
1531 * Whether the client accept gzip encoding
1533 * Uses the Accept-Encoding header to check if the client supports gzip encoding.
1534 * Use this when considering to send a gzip-encoded response to the client.
1536 * @param bool $force Forces another check even if we already have a cached result.
1539 function wfClientAcceptsGzip( $force = false ) {
1540 static $result = null;
1541 if ( $result === null ||
$force ) {
1543 if ( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
1544 # @todo FIXME: We may want to blacklist some broken browsers
1547 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
1548 $_SERVER['HTTP_ACCEPT_ENCODING'],
1552 if ( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
1556 wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
1565 * Escapes the given text so that it may be output using addWikiText()
1566 * without any linking, formatting, etc. making its way through. This
1567 * is achieved by substituting certain characters with HTML entities.
1568 * As required by the callers, "<nowiki>" is not used.
1570 * @param string $text Text to be escaped
1571 * @param-taint $text escapes_html
1574 function wfEscapeWikiText( $text ) {
1575 global $wgEnableMagicLinks;
1576 static $repl = null, $repl2 = null;
1577 if ( $repl === null ||
defined( 'MW_PARSER_TEST' ) ||
defined( 'MW_PHPUNIT_TEST' ) ) {
1578 // Tests depend upon being able to change $wgEnableMagicLinks, so don't cache
1579 // in those situations
1581 '"' => '"', '&' => '&', "'" => ''', '<' => '<',
1582 '=' => '=', '>' => '>', '[' => '[', ']' => ']',
1583 '{' => '{', '|' => '|', '}' => '}', ';' => ';',
1584 "\n#" => "\n#", "\r#" => "\r#",
1585 "\n*" => "\n*", "\r*" => "\r*",
1586 "\n:" => "\n:", "\r:" => "\r:",
1587 "\n " => "\n ", "\r " => "\r ",
1588 "\n\n" => "\n ", "\r\n" => " \n",
1589 "\n\r" => "\n ", "\r\r" => "\r ",
1590 "\n\t" => "\n	", "\r\t" => "\r	", // "\n\t\n" is treated like "\n\n"
1591 "\n----" => "\n----", "\r----" => "\r----",
1592 '__' => '__', '://' => '://',
1595 $magicLinks = array_keys( array_filter( $wgEnableMagicLinks ) );
1596 // We have to catch everything "\s" matches in PCRE
1597 foreach ( $magicLinks as $magic ) {
1598 $repl["$magic "] = "$magic ";
1599 $repl["$magic\t"] = "$magic	";
1600 $repl["$magic\r"] = "$magic ";
1601 $repl["$magic\n"] = "$magic ";
1602 $repl["$magic\f"] = "$magic";
1605 // And handle protocols that don't use "://"
1606 global $wgUrlProtocols;
1608 foreach ( $wgUrlProtocols as $prot ) {
1609 if ( substr( $prot, -1 ) === ':' ) {
1610 $repl2[] = preg_quote( substr( $prot, 0, -1 ), '/' );
1613 $repl2 = $repl2 ?
'/\b(' . implode( '|', $repl2 ) . '):/i' : '/^(?!)/';
1615 $text = substr( strtr( "\n$text", $repl ), 1 );
1616 $text = preg_replace( $repl2, '$1:', $text );
1621 * Sets dest to source and returns the original value of dest
1622 * If source is NULL, it just returns the value, it doesn't set the variable
1623 * If force is true, it will set the value even if source is NULL
1625 * @param mixed &$dest
1626 * @param mixed $source
1627 * @param bool $force
1630 function wfSetVar( &$dest, $source, $force = false ) {
1632 if ( !is_null( $source ) ||
$force ) {
1639 * As for wfSetVar except setting a bit
1643 * @param bool $state
1647 function wfSetBit( &$dest, $bit, $state = true ) {
1648 $temp = (bool)( $dest & $bit );
1649 if ( !is_null( $state ) ) {
1660 * A wrapper around the PHP function var_export().
1661 * Either print it or add it to the regular output ($wgOut).
1663 * @param mixed $var A PHP variable to dump.
1665 function wfVarDump( $var ) {
1667 $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
1668 if ( headers_sent() ||
!isset( $wgOut ) ||
!is_object( $wgOut ) ) {
1671 $wgOut->addHTML( $s );
1676 * Provide a simple HTTP error.
1678 * @param int|string $code
1679 * @param string $label
1680 * @param string $desc
1682 function wfHttpError( $code, $label, $desc ) {
1684 HttpStatus
::header( $code );
1687 $wgOut->sendCacheControl();
1690 MediaWiki\HeaderCallback
::warnIfHeadersSent();
1691 header( 'Content-type: text/html; charset=utf-8' );
1692 print '<!DOCTYPE html>' .
1693 '<html><head><title>' .
1694 htmlspecialchars( $label ) .
1695 '</title></head><body><h1>' .
1696 htmlspecialchars( $label ) .
1698 nl2br( htmlspecialchars( $desc ) ) .
1699 "</p></body></html>\n";
1703 * Clear away any user-level output buffers, discarding contents.
1705 * Suitable for 'starting afresh', for instance when streaming
1706 * relatively large amounts of data without buffering, or wanting to
1707 * output image files without ob_gzhandler's compression.
1709 * The optional $resetGzipEncoding parameter controls suppression of
1710 * the Content-Encoding header sent by ob_gzhandler; by default it
1711 * is left. See comments for wfClearOutputBuffers() for why it would
1714 * Note that some PHP configuration options may add output buffer
1715 * layers which cannot be removed; these are left in place.
1717 * @param bool $resetGzipEncoding
1719 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
1720 if ( $resetGzipEncoding ) {
1721 // Suppress Content-Encoding and Content-Length
1722 // headers from OutputHandler::handle.
1723 global $wgDisableOutputCompression;
1724 $wgDisableOutputCompression = true;
1726 while ( $status = ob_get_status() ) {
1727 if ( isset( $status['flags'] ) ) {
1728 $flags = PHP_OUTPUT_HANDLER_CLEANABLE | PHP_OUTPUT_HANDLER_REMOVABLE
;
1729 $deleteable = ( $status['flags'] & $flags ) === $flags;
1730 } elseif ( isset( $status['del'] ) ) {
1731 $deleteable = $status['del'];
1733 // Guess that any PHP-internal setting can't be removed.
1734 $deleteable = $status['type'] !== 0; /* PHP_OUTPUT_HANDLER_INTERNAL */
1736 if ( !$deleteable ) {
1737 // Give up, and hope the result doesn't break
1741 if ( $status['name'] === 'MediaWikiTestCase::wfResetOutputBuffersBarrier' ) {
1742 // Unit testing barrier to prevent this function from breaking PHPUnit.
1745 if ( !ob_end_clean() ) {
1746 // Could not remove output buffer handler; abort now
1747 // to avoid getting in some kind of infinite loop.
1750 if ( $resetGzipEncoding ) {
1751 if ( $status['name'] == 'ob_gzhandler' ) {
1752 // Reset the 'Content-Encoding' field set by this handler
1753 // so we can start fresh.
1754 header_remove( 'Content-Encoding' );
1762 * More legible than passing a 'false' parameter to wfResetOutputBuffers():
1764 * Clear away output buffers, but keep the Content-Encoding header
1765 * produced by ob_gzhandler, if any.
1767 * This should be used for HTTP 304 responses, where you need to
1768 * preserve the Content-Encoding header of the real result, but
1769 * also need to suppress the output of ob_gzhandler to keep to spec
1770 * and avoid breaking Firefox in rare cases where the headers and
1771 * body are broken over two packets.
1773 function wfClearOutputBuffers() {
1774 wfResetOutputBuffers( false );
1778 * Converts an Accept-* header into an array mapping string values to quality
1781 * @param string $accept
1782 * @param string $def Default
1783 * @return float[] Associative array of string => float pairs
1785 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
1786 # No arg means accept anything (per HTTP spec)
1788 return [ $def => 1.0 ];
1793 $parts = explode( ',', $accept );
1795 foreach ( $parts as $part ) {
1796 # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
1797 $values = explode( ';', trim( $part ) );
1799 if ( count( $values ) == 1 ) {
1800 $prefs[$values[0]] = 1.0;
1801 } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
1802 $prefs[$values[0]] = floatval( $match[1] );
1810 * Checks if a given MIME type matches any of the keys in the given
1811 * array. Basic wildcards are accepted in the array keys.
1813 * Returns the matching MIME type (or wildcard) if a match, otherwise
1816 * @param string $type
1817 * @param array $avail
1821 function mimeTypeMatch( $type, $avail ) {
1822 if ( array_key_exists( $type, $avail ) ) {
1825 $mainType = explode( '/', $type )[0];
1826 if ( array_key_exists( "$mainType/*", $avail ) ) {
1827 return "$mainType/*";
1828 } elseif ( array_key_exists( '*/*', $avail ) ) {
1837 * Returns the 'best' match between a client's requested internet media types
1838 * and the server's list of available types. Each list should be an associative
1839 * array of type to preference (preference is a float between 0.0 and 1.0).
1840 * Wildcards in the types are acceptable.
1842 * @param array $cprefs Client's acceptable type list
1843 * @param array $sprefs Server's offered types
1846 * @todo FIXME: Doesn't handle params like 'text/plain; charset=UTF-8'
1847 * XXX: generalize to negotiate other stuff
1849 function wfNegotiateType( $cprefs, $sprefs ) {
1852 foreach ( array_keys( $sprefs ) as $type ) {
1853 $subType = explode( '/', $type )[1];
1854 if ( $subType != '*' ) {
1855 $ckey = mimeTypeMatch( $type, $cprefs );
1857 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1862 foreach ( array_keys( $cprefs ) as $type ) {
1863 $subType = explode( '/', $type )[1];
1864 if ( $subType != '*' && !array_key_exists( $type, $sprefs ) ) {
1865 $skey = mimeTypeMatch( $type, $sprefs );
1867 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1875 foreach ( array_keys( $combine ) as $type ) {
1876 if ( $combine[$type] > $bestq ) {
1878 $bestq = $combine[$type];
1886 * Reference-counted warning suppression
1888 * @deprecated since 1.26, use Wikimedia\suppressWarnings() directly
1891 function wfSuppressWarnings( $end = false ) {
1892 Wikimedia\
suppressWarnings( $end );
1896 * @deprecated since 1.26, use Wikimedia\restoreWarnings() directly
1897 * Restore error level to previous value
1899 function wfRestoreWarnings() {
1900 Wikimedia\restoreWarnings
();
1904 * Get a timestamp string in one of various formats
1906 * @param mixed $outputtype A timestamp in one of the supported formats, the
1907 * function will autodetect which format is supplied and act accordingly.
1908 * @param mixed $ts Optional timestamp to convert, default 0 for the current time
1909 * @return string|bool String / false The same date in the format specified in $outputtype or false
1911 function wfTimestamp( $outputtype = TS_UNIX
, $ts = 0 ) {
1912 $ret = MWTimestamp
::convert( $outputtype, $ts );
1913 if ( $ret === false ) {
1914 wfDebug( "wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n" );
1920 * Return a formatted timestamp, or null if input is null.
1921 * For dealing with nullable timestamp columns in the database.
1923 * @param int $outputtype
1924 * @param string|null $ts
1927 function wfTimestampOrNull( $outputtype = TS_UNIX
, $ts = null ) {
1928 if ( is_null( $ts ) ) {
1931 return wfTimestamp( $outputtype, $ts );
1936 * Convenience function; returns MediaWiki timestamp for the present time.
1940 function wfTimestampNow() {
1942 return MWTimestamp
::now( TS_MW
);
1946 * Check if the operating system is Windows
1948 * @return bool True if it's Windows, false otherwise.
1950 function wfIsWindows() {
1951 static $isWindows = null;
1952 if ( $isWindows === null ) {
1953 $isWindows = strtoupper( substr( PHP_OS
, 0, 3 ) ) === 'WIN';
1959 * Check if we are running under HHVM
1963 function wfIsHHVM() {
1964 return defined( 'HHVM_VERSION' );
1968 * Check if we are running from the commandline
1973 function wfIsCLI() {
1974 return PHP_SAPI
=== 'cli' || PHP_SAPI
=== 'phpdbg';
1978 * Tries to get the system directory for temporary files. First
1979 * $wgTmpDirectory is checked, and then the TMPDIR, TMP, and TEMP
1980 * environment variables are then checked in sequence, then
1981 * sys_get_temp_dir(), then upload_tmp_dir from php.ini.
1983 * NOTE: When possible, use instead the tmpfile() function to create
1984 * temporary files to avoid race conditions on file creation, etc.
1988 function wfTempDir() {
1989 global $wgTmpDirectory;
1991 if ( $wgTmpDirectory !== false ) {
1992 return $wgTmpDirectory;
1995 return TempFSFile
::getUsableTempDirectory();
1999 * Make directory, and make all parent directories if they don't exist
2001 * @param string $dir Full path to directory to create
2002 * @param int|null $mode Chmod value to use, default is $wgDirectoryMode
2003 * @param string|null $caller Optional caller param for debugging.
2004 * @throws MWException
2007 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2008 global $wgDirectoryMode;
2010 if ( FileBackend
::isStoragePath( $dir ) ) { // sanity
2011 throw new MWException( __FUNCTION__
. " given storage path '$dir'." );
2014 if ( !is_null( $caller ) ) {
2015 wfDebug( "$caller: called wfMkdirParents($dir)\n" );
2018 if ( strval( $dir ) === '' ||
is_dir( $dir ) ) {
2022 $dir = str_replace( [ '\\', '/' ], DIRECTORY_SEPARATOR
, $dir );
2024 if ( is_null( $mode ) ) {
2025 $mode = $wgDirectoryMode;
2028 // Turn off the normal warning, we're doing our own below
2029 Wikimedia\
suppressWarnings();
2030 $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2031 Wikimedia\restoreWarnings
();
2034 // directory may have been created on another request since we last checked
2035 if ( is_dir( $dir ) ) {
2039 // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2040 wfLogWarning( sprintf( "failed to mkdir \"%s\" mode 0%o", $dir, $mode ) );
2046 * Remove a directory and all its content.
2047 * Does not hide error.
2048 * @param string $dir
2050 function wfRecursiveRemoveDir( $dir ) {
2051 wfDebug( __FUNCTION__
. "( $dir )\n" );
2052 // taken from https://secure.php.net/manual/en/function.rmdir.php#98622
2053 if ( is_dir( $dir ) ) {
2054 $objects = scandir( $dir );
2055 foreach ( $objects as $object ) {
2056 if ( $object != "." && $object != ".." ) {
2057 if ( filetype( $dir . '/' . $object ) == "dir" ) {
2058 wfRecursiveRemoveDir( $dir . '/' . $object );
2060 unlink( $dir . '/' . $object );
2070 * @param int $nr The number to format
2071 * @param int $acc The number of digits after the decimal point, default 2
2072 * @param bool $round Whether or not to round the value, default true
2075 function wfPercent( $nr, $acc = 2, $round = true ) {
2076 $ret = sprintf( "%.${acc}f", $nr );
2077 return $round ?
round( $ret, $acc ) . '%' : "$ret%";
2081 * Safety wrapper around ini_get() for boolean settings.
2082 * The values returned from ini_get() are pre-normalized for settings
2083 * set via php.ini or php_flag/php_admin_flag... but *not*
2084 * for those set via php_value/php_admin_value.
2086 * It's fairly common for people to use php_value instead of php_flag,
2087 * which can leave you with an 'off' setting giving a false positive
2088 * for code that just takes the ini_get() return value as a boolean.
2090 * To make things extra interesting, setting via php_value accepts
2091 * "true" and "yes" as true, but php.ini and php_flag consider them false. :)
2092 * Unrecognized values go false... again opposite PHP's own coercion
2093 * from string to bool.
2095 * Luckily, 'properly' set settings will always come back as '0' or '1',
2096 * so we only have to worry about them and the 'improper' settings.
2098 * I frickin' hate PHP... :P
2100 * @param string $setting
2103 function wfIniGetBool( $setting ) {
2104 return wfStringToBool( ini_get( $setting ) );
2108 * Convert string value to boolean, when the following are interpreted as true:
2112 * - Any number, except 0
2113 * All other strings are interpreted as false.
2115 * @param string $val
2119 function wfStringToBool( $val ) {
2120 $val = strtolower( $val );
2121 // 'on' and 'true' can't have whitespace around them, but '1' can.
2125 ||
preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2129 * Version of escapeshellarg() that works better on Windows.
2131 * Originally, this fixed the incorrect use of single quotes on Windows
2132 * (https://bugs.php.net/bug.php?id=26285) and the locale problems on Linux in
2133 * PHP 5.2.6+ (bug backported to earlier distro releases of PHP).
2135 * @param string|string[] ...$args strings to escape and glue together,
2136 * or a single array of strings parameter
2138 * @deprecated since 1.30 use MediaWiki\Shell::escape()
2140 function wfEscapeShellArg( ...$args ) {
2141 return Shell
::escape( ...$args );
2145 * Execute a shell command, with time and memory limits mirrored from the PHP
2146 * configuration if supported.
2148 * @param string|string[] $cmd If string, a properly shell-escaped command line,
2149 * or an array of unescaped arguments, in which case each value will be escaped
2150 * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
2151 * @param null|mixed &$retval Optional, will receive the program's exit code.
2152 * (non-zero is usually failure). If there is an error from
2153 * read, select, or proc_open(), this will be set to -1.
2154 * @param array $environ Optional environment variables which should be
2155 * added to the executed command environment.
2156 * @param array $limits Optional array with limits(filesize, memory, time, walltime)
2157 * this overwrites the global wgMaxShell* limits.
2158 * @param array $options Array of options:
2159 * - duplicateStderr: Set this to true to duplicate stderr to stdout,
2160 * including errors from limit.sh
2161 * - profileMethod: By default this function will profile based on the calling
2162 * method. Set this to a string for an alternative method to profile from
2164 * @return string Collected stdout as a string
2165 * @deprecated since 1.30 use class MediaWiki\Shell\Shell
2167 function wfShellExec( $cmd, &$retval = null, $environ = [],
2168 $limits = [], $options = []
2170 if ( Shell
::isDisabled() ) {
2172 // Backwards compatibility be upon us...
2173 return 'Unable to run external programs, proc_open() is disabled.';
2176 if ( is_array( $cmd ) ) {
2177 $cmd = Shell
::escape( $cmd );
2180 $includeStderr = isset( $options['duplicateStderr'] ) && $options['duplicateStderr'];
2181 $profileMethod = $options['profileMethod'] ??
wfGetCaller();
2184 $result = Shell
::command( [] )
2185 ->unsafeParams( (array)$cmd )
2186 ->environment( $environ )
2188 ->includeStderr( $includeStderr )
2189 ->profileMethod( $profileMethod )
2191 ->restrict( Shell
::RESTRICT_NONE
)
2193 } catch ( ProcOpenError
$ex ) {
2198 $retval = $result->getExitCode();
2200 return $result->getStdout();
2204 * Execute a shell command, returning both stdout and stderr. Convenience
2205 * function, as all the arguments to wfShellExec can become unwieldy.
2207 * @note This also includes errors from limit.sh, e.g. if $wgMaxShellFileSize is exceeded.
2208 * @param string|string[] $cmd If string, a properly shell-escaped command line,
2209 * or an array of unescaped arguments, in which case each value will be escaped
2210 * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
2211 * @param null|mixed &$retval Optional, will receive the program's exit code.
2212 * (non-zero is usually failure)
2213 * @param array $environ Optional environment variables which should be
2214 * added to the executed command environment.
2215 * @param array $limits Optional array with limits(filesize, memory, time, walltime)
2216 * this overwrites the global wgMaxShell* limits.
2217 * @return string Collected stdout and stderr as a string
2218 * @deprecated since 1.30 use class MediaWiki\Shell\Shell
2220 function wfShellExecWithStderr( $cmd, &$retval = null, $environ = [], $limits = [] ) {
2221 return wfShellExec( $cmd, $retval, $environ, $limits,
2222 [ 'duplicateStderr' => true, 'profileMethod' => wfGetCaller() ] );
2226 * Generate a shell-escaped command line string to run a MediaWiki cli script.
2227 * Note that $parameters should be a flat array and an option with an argument
2228 * should consist of two consecutive items in the array (do not use "--option value").
2230 * @deprecated since 1.31, use Shell::makeScriptCommand()
2232 * @param string $script MediaWiki cli script path
2233 * @param array $parameters Arguments and options to the script
2234 * @param array $options Associative array of options:
2235 * 'php': The path to the php executable
2236 * 'wrapper': Path to a PHP wrapper to handle the maintenance script
2239 function wfShellWikiCmd( $script, array $parameters = [], array $options = [] ) {
2241 // Give site config file a chance to run the script in a wrapper.
2242 // The caller may likely want to call wfBasename() on $script.
2243 Hooks
::run( 'wfShellWikiCmd', [ &$script, &$parameters, &$options ] );
2244 $cmd = [ $options['php'] ??
$wgPhpCli ];
2245 if ( isset( $options['wrapper'] ) ) {
2246 $cmd[] = $options['wrapper'];
2249 // Escape each parameter for shell
2250 return Shell
::escape( array_merge( $cmd, $parameters ) );
2254 * wfMerge attempts to merge differences between three texts.
2255 * Returns true for a clean merge and false for failure or a conflict.
2257 * @param string $old
2258 * @param string $mine
2259 * @param string $yours
2260 * @param string &$result
2261 * @param string|null &$mergeAttemptResult
2264 function wfMerge( $old, $mine, $yours, &$result, &$mergeAttemptResult = null ) {
2267 # This check may also protect against code injection in
2268 # case of broken installations.
2269 Wikimedia\
suppressWarnings();
2270 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
2271 Wikimedia\restoreWarnings
();
2273 if ( !$haveDiff3 ) {
2274 wfDebug( "diff3 not found\n" );
2278 # Make temporary files
2280 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2281 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
2282 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
2284 # NOTE: diff3 issues a warning to stderr if any of the files does not end with
2285 # a newline character. To avoid this, we normalize the trailing whitespace before
2286 # creating the diff.
2288 fwrite( $oldtextFile, rtrim( $old ) . "\n" );
2289 fclose( $oldtextFile );
2290 fwrite( $mytextFile, rtrim( $mine ) . "\n" );
2291 fclose( $mytextFile );
2292 fwrite( $yourtextFile, rtrim( $yours ) . "\n" );
2293 fclose( $yourtextFile );
2295 # Check for a conflict
2296 $cmd = Shell
::escape( $wgDiff3, '-a', '--overlap-only', $mytextName,
2297 $oldtextName, $yourtextName );
2298 $handle = popen( $cmd, 'r' );
2300 $mergeAttemptResult = '';
2302 $data = fread( $handle, 8192 );
2303 if ( strlen( $data ) == 0 ) {
2306 $mergeAttemptResult .= $data;
2310 $conflict = $mergeAttemptResult !== '';
2313 $cmd = Shell
::escape( $wgDiff3, '-a', '-e', '--merge', $mytextName,
2314 $oldtextName, $yourtextName );
2315 $handle = popen( $cmd, 'r' );
2318 $data = fread( $handle, 8192 );
2319 if ( strlen( $data ) == 0 ) {
2325 unlink( $mytextName );
2326 unlink( $oldtextName );
2327 unlink( $yourtextName );
2329 if ( $result === '' && $old !== '' && !$conflict ) {
2330 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
2337 * Returns unified plain-text diff of two texts.
2338 * "Useful" for machine processing of diffs.
2340 * @deprecated since 1.25, use DiffEngine/UnifiedDiffFormatter directly
2342 * @param string $before The text before the changes.
2343 * @param string $after The text after the changes.
2344 * @param string $params Command-line options for the diff command.
2345 * @return string Unified diff of $before and $after
2347 function wfDiff( $before, $after, $params = '-u' ) {
2348 if ( $before == $after ) {
2353 Wikimedia\
suppressWarnings();
2354 $haveDiff = $wgDiff && file_exists( $wgDiff );
2355 Wikimedia\restoreWarnings
();
2357 # This check may also protect against code injection in
2358 # case of broken installations.
2360 wfDebug( "diff executable not found\n" );
2361 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
2362 $format = new UnifiedDiffFormatter();
2363 return $format->format( $diffs );
2366 # Make temporary files
2368 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2369 $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
2371 fwrite( $oldtextFile, $before );
2372 fclose( $oldtextFile );
2373 fwrite( $newtextFile, $after );
2374 fclose( $newtextFile );
2376 // Get the diff of the two files
2377 $cmd = "$wgDiff " . $params . ' ' . Shell
::escape( $oldtextName, $newtextName );
2379 $h = popen( $cmd, 'r' );
2381 unlink( $oldtextName );
2382 unlink( $newtextName );
2383 throw new Exception( __METHOD__
. '(): popen() failed' );
2389 $data = fread( $h, 8192 );
2390 if ( strlen( $data ) == 0 ) {
2398 unlink( $oldtextName );
2399 unlink( $newtextName );
2401 // Kill the --- and +++ lines. They're not useful.
2402 $diff_lines = explode( "\n", $diff );
2403 if ( isset( $diff_lines[0] ) && strpos( $diff_lines[0], '---' ) === 0 ) {
2404 unset( $diff_lines[0] );
2406 if ( isset( $diff_lines[1] ) && strpos( $diff_lines[1], '+++' ) === 0 ) {
2407 unset( $diff_lines[1] );
2410 $diff = implode( "\n", $diff_lines );
2416 * Return the final portion of a pathname.
2417 * Reimplemented because PHP5's "basename()" is buggy with multibyte text.
2418 * https://bugs.php.net/bug.php?id=33898
2420 * PHP's basename() only considers '\' a pathchar on Windows and Netware.
2421 * We'll consider it so always, as we don't want '\s' in our Unix paths either.
2423 * @param string $path
2424 * @param string $suffix String to remove if present
2427 function wfBaseName( $path, $suffix = '' ) {
2428 if ( $suffix == '' ) {
2431 $encSuffix = '(?:' . preg_quote( $suffix, '#' ) . ')?';
2435 if ( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
2443 * Generate a relative path name to the given file.
2444 * May explode on non-matching case-insensitive paths,
2445 * funky symlinks, etc.
2447 * @param string $path Absolute destination path including target filename
2448 * @param string $from Absolute source path, directory only
2451 function wfRelativePath( $path, $from ) {
2452 // Normalize mixed input on Windows...
2453 $path = str_replace( '/', DIRECTORY_SEPARATOR
, $path );
2454 $from = str_replace( '/', DIRECTORY_SEPARATOR
, $from );
2456 // Trim trailing slashes -- fix for drive root
2457 $path = rtrim( $path, DIRECTORY_SEPARATOR
);
2458 $from = rtrim( $from, DIRECTORY_SEPARATOR
);
2460 $pieces = explode( DIRECTORY_SEPARATOR
, dirname( $path ) );
2461 $against = explode( DIRECTORY_SEPARATOR
, $from );
2463 if ( $pieces[0] !== $against[0] ) {
2464 // Non-matching Windows drive letters?
2465 // Return a full path.
2469 // Trim off common prefix
2470 while ( count( $pieces ) && count( $against )
2471 && $pieces[0] == $against[0] ) {
2472 array_shift( $pieces );
2473 array_shift( $against );
2476 // relative dots to bump us to the parent
2477 while ( count( $against ) ) {
2478 array_unshift( $pieces, '..' );
2479 array_shift( $against );
2482 array_push( $pieces, wfBaseName( $path ) );
2484 return implode( DIRECTORY_SEPARATOR
, $pieces );
2488 * Reset the session id
2490 * @deprecated since 1.27, use MediaWiki\Session\SessionManager instead
2493 function wfResetSessionID() {
2494 wfDeprecated( __FUNCTION__
, '1.27' );
2495 $session = SessionManager
::getGlobalSession();
2496 $delay = $session->delaySave();
2498 $session->resetId();
2500 // Make sure a session is started, since that's what the old
2501 // wfResetSessionID() did.
2502 if ( session_id() !== $session->getId() ) {
2503 wfSetupSession( $session->getId() );
2506 ScopedCallback
::consume( $delay );
2510 * Initialise php session
2512 * @deprecated since 1.27, use MediaWiki\Session\SessionManager instead.
2513 * Generally, "using" SessionManager will be calling ->getSessionById() or
2514 * ::getGlobalSession() (depending on whether you were passing $sessionId
2515 * here), then calling $session->persist().
2516 * @param bool|string $sessionId
2518 function wfSetupSession( $sessionId = false ) {
2519 wfDeprecated( __FUNCTION__
, '1.27' );
2522 session_id( $sessionId );
2525 $session = SessionManager
::getGlobalSession();
2526 $session->persist();
2528 if ( session_id() !== $session->getId() ) {
2529 session_id( $session->getId() );
2531 Wikimedia\
quietCall( 'session_start' );
2535 * Get an object from the precompiled serialized directory
2537 * @param string $name
2538 * @return mixed The variable on success, false on failure
2540 function wfGetPrecompiledData( $name ) {
2543 $file = "$IP/serialized/$name";
2544 if ( file_exists( $file ) ) {
2545 $blob = file_get_contents( $file );
2547 return unserialize( $blob );
2554 * Make a cache key for the local wiki.
2556 * @deprecated since 1.30 Call makeKey on a BagOStuff instance
2557 * @param string ...$args
2560 function wfMemcKey( ...$args ) {
2561 return ObjectCache
::getLocalClusterInstance()->makeKey( ...$args );
2565 * Make a cache key for a foreign DB.
2567 * Must match what wfMemcKey() would produce in context of the foreign wiki.
2570 * @param string $prefix
2571 * @param string ...$args
2574 function wfForeignMemcKey( $db, $prefix, ...$args ) {
2575 $keyspace = $prefix ?
"$db-$prefix" : $db;
2576 return ObjectCache
::getLocalClusterInstance()->makeKeyInternal( $keyspace, $args );
2580 * Make a cache key with database-agnostic prefix.
2582 * Doesn't have a wiki-specific namespace. Uses a generic 'global' prefix
2583 * instead. Must have a prefix as otherwise keys that use a database name
2584 * in the first segment will clash with wfMemcKey/wfForeignMemcKey.
2586 * @deprecated since 1.30 Call makeGlobalKey on a BagOStuff instance
2588 * @param string ...$args
2591 function wfGlobalCacheKey( ...$args ) {
2592 return ObjectCache
::getLocalClusterInstance()->makeGlobalKey( ...$args );
2596 * Get an ASCII string identifying this wiki
2597 * This is used as a prefix in memcached keys
2601 function wfWikiID() {
2602 global $wgDBprefix, $wgDBname;
2603 if ( $wgDBprefix ) {
2604 return "$wgDBname-$wgDBprefix";
2611 * Split a wiki ID into DB name and table prefix
2613 * @param string $wiki
2618 function wfSplitWikiID( $wiki ) {
2619 $bits = explode( '-', $wiki, 2 );
2620 if ( count( $bits ) < 2 ) {
2627 * Get a Database object.
2629 * @param int $db Index of the connection to get. May be DB_MASTER for the
2630 * master (for write queries), DB_REPLICA for potentially lagged read
2631 * queries, or an integer >= 0 for a particular server.
2633 * @param string|string[] $groups Query groups. An array of group names that this query
2634 * belongs to. May contain a single string if the query is only
2637 * @param string|bool $wiki The wiki ID, or false for the current wiki
2639 * Note: multiple calls to wfGetDB(DB_REPLICA) during the course of one request
2640 * will always return the same object, unless the underlying connection or load
2641 * balancer is manually destroyed.
2643 * Note 2: use $this->getDB() in maintenance scripts that may be invoked by
2644 * updater to ensure that a proper database is being updated.
2646 * @todo Replace calls to wfGetDB with calls to LoadBalancer::getConnection()
2647 * on an injected instance of LoadBalancer.
2649 * @return \Wikimedia\Rdbms\Database
2651 function wfGetDB( $db, $groups = [], $wiki = false ) {
2652 return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
2656 * Get a load balancer object.
2658 * @deprecated since 1.27, use MediaWikiServices::getDBLoadBalancer()
2659 * or MediaWikiServices::getDBLoadBalancerFactory() instead.
2661 * @param string|bool $wiki Wiki ID, or false for the current wiki
2662 * @return \Wikimedia\Rdbms\LoadBalancer
2664 function wfGetLB( $wiki = false ) {
2665 if ( $wiki === false ) {
2666 return MediaWikiServices
::getInstance()->getDBLoadBalancer();
2668 $factory = MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
2669 return $factory->getMainLB( $wiki );
2674 * Get the load balancer factory object
2676 * @deprecated since 1.27, use MediaWikiServices::getDBLoadBalancerFactory() instead.
2678 * @return \Wikimedia\Rdbms\LBFactory
2680 function wfGetLBFactory() {
2681 return MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
2686 * Shortcut for RepoGroup::singleton()->findFile()
2688 * @param string|Title $title String or Title object
2689 * @param array $options Associative array of options (see RepoGroup::findFile)
2690 * @return File|bool File, or false if the file does not exist
2692 function wfFindFile( $title, $options = [] ) {
2693 return RepoGroup
::singleton()->findFile( $title, $options );
2697 * Get an object referring to a locally registered file.
2698 * Returns a valid placeholder object if the file does not exist.
2700 * @param Title|string $title
2701 * @return LocalFile|null A File, or null if passed an invalid Title
2703 function wfLocalFile( $title ) {
2704 return RepoGroup
::singleton()->getLocalRepo()->newFile( $title );
2708 * Should low-performance queries be disabled?
2711 * @codeCoverageIgnore
2713 function wfQueriesMustScale() {
2714 global $wgMiserMode;
2716 ||
( SiteStats
::pages() > 100000
2717 && SiteStats
::edits() > 1000000
2718 && SiteStats
::users() > 10000 );
2722 * Get the path to a specified script file, respecting file
2723 * extensions; this is a wrapper around $wgScriptPath etc.
2724 * except for 'index' and 'load' which use $wgScript/$wgLoadScript
2726 * @param string $script Script filename, sans extension
2729 function wfScript( $script = 'index' ) {
2730 global $wgScriptPath, $wgScript, $wgLoadScript;
2731 if ( $script === 'index' ) {
2733 } elseif ( $script === 'load' ) {
2734 return $wgLoadScript;
2736 return "{$wgScriptPath}/{$script}.php";
2741 * Get the script URL.
2743 * @return string Script URL
2745 function wfGetScriptUrl() {
2746 if ( isset( $_SERVER['SCRIPT_NAME'] ) ) {
2747 /* as it was called, minus the query string.
2749 * Some sites use Apache rewrite rules to handle subdomains,
2750 * and have PHP set up in a weird way that causes PHP_SELF
2751 * to contain the rewritten URL instead of the one that the
2752 * outside world sees.
2754 * If in this mode, use SCRIPT_URL instead, which mod_rewrite
2755 * provides containing the "before" URL.
2757 return $_SERVER['SCRIPT_NAME'];
2759 return $_SERVER['URL'];
2764 * Convenience function converts boolean values into "true"
2765 * or "false" (string) values
2767 * @param bool $value
2770 function wfBoolToStr( $value ) {
2771 return $value ?
'true' : 'false';
2775 * Get a platform-independent path to the null file, e.g. /dev/null
2779 function wfGetNull() {
2780 return wfIsWindows() ?
'NUL' : '/dev/null';
2784 * Waits for the replica DBs to catch up to the master position
2786 * Use this when updating very large numbers of rows, as in maintenance scripts,
2787 * to avoid causing too much lag. Of course, this is a no-op if there are no replica DBs.
2789 * By default this waits on the main DB cluster of the current wiki.
2790 * If $cluster is set to "*" it will wait on all DB clusters, including
2791 * external ones. If the lag being waiting on is caused by the code that
2792 * does this check, it makes since to use $ifWritesSince, particularly if
2793 * cluster is "*", to avoid excess overhead.
2795 * Never call this function after a big DB write that is still in a transaction.
2796 * This only makes sense after the possible lag inducing changes were committed.
2798 * @param float|null $ifWritesSince Only wait if writes were done since this UNIX timestamp
2799 * @param string|bool $wiki Wiki identifier accepted by wfGetLB
2800 * @param string|bool $cluster Cluster name accepted by LBFactory. Default: false.
2801 * @param int|null $timeout Max wait time. Default: 60 seconds (cli), 1 second (web)
2802 * @return bool Success (able to connect and no timeouts reached)
2803 * @deprecated since 1.27 Use LBFactory::waitForReplication
2805 function wfWaitForSlaves(
2806 $ifWritesSince = null, $wiki = false, $cluster = false, $timeout = null
2808 $lbFactory = MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
2810 if ( $cluster === '*' ) {
2813 } elseif ( $wiki === false ) {
2814 $domain = $lbFactory->getLocalDomainID();
2820 'domain' => $domain,
2821 'cluster' => $cluster,
2822 // B/C: first argument used to be "max seconds of lag"; ignore such values
2823 'ifWritesSince' => ( $ifWritesSince > 1e9
) ?
$ifWritesSince : null
2825 if ( $timeout !== null ) {
2826 $opts['timeout'] = $timeout;
2829 return $lbFactory->waitForReplication( $opts );
2833 * Count down from $seconds to zero on the terminal, with a one-second pause
2834 * between showing each number. For use in command-line scripts.
2836 * @deprecated since 1.31, use Maintenance::countDown()
2838 * @codeCoverageIgnore
2839 * @param int $seconds
2841 function wfCountDown( $seconds ) {
2842 wfDeprecated( __FUNCTION__
, '1.31' );
2843 for ( $i = $seconds; $i >= 0; $i-- ) {
2844 if ( $i != $seconds ) {
2845 echo str_repeat( "\x08", strlen( $i +
1 ) );
2857 * Replace all invalid characters with '-'.
2858 * Additional characters can be defined in $wgIllegalFileChars (see T22489).
2859 * By default, $wgIllegalFileChars includes ':', '/', '\'.
2861 * @param string $name Filename to process
2864 function wfStripIllegalFilenameChars( $name ) {
2865 global $wgIllegalFileChars;
2866 $illegalFileChars = $wgIllegalFileChars ?
"|[" . $wgIllegalFileChars . "]" : '';
2867 $name = preg_replace(
2868 "/[^" . Title
::legalChars() . "]" . $illegalFileChars . "/",
2872 // $wgIllegalFileChars may not include '/' and '\', so we still need to do this
2873 $name = wfBaseName( $name );
2878 * Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit
2880 * @return int Resulting value of the memory limit.
2882 function wfMemoryLimit() {
2883 global $wgMemoryLimit;
2884 $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
2885 if ( $memlimit != -1 ) {
2886 $conflimit = wfShorthandToInteger( $wgMemoryLimit );
2887 if ( $conflimit == -1 ) {
2888 wfDebug( "Removing PHP's memory limit\n" );
2889 Wikimedia\
suppressWarnings();
2890 ini_set( 'memory_limit', $conflimit );
2891 Wikimedia\restoreWarnings
();
2893 } elseif ( $conflimit > $memlimit ) {
2894 wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
2895 Wikimedia\
suppressWarnings();
2896 ini_set( 'memory_limit', $conflimit );
2897 Wikimedia\restoreWarnings
();
2905 * Set PHP's time limit to the larger of php.ini or $wgTransactionalTimeLimit
2907 * @return int Prior time limit
2910 function wfTransactionalTimeLimit() {
2911 global $wgTransactionalTimeLimit;
2913 $timeLimit = ini_get( 'max_execution_time' );
2914 // Note that CLI scripts use 0
2915 if ( $timeLimit > 0 && $wgTransactionalTimeLimit > $timeLimit ) {
2916 set_time_limit( $wgTransactionalTimeLimit );
2919 ignore_user_abort( true ); // ignore client disconnects
2925 * Converts shorthand byte notation to integer form
2927 * @param string $string
2928 * @param int $default Returned if $string is empty
2931 function wfShorthandToInteger( $string = '', $default = -1 ) {
2932 $string = trim( $string );
2933 if ( $string === '' ) {
2936 $last = $string[strlen( $string ) - 1];
2937 $val = intval( $string );
2942 // break intentionally missing
2946 // break intentionally missing
2956 * Get the normalised IETF language tag
2957 * See unit test for examples.
2958 * See mediawiki.language.bcp47 for the JavaScript implementation.
2960 * @deprecated since 1.31, use LanguageCode::bcp47() directly.
2962 * @param string $code The language code.
2963 * @return string The language code which complying with BCP 47 standards.
2965 function wfBCP47( $code ) {
2966 wfDeprecated( __METHOD__
, '1.31' );
2967 return LanguageCode
::bcp47( $code );
2971 * Get a specific cache object.
2973 * @deprecated since 1.32, use ObjectCache::getInstance() instead
2974 * @param int|string $cacheType A CACHE_* constants, or other key in $wgObjectCaches
2977 function wfGetCache( $cacheType ) {
2978 return ObjectCache
::getInstance( $cacheType );
2982 * Get the main cache object
2984 * @deprecated since 1.32, use ObjectCache::getLocalClusterInstance() instead
2987 function wfGetMainCache() {
2988 return ObjectCache
::getLocalClusterInstance();
2992 * Get the cache object used by the message cache
2996 function wfGetMessageCacheStorage() {
2997 global $wgMessageCacheType;
2998 return ObjectCache
::getInstance( $wgMessageCacheType );
3002 * Wrapper around php's unpack.
3004 * @param string $format The format string (See php's docs)
3005 * @param string $data A binary string of binary data
3006 * @param int|bool $length The minimum length of $data or false. This is to
3007 * prevent reading beyond the end of $data. false to disable the check.
3009 * Also be careful when using this function to read unsigned 32 bit integer
3010 * because php might make it negative.
3012 * @throws MWException If $data not long enough, or if unpack fails
3013 * @return array Associative array of the extracted data
3015 function wfUnpack( $format, $data, $length = false ) {
3016 if ( $length !== false ) {
3017 $realLen = strlen( $data );
3018 if ( $realLen < $length ) {
3019 throw new MWException( "Tried to use wfUnpack on a "
3020 . "string of length $realLen, but needed one "
3021 . "of at least length $length."
3026 Wikimedia\
suppressWarnings();
3027 $result = unpack( $format, $data );
3028 Wikimedia\restoreWarnings
();
3030 if ( $result === false ) {
3031 // If it cannot extract the packed data.
3032 throw new MWException( "unpack could not unpack binary data" );
3038 * Determine if an image exists on the 'bad image list'.
3040 * The format of MediaWiki:Bad_image_list is as follows:
3041 * * Only list items (lines starting with "*") are considered
3042 * * The first link on a line must be a link to a bad image
3043 * * Any subsequent links on the same line are considered to be exceptions,
3044 * i.e. articles where the image may occur inline.
3046 * @param string $name The image name to check
3047 * @param Title|bool $contextTitle The page on which the image occurs, if known
3048 * @param string|null $blacklist Wikitext of a file blacklist
3051 function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
3052 # Handle redirects; callers almost always hit wfFindFile() anyway,
3053 # so just use that method because it has a fast process cache.
3054 $file = wfFindFile( $name ); // get the final name
3055 $name = $file ?
$file->getTitle()->getDBkey() : $name;
3057 # Run the extension hook
3059 if ( !Hooks
::run( 'BadImage', [ $name, &$bad ] ) ) {
3063 $cache = ObjectCache
::getLocalServerInstance( 'hash' );
3064 $key = $cache->makeKey(
3065 'bad-image-list', ( $blacklist === null ) ?
'default' : md5( $blacklist )
3067 $badImages = $cache->get( $key );
3069 if ( $badImages === false ) { // cache miss
3070 if ( $blacklist === null ) {
3071 $blacklist = wfMessage( 'bad_image_list' )->inContentLanguage()->plain(); // site list
3073 # Build the list now
3075 $lines = explode( "\n", $blacklist );
3076 foreach ( $lines as $line ) {
3078 if ( substr( $line, 0, 1 ) !== '*' ) {
3084 if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
3089 $imageDBkey = false;
3090 foreach ( $m[1] as $i => $titleText ) {
3091 $title = Title
::newFromText( $titleText );
3092 if ( !is_null( $title ) ) {
3094 $imageDBkey = $title->getDBkey();
3096 $exceptions[$title->getPrefixedDBkey()] = true;
3101 if ( $imageDBkey !== false ) {
3102 $badImages[$imageDBkey] = $exceptions;
3105 $cache->set( $key, $badImages, 60 );
3108 $contextKey = $contextTitle ?
$contextTitle->getPrefixedDBkey() : false;
3109 $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
3115 * Determine whether the client at a given source IP is likely to be able to
3116 * access the wiki via HTTPS.
3118 * @param string $ip The IPv4/6 address in the normal human-readable form
3121 function wfCanIPUseHTTPS( $ip ) {
3123 Hooks
::run( 'CanIPUseHTTPS', [ $ip, &$canDo ] );
3128 * Determine input string is represents as infinity
3130 * @param string $str The string to determine
3134 function wfIsInfinity( $str ) {
3135 // These are hardcoded elsewhere in MediaWiki (e.g. mediawiki.special.block.js).
3136 $infinityValues = [ 'infinite', 'indefinite', 'infinity', 'never' ];
3137 return in_array( $str, $infinityValues );
3141 * Returns true if these thumbnail parameters match one that MediaWiki
3142 * requests from file description pages and/or parser output.
3144 * $params is considered non-standard if they involve a non-standard
3145 * width or any non-default parameters aside from width and page number.
3146 * The number of possible files with standard parameters is far less than
3147 * that of all combinations; rate-limiting for them can thus be more generious.
3150 * @param array $params
3152 * @since 1.24 Moved from thumb.php to GlobalFunctions in 1.25
3154 function wfThumbIsStandard( File
$file, array $params ) {
3155 global $wgThumbLimits, $wgImageLimits, $wgResponsiveImages;
3157 $multipliers = [ 1 ];
3158 if ( $wgResponsiveImages ) {
3159 // These available sizes are hardcoded currently elsewhere in MediaWiki.
3160 // @see Linker::processResponsiveImages
3161 $multipliers[] = 1.5;
3165 $handler = $file->getHandler();
3166 if ( !$handler ||
!isset( $params['width'] ) ) {
3171 if ( isset( $params['page'] ) ) {
3172 $basicParams['page'] = $params['page'];
3177 // Expand limits to account for multipliers
3178 foreach ( $multipliers as $multiplier ) {
3179 $thumbLimits = array_merge( $thumbLimits, array_map(
3180 function ( $width ) use ( $multiplier ) {
3181 return round( $width * $multiplier );
3184 $imageLimits = array_merge( $imageLimits, array_map(
3185 function ( $pair ) use ( $multiplier ) {
3187 round( $pair[0] * $multiplier ),
3188 round( $pair[1] * $multiplier ),
3194 // Check if the width matches one of $wgThumbLimits
3195 if ( in_array( $params['width'], $thumbLimits ) ) {
3196 $normalParams = $basicParams +
[ 'width' => $params['width'] ];
3197 // Append any default values to the map (e.g. "lossy", "lossless", ...)
3198 $handler->normaliseParams( $file, $normalParams );
3200 // If not, then check if the width matchs one of $wgImageLimits
3202 foreach ( $imageLimits as $pair ) {
3203 $normalParams = $basicParams +
[ 'width' => $pair[0], 'height' => $pair[1] ];
3204 // Decide whether the thumbnail should be scaled on width or height.
3205 // Also append any default values to the map (e.g. "lossy", "lossless", ...)
3206 $handler->normaliseParams( $file, $normalParams );
3207 // Check if this standard thumbnail size maps to the given width
3208 if ( $normalParams['width'] == $params['width'] ) {
3214 return false; // not standard for description pages
3218 // Check that the given values for non-page, non-width, params are just defaults
3219 foreach ( $params as $key => $value ) {
3220 if ( !isset( $normalParams[$key] ) ||
$normalParams[$key] != $value ) {
3229 * Merges two (possibly) 2 dimensional arrays into the target array ($baseArray).
3231 * Values that exist in both values will be combined with += (all values of the array
3232 * of $newValues will be added to the values of the array of $baseArray, while values,
3233 * that exists in both, the value of $baseArray will be used).
3235 * @param array $baseArray The array where you want to add the values of $newValues to
3236 * @param array $newValues An array with new values
3237 * @return array The combined array
3240 function wfArrayPlus2d( array $baseArray, array $newValues ) {
3241 // First merge items that are in both arrays
3242 foreach ( $baseArray as $name => &$groupVal ) {
3243 if ( isset( $newValues[$name] ) ) {
3244 $groupVal +
= $newValues[$name];
3247 // Now add items that didn't exist yet
3248 $baseArray +
= $newValues;
3254 * Get system resource usage of current request context.
3255 * Invokes the getrusage(2) system call, requesting RUSAGE_SELF if on PHP5
3256 * or RUSAGE_THREAD if on HHVM. Returns false if getrusage is not available.
3259 * @return array|bool Resource usage data or false if no data available.
3261 function wfGetRusage() {
3262 if ( !function_exists( 'getrusage' ) ) {
3264 } elseif ( defined( 'HHVM_VERSION' ) && PHP_OS
=== 'Linux' ) {
3265 return getrusage( 2 /* RUSAGE_THREAD */ );
3267 return getrusage( 0 /* RUSAGE_SELF */ );