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\Linker\LinkTarget
;
28 use MediaWiki\Logger\LoggerFactory
;
29 use MediaWiki\MediaWikiServices
;
30 use MediaWiki\ProcOpenError
;
31 use MediaWiki\Session\SessionManager
;
32 use MediaWiki\Shell\Shell
;
33 use Wikimedia\ScopedCallback
;
34 use Wikimedia\WrappedString
;
39 * This queues an extension to be loaded through
40 * the ExtensionRegistry system.
42 * @param string $ext Name of the extension to load
43 * @param string|null $path Absolute path of where to find the extension.json file
46 function wfLoadExtension( $ext, $path = null ) {
48 global $wgExtensionDirectory;
49 $path = "$wgExtensionDirectory/$ext/extension.json";
51 ExtensionRegistry
::getInstance()->queue( $path );
55 * Load multiple extensions at once
57 * Same as wfLoadExtension, but more efficient if you
58 * are loading multiple extensions.
60 * If you want to specify custom paths, you should interact with
61 * ExtensionRegistry directly.
63 * @see wfLoadExtension
64 * @param string[] $exts Array of extension names to load
67 function wfLoadExtensions( array $exts ) {
68 global $wgExtensionDirectory;
69 $registry = ExtensionRegistry
::getInstance();
70 foreach ( $exts as $ext ) {
71 $registry->queue( "$wgExtensionDirectory/$ext/extension.json" );
78 * @see wfLoadExtension
79 * @param string $skin Name of the extension to load
80 * @param string|null $path Absolute path of where to find the skin.json file
83 function wfLoadSkin( $skin, $path = null ) {
85 global $wgStyleDirectory;
86 $path = "$wgStyleDirectory/$skin/skin.json";
88 ExtensionRegistry
::getInstance()->queue( $path );
92 * Load multiple skins at once
94 * @see wfLoadExtensions
95 * @param string[] $skins Array of extension names to load
98 function wfLoadSkins( array $skins ) {
99 global $wgStyleDirectory;
100 $registry = ExtensionRegistry
::getInstance();
101 foreach ( $skins as $skin ) {
102 $registry->queue( "$wgStyleDirectory/$skin/skin.json" );
107 * Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
112 function wfArrayDiff2( $a, $b ) {
113 return array_udiff( $a, $b, 'wfArrayDiff2_cmp' );
117 * @param array|string $a
118 * @param array|string $b
121 function wfArrayDiff2_cmp( $a, $b ) {
122 if ( is_string( $a ) && is_string( $b ) ) {
123 return strcmp( $a, $b );
124 } elseif ( count( $a ) !== count( $b ) ) {
125 return count( $a ) <=> count( $b );
129 while ( key( $a ) !== null && key( $b ) !== null ) {
130 $valueA = current( $a );
131 $valueB = current( $b );
132 $cmp = strcmp( $valueA, $valueB );
144 * @deprecated since 1.32, use array_filter() with ARRAY_FILTER_USE_BOTH directly
147 * @param callable $callback Will be called with the array value and key (in that order) and
148 * should return a bool which will determine whether the array element is kept.
151 function wfArrayFilter( array $arr, callable
$callback ) {
152 wfDeprecated( __FUNCTION__
, '1.32' );
153 return array_filter( $arr, $callback, ARRAY_FILTER_USE_BOTH
);
157 * @deprecated since 1.32, use array_filter() with ARRAY_FILTER_USE_KEY directly
160 * @param callable $callback Will be called with the array key and should return a bool which
161 * will determine whether the array element is kept.
164 function wfArrayFilterByKey( array $arr, callable
$callback ) {
165 wfDeprecated( __FUNCTION__
, '1.32' );
166 return array_filter( $arr, $callback, ARRAY_FILTER_USE_KEY
);
170 * Appends to second array if $value differs from that in $default
172 * @param string|int $key
173 * @param mixed $value
174 * @param mixed $default
175 * @param array &$changed Array to alter
176 * @throws MWException
178 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
179 if ( is_null( $changed ) ) {
180 throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' );
182 if ( $default[$key] !== $value ) {
183 $changed[$key] = $value;
188 * Merge arrays in the style of getUserPermissionsErrors, with duplicate removal
190 * wfMergeErrorArrays(
203 * @param array ...$args
206 function wfMergeErrorArrays( ...$args ) {
208 foreach ( $args as $errors ) {
209 foreach ( $errors as $params ) {
210 $originalParams = $params;
211 if ( $params[0] instanceof MessageSpecifier
) {
213 $params = array_merge( [ $msg->getKey() ], $msg->getParams() );
215 # @todo FIXME: Sometimes get nested arrays for $params,
216 # which leads to E_NOTICEs
217 $spec = implode( "\t", $params );
218 $out[$spec] = $originalParams;
221 return array_values( $out );
225 * Insert array into another array after the specified *KEY*
227 * @param array $array The array.
228 * @param array $insert The array to insert.
229 * @param mixed $after The key to insert after. Callers need to make sure the key is set.
232 function wfArrayInsertAfter( array $array, array $insert, $after ) {
233 // Find the offset of the element to insert after.
234 $keys = array_keys( $array );
235 $offsetByKey = array_flip( $keys );
237 $offset = $offsetByKey[$after];
239 // Insert at the specified offset
240 $before = array_slice( $array, 0, $offset +
1, true );
241 $after = array_slice( $array, $offset +
1, count( $array ) - $offset, true );
243 $output = $before +
$insert +
$after;
249 * Recursively converts the parameter (an object) to an array with the same data
251 * @param object|array $objOrArray
252 * @param bool $recursive
255 function wfObjectToArray( $objOrArray, $recursive = true ) {
257 if ( is_object( $objOrArray ) ) {
258 $objOrArray = get_object_vars( $objOrArray );
260 foreach ( $objOrArray as $key => $value ) {
261 if ( $recursive && ( is_object( $value ) ||
is_array( $value ) ) ) {
262 $value = wfObjectToArray( $value );
265 $array[$key] = $value;
272 * Get a random decimal value in the domain of [0, 1), in a way
273 * not likely to give duplicate values for any realistic
274 * number of articles.
276 * @note This is designed for use in relation to Special:RandomPage
277 * and the page_random database field.
281 function wfRandom() {
282 // The maximum random value is "only" 2^31-1, so get two random
283 // values to reduce the chance of dupes
284 $max = mt_getrandmax() +
1;
285 $rand = number_format( ( mt_rand() * $max +
mt_rand() ) / $max / $max, 12, '.', '' );
290 * Get a random string containing a number of pseudo-random hex characters.
292 * @note This is not secure, if you are trying to generate some sort
293 * of token please use MWCryptRand instead.
295 * @param int $length The length of the string to generate
299 function wfRandomString( $length = 32 ) {
301 for ( $n = 0; $n < $length; $n +
= 7 ) {
302 $str .= sprintf( '%07x', mt_rand() & 0xfffffff );
304 return substr( $str, 0, $length );
308 * We want some things to be included as literal characters in our title URLs
309 * for prettiness, which urlencode encodes by default. According to RFC 1738,
310 * all of the following should be safe:
314 * RFC 1738 says ~ is unsafe, however RFC 3986 considers it an unreserved
315 * character which should not be encoded. More importantly, google chrome
316 * always converts %7E back to ~, and converting it in this function can
317 * cause a redirect loop (T105265).
319 * But + is not safe because it's used to indicate a space; &= are only safe in
320 * paths and not in queries (and we don't distinguish here); ' seems kind of
321 * scary; and urlencode() doesn't touch -_. to begin with. Plus, although /
322 * is reserved, we don't care. So the list we unescape is:
326 * However, IIS7 redirects fail when the url contains a colon (see T24709),
327 * so no fancy : for IIS7.
329 * %2F in the page titles seems to fatally break for some reason.
334 function wfUrlencode( $s ) {
337 if ( is_null( $s ) ) {
338 // Reset $needle for testing.
343 if ( is_null( $needle ) ) {
344 $needle = [ '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F', '%7E' ];
345 if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) ||
346 ( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false )
352 $s = urlencode( $s );
355 [ ';', '@', '$', '!', '*', '(', ')', ',', '/', '~', ':' ],
363 * This function takes one or two arrays as input, and returns a CGI-style string, e.g.
364 * "days=7&limit=100". Options in the first array override options in the second.
365 * Options set to null or false will not be output.
367 * @param array $array1 ( String|Array )
368 * @param array|null $array2 ( String|Array )
369 * @param string $prefix
372 function wfArrayToCgi( $array1, $array2 = null, $prefix = '' ) {
373 if ( !is_null( $array2 ) ) {
374 $array1 = $array1 +
$array2;
378 foreach ( $array1 as $key => $value ) {
379 if ( !is_null( $value ) && $value !== false ) {
383 if ( $prefix !== '' ) {
384 $key = $prefix . "[$key]";
386 if ( is_array( $value ) ) {
388 foreach ( $value as $k => $v ) {
389 $cgi .= $firstTime ?
'' : '&';
390 if ( is_array( $v ) ) {
391 $cgi .= wfArrayToCgi( $v, null, $key . "[$k]" );
393 $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v );
398 if ( is_object( $value ) ) {
399 $value = $value->__toString();
401 $cgi .= urlencode( $key ) . '=' . urlencode( $value );
409 * This is the logical opposite of wfArrayToCgi(): it accepts a query string as
410 * its argument and returns the same string in array form. This allows compatibility
411 * with legacy functions that accept raw query strings instead of nice
412 * arrays. Of course, keys and values are urldecode()d.
414 * @param string $query Query string
415 * @return string[] Array version of input
417 function wfCgiToArray( $query ) {
418 if ( isset( $query[0] ) && $query[0] == '?' ) {
419 $query = substr( $query, 1 );
421 $bits = explode( '&', $query );
423 foreach ( $bits as $bit ) {
427 if ( strpos( $bit, '=' ) === false ) {
428 // Pieces like &qwerty become 'qwerty' => '' (at least this is what php does)
432 list( $key, $value ) = explode( '=', $bit );
434 $key = urldecode( $key );
435 $value = urldecode( $value );
436 if ( strpos( $key, '[' ) !== false ) {
437 $keys = array_reverse( explode( '[', $key ) );
438 $key = array_pop( $keys );
440 foreach ( $keys as $k ) {
441 $k = substr( $k, 0, -1 );
442 $temp = [ $k => $temp ];
444 if ( isset( $ret[$key] ) ) {
445 $ret[$key] = array_merge( $ret[$key], $temp );
457 * Append a query string to an existing URL, which may or may not already
458 * have query string parameters already. If so, they will be combined.
461 * @param string|string[] $query String or associative array
464 function wfAppendQuery( $url, $query ) {
465 if ( is_array( $query ) ) {
466 $query = wfArrayToCgi( $query );
468 if ( $query != '' ) {
469 // Remove the fragment, if there is one
471 $hashPos = strpos( $url, '#' );
472 if ( $hashPos !== false ) {
473 $fragment = substr( $url, $hashPos );
474 $url = substr( $url, 0, $hashPos );
478 if ( strpos( $url, '?' ) === false ) {
485 // Put the fragment back
486 if ( $fragment !== false ) {
494 * Expand a potentially local URL to a fully-qualified URL. Assumes $wgServer
497 * The meaning of the PROTO_* constants is as follows:
498 * PROTO_HTTP: Output a URL starting with http://
499 * PROTO_HTTPS: Output a URL starting with https://
500 * PROTO_RELATIVE: Output a URL starting with // (protocol-relative URL)
501 * PROTO_CURRENT: Output a URL starting with either http:// or https:// , depending
502 * on which protocol was used for the current incoming request
503 * PROTO_CANONICAL: For URLs without a domain, like /w/index.php , use $wgCanonicalServer.
504 * For protocol-relative URLs, use the protocol of $wgCanonicalServer
505 * PROTO_INTERNAL: Like PROTO_CANONICAL, but uses $wgInternalServer instead of $wgCanonicalServer
507 * @todo this won't work with current-path-relative URLs
508 * like "subdir/foo.html", etc.
510 * @param string $url Either fully-qualified or a local path + query
511 * @param string|int|null $defaultProto One of the PROTO_* constants. Determines the
512 * protocol to use if $url or $wgServer is protocol-relative
513 * @return string|false Fully-qualified URL, current-path-relative URL or false if
514 * no valid URL can be constructed
516 function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT
) {
517 global $wgServer, $wgCanonicalServer, $wgInternalServer, $wgRequest,
519 if ( $defaultProto === PROTO_CANONICAL
) {
520 $serverUrl = $wgCanonicalServer;
521 } elseif ( $defaultProto === PROTO_INTERNAL
&& $wgInternalServer !== false ) {
522 // Make $wgInternalServer fall back to $wgServer if not set
523 $serverUrl = $wgInternalServer;
525 $serverUrl = $wgServer;
526 if ( $defaultProto === PROTO_CURRENT
) {
527 $defaultProto = $wgRequest->getProtocol() . '://';
531 // Analyze $serverUrl to obtain its protocol
532 $bits = wfParseUrl( $serverUrl );
533 $serverHasProto = $bits && $bits['scheme'] != '';
535 if ( $defaultProto === PROTO_CANONICAL ||
$defaultProto === PROTO_INTERNAL
) {
536 if ( $serverHasProto ) {
537 $defaultProto = $bits['scheme'] . '://';
539 // $wgCanonicalServer or $wgInternalServer doesn't have a protocol.
540 // This really isn't supposed to happen. Fall back to HTTP in this
542 $defaultProto = PROTO_HTTP
;
546 $defaultProtoWithoutSlashes = substr( $defaultProto, 0, -2 );
548 if ( substr( $url, 0, 2 ) == '//' ) {
549 $url = $defaultProtoWithoutSlashes . $url;
550 } elseif ( substr( $url, 0, 1 ) == '/' ) {
551 // If $serverUrl is protocol-relative, prepend $defaultProtoWithoutSlashes,
552 // otherwise leave it alone.
553 if ( $serverHasProto ) {
554 $url = $serverUrl . $url;
556 // If an HTTPS URL is synthesized from a protocol-relative $wgServer, allow the
557 // user to override the port number (T67184)
558 if ( $defaultProto === PROTO_HTTPS
&& $wgHttpsPort != 443 ) {
559 if ( isset( $bits['port'] ) ) {
560 throw new Exception( 'A protocol-relative $wgServer may not contain a port number' );
562 $url = $defaultProtoWithoutSlashes . $serverUrl . ':' . $wgHttpsPort . $url;
564 $url = $defaultProtoWithoutSlashes . $serverUrl . $url;
569 $bits = wfParseUrl( $url );
571 if ( $bits && isset( $bits['path'] ) ) {
572 $bits['path'] = wfRemoveDotSegments( $bits['path'] );
573 return wfAssembleUrl( $bits );
577 } elseif ( substr( $url, 0, 1 ) != '/' ) {
578 # URL is a relative path
579 return wfRemoveDotSegments( $url );
582 # Expanded URL is not valid.
587 * Get the wiki's "server", i.e. the protocol and host part of the URL, with a
588 * protocol specified using a PROTO_* constant as in wfExpandUrl()
591 * @param string|int|null $proto One of the PROTO_* constants.
592 * @return string The URL
594 function wfGetServerUrl( $proto ) {
595 $url = wfExpandUrl( '/', $proto );
596 return substr( $url, 0, -1 );
600 * This function will reassemble a URL parsed with wfParseURL. This is useful
601 * if you need to edit part of a URL and put it back together.
603 * This is the basic structure used (brackets contain keys for $urlParts):
604 * [scheme][delimiter][user]:[pass]@[host]:[port][path]?[query]#[fragment]
606 * @todo Need to integrate this into wfExpandUrl (see T34168)
609 * @param array $urlParts URL parts, as output from wfParseUrl
610 * @return string URL assembled from its component parts
612 function wfAssembleUrl( $urlParts ) {
615 if ( isset( $urlParts['delimiter'] ) ) {
616 if ( isset( $urlParts['scheme'] ) ) {
617 $result .= $urlParts['scheme'];
620 $result .= $urlParts['delimiter'];
623 if ( isset( $urlParts['host'] ) ) {
624 if ( isset( $urlParts['user'] ) ) {
625 $result .= $urlParts['user'];
626 if ( isset( $urlParts['pass'] ) ) {
627 $result .= ':' . $urlParts['pass'];
632 $result .= $urlParts['host'];
634 if ( isset( $urlParts['port'] ) ) {
635 $result .= ':' . $urlParts['port'];
639 if ( isset( $urlParts['path'] ) ) {
640 $result .= $urlParts['path'];
643 if ( isset( $urlParts['query'] ) ) {
644 $result .= '?' . $urlParts['query'];
647 if ( isset( $urlParts['fragment'] ) ) {
648 $result .= '#' . $urlParts['fragment'];
655 * Remove all dot-segments in the provided URL path. For example,
656 * '/a/./b/../c/' becomes '/a/c/'. For details on the algorithm, please see
657 * RFC3986 section 5.2.4.
659 * @todo Need to integrate this into wfExpandUrl (see T34168)
663 * @param string $urlPath URL path, potentially containing dot-segments
664 * @return string URL path with all dot-segments removed
666 function wfRemoveDotSegments( $urlPath ) {
669 $inputLength = strlen( $urlPath );
671 while ( $inputOffset < $inputLength ) {
672 $prefixLengthOne = substr( $urlPath, $inputOffset, 1 );
673 $prefixLengthTwo = substr( $urlPath, $inputOffset, 2 );
674 $prefixLengthThree = substr( $urlPath, $inputOffset, 3 );
675 $prefixLengthFour = substr( $urlPath, $inputOffset, 4 );
678 if ( $prefixLengthTwo == './' ) {
679 # Step A, remove leading "./"
681 } elseif ( $prefixLengthThree == '../' ) {
682 # Step A, remove leading "../"
684 } elseif ( ( $prefixLengthTwo == '/.' ) && ( $inputOffset +
2 == $inputLength ) ) {
685 # Step B, replace leading "/.$" with "/"
687 $urlPath[$inputOffset] = '/';
688 } elseif ( $prefixLengthThree == '/./' ) {
689 # Step B, replace leading "/./" with "/"
691 } elseif ( $prefixLengthThree == '/..' && ( $inputOffset +
3 == $inputLength ) ) {
692 # Step C, replace leading "/..$" with "/" and
693 # remove last path component in output
695 $urlPath[$inputOffset] = '/';
697 } elseif ( $prefixLengthFour == '/../' ) {
698 # Step C, replace leading "/../" with "/" and
699 # remove last path component in output
702 } elseif ( ( $prefixLengthOne == '.' ) && ( $inputOffset +
1 == $inputLength ) ) {
703 # Step D, remove "^.$"
705 } elseif ( ( $prefixLengthTwo == '..' ) && ( $inputOffset +
2 == $inputLength ) ) {
706 # Step D, remove "^..$"
709 # Step E, move leading path segment to output
710 if ( $prefixLengthOne == '/' ) {
711 $slashPos = strpos( $urlPath, '/', $inputOffset +
1 );
713 $slashPos = strpos( $urlPath, '/', $inputOffset );
715 if ( $slashPos === false ) {
716 $output .= substr( $urlPath, $inputOffset );
717 $inputOffset = $inputLength;
719 $output .= substr( $urlPath, $inputOffset, $slashPos - $inputOffset );
720 $inputOffset +
= $slashPos - $inputOffset;
725 $slashPos = strrpos( $output, '/' );
726 if ( $slashPos === false ) {
729 $output = substr( $output, 0, $slashPos );
738 * Returns a regular expression of url protocols
740 * @param bool $includeProtocolRelative If false, remove '//' from the returned protocol list.
741 * DO NOT USE this directly, use wfUrlProtocolsWithoutProtRel() instead
744 function wfUrlProtocols( $includeProtocolRelative = true ) {
745 global $wgUrlProtocols;
747 // Cache return values separately based on $includeProtocolRelative
748 static $withProtRel = null, $withoutProtRel = null;
749 $cachedValue = $includeProtocolRelative ?
$withProtRel : $withoutProtRel;
750 if ( !is_null( $cachedValue ) ) {
754 // Support old-style $wgUrlProtocols strings, for backwards compatibility
755 // with LocalSettings files from 1.5
756 if ( is_array( $wgUrlProtocols ) ) {
758 foreach ( $wgUrlProtocols as $protocol ) {
759 // Filter out '//' if !$includeProtocolRelative
760 if ( $includeProtocolRelative ||
$protocol !== '//' ) {
761 $protocols[] = preg_quote( $protocol, '/' );
765 $retval = implode( '|', $protocols );
767 // Ignore $includeProtocolRelative in this case
768 // This case exists for pre-1.6 compatibility, and we can safely assume
769 // that '//' won't appear in a pre-1.6 config because protocol-relative
770 // URLs weren't supported until 1.18
771 $retval = $wgUrlProtocols;
774 // Cache return value
775 if ( $includeProtocolRelative ) {
776 $withProtRel = $retval;
778 $withoutProtRel = $retval;
784 * Like wfUrlProtocols(), but excludes '//' from the protocol list. Use this if
785 * you need a regex that matches all URL protocols but does not match protocol-
789 function wfUrlProtocolsWithoutProtRel() {
790 return wfUrlProtocols( false );
794 * parse_url() work-alike, but non-broken. Differences:
796 * 1) Does not raise warnings on bad URLs (just returns false).
797 * 2) Handles protocols that don't use :// (e.g., mailto: and news:, as well as
798 * protocol-relative URLs) correctly.
799 * 3) Adds a "delimiter" element to the array (see (2)).
800 * 4) Verifies that the protocol is on the $wgUrlProtocols whitelist.
801 * 5) Rejects some invalid URLs that parse_url doesn't, e.g. the empty string or URLs starting with
802 * a line feed character.
804 * @param string $url A URL to parse
805 * @return string[]|bool Bits of the URL in an associative array, or false on failure.
807 * - scheme: URI scheme (protocol), e.g. 'http', 'mailto'. Lowercase, always present, but can
808 * be an empty string for protocol-relative URLs.
809 * - delimiter: either '://', ':' or '//'. Always present.
810 * - host: domain name / IP. Always present, but could be an empty string, e.g. for file: URLs.
811 * - user: user name, e.g. for HTTP Basic auth URLs such as http://user:pass@example.com/
812 * Missing when there is no username.
813 * - pass: password, same as above.
814 * - path: path including the leading /. Will be missing when empty (e.g. 'http://example.com')
815 * - query: query string (as a string; see wfCgiToArray() for parsing it), can be missing.
816 * - fragment: the part after #, can be missing.
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 Wikimedia\
suppressWarnings();
829 $bits = parse_url( $url );
830 Wikimedia\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 function ( array $matches ) {
892 return urldecode( $matches[1] );
899 * Make URL indexes, appropriate for the el_index field of externallinks.
901 * @deprecated since 1.33, use LinkFilter::makeIndexes() instead
905 function wfMakeUrlIndexes( $url ) {
906 wfDeprecated( __FUNCTION__
, '1.33' );
907 return LinkFilter
::makeIndexes( $url );
911 * Check whether a given URL has a domain that occurs in a given set of domains
913 * @param array $domains Array of domains (strings)
914 * @return bool True if the host part of $url ends in one of the strings in $domains
916 function wfMatchesDomainList( $url, $domains ) {
917 $bits = wfParseUrl( $url );
918 if ( is_array( $bits ) && isset( $bits['host'] ) ) {
919 $host = '.' . $bits['host'];
920 foreach ( (array)$domains as $domain ) {
921 $domain = '.' . $domain;
922 if ( substr( $host, -strlen( $domain ) ) === $domain ) {
931 * Sends a line to the debug log if enabled or, optionally, to a comment in output.
932 * In normal operation this is a NOP.
934 * Controlling globals:
935 * $wgDebugLogFile - points to the log file
936 * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
937 * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
939 * @since 1.25 support for additional context data
941 * @param string $text
942 * @param string|bool $dest Destination of the message:
943 * - 'all': both to the log and HTML (debug toolbar or HTML comments)
944 * - 'private': excluded from HTML output
945 * For backward compatibility, it can also take a boolean:
946 * - true: same as 'all'
947 * - false: same as 'private'
948 * @param array $context Additional logging context data
950 function wfDebug( $text, $dest = 'all', array $context = [] ) {
951 global $wgDebugRawPage, $wgDebugLogPrefix;
952 global $wgDebugTimestamps;
954 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
958 $text = trim( $text );
960 if ( $wgDebugTimestamps ) {
961 $context['seconds_elapsed'] = sprintf(
963 microtime( true ) - $_SERVER['REQUEST_TIME_FLOAT']
965 $context['memory_used'] = sprintf(
967 ( memory_get_usage( true ) / ( 1024 * 1024 ) )
971 if ( $wgDebugLogPrefix !== '' ) {
972 $context['prefix'] = $wgDebugLogPrefix;
974 $context['private'] = ( $dest === false ||
$dest === 'private' );
976 $logger = LoggerFactory
::getInstance( 'wfDebug' );
977 $logger->debug( $text, $context );
981 * Returns true if debug logging should be suppressed if $wgDebugRawPage = false
984 function wfIsDebugRawPage() {
986 if ( $cache !== null ) {
989 // Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
990 // phpcs:ignore MediaWiki.Usage.SuperGlobalsUsage.SuperGlobals
991 if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
993 isset( $_SERVER['SCRIPT_NAME'] )
994 && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
1005 * Send a line giving PHP memory usage.
1007 * @param bool $exact Print exact byte values instead of kibibytes (default: false)
1009 function wfDebugMem( $exact = false ) {
1010 $mem = memory_get_usage();
1012 $mem = floor( $mem / 1024 ) . ' KiB';
1016 wfDebug( "Memory usage: $mem\n" );
1020 * Send a line to a supplementary debug log file, if configured, or main debug
1023 * To configure a supplementary log file, set $wgDebugLogGroups[$logGroup] to
1024 * a string filename or an associative array mapping 'destination' to the
1025 * desired filename. The associative array may also contain a 'sample' key
1026 * with an integer value, specifying a sampling factor. Sampled log events
1027 * will be emitted with a 1 in N random chance.
1029 * @since 1.23 support for sampling log messages via $wgDebugLogGroups.
1030 * @since 1.25 support for additional context data
1031 * @since 1.25 sample behavior dependent on configured $wgMWLoggerDefaultSpi
1033 * @param string $logGroup
1034 * @param string $text
1035 * @param string|bool $dest Destination of the message:
1036 * - 'all': both to the log and HTML (debug toolbar or HTML comments)
1037 * - 'private': only to the specific log if set in $wgDebugLogGroups and
1038 * discarded otherwise
1039 * For backward compatibility, it can also take a boolean:
1040 * - true: same as 'all'
1041 * - false: same as 'private'
1042 * @param array $context Additional logging context data
1044 function wfDebugLog(
1045 $logGroup, $text, $dest = 'all', array $context = []
1047 $text = trim( $text );
1049 $logger = LoggerFactory
::getInstance( $logGroup );
1050 $context['private'] = ( $dest === false ||
$dest === 'private' );
1051 $logger->info( $text, $context );
1055 * Log for database errors
1057 * @since 1.25 support for additional context data
1059 * @param string $text Database error message.
1060 * @param array $context Additional logging context data
1062 function wfLogDBError( $text, array $context = [] ) {
1063 $logger = LoggerFactory
::getInstance( 'wfLogDBError' );
1064 $logger->error( trim( $text ), $context );
1068 * Throws a warning that $function is deprecated
1070 * @param string $function Function that is deprecated.
1071 * @param string|bool $version Version of MediaWiki that the function
1072 * was deprecated in (Added in 1.19).
1073 * @param string|bool $component Component to which the function belongs.
1074 * If false, it is assumed the function is in MediaWiki core (Added in 1.19).
1075 * @param int $callerOffset How far up the call stack is the original
1076 * caller. 2 = function that called the function that called
1077 * wfDeprecated (Added in 1.20).
1079 function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) {
1080 MWDebug
::deprecated( $function, $version, $component, $callerOffset +
1 );
1084 * Send a warning either to the debug log or in a PHP error depending on
1085 * $wgDevelopmentWarnings. To log warnings in production, use wfLogWarning() instead.
1087 * @param string $msg Message to send
1088 * @param int $callerOffset Number of items to go back in the backtrace to
1089 * find the correct caller (1 = function calling wfWarn, ...)
1090 * @param int $level PHP error level; defaults to E_USER_NOTICE;
1091 * only used when $wgDevelopmentWarnings is true
1093 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE
) {
1094 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'auto' );
1098 * Send a warning as a PHP error and the debug log. This is intended for logging
1099 * warnings in production. For logging development warnings, use WfWarn instead.
1101 * @param string $msg Message to send
1102 * @param int $callerOffset Number of items to go back in the backtrace to
1103 * find the correct caller (1 = function calling wfLogWarning, ...)
1104 * @param int $level PHP error level; defaults to E_USER_WARNING
1106 function wfLogWarning( $msg, $callerOffset = 1, $level = E_USER_WARNING
) {
1107 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'production' );
1112 * @todo Move logic to MediaWiki.php
1114 function wfLogProfilingData() {
1115 global $wgDebugLogGroups, $wgDebugRawPage;
1117 $context = RequestContext
::getMain();
1118 $request = $context->getRequest();
1120 $profiler = Profiler
::instance();
1121 $profiler->setContext( $context );
1122 $profiler->logData();
1124 // Send out any buffered statsd metrics as needed
1125 MediaWiki
::emitBufferedStatsdData(
1126 MediaWikiServices
::getInstance()->getStatsdDataFactory(),
1127 $context->getConfig()
1130 // Profiling must actually be enabled...
1131 if ( $profiler instanceof ProfilerStub
) {
1135 if ( isset( $wgDebugLogGroups['profileoutput'] )
1136 && $wgDebugLogGroups['profileoutput'] === false
1138 // Explicitly disabled
1141 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1145 $ctx = [ 'elapsed' => $request->getElapsedTime() ];
1146 if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1147 $ctx['forwarded_for'] = $_SERVER['HTTP_X_FORWARDED_FOR'];
1149 if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1150 $ctx['client_ip'] = $_SERVER['HTTP_CLIENT_IP'];
1152 if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1153 $ctx['from'] = $_SERVER['HTTP_FROM'];
1155 if ( isset( $ctx['forwarded_for'] ) ||
1156 isset( $ctx['client_ip'] ) ||
1157 isset( $ctx['from'] ) ) {
1158 $ctx['proxy'] = $_SERVER['REMOTE_ADDR'];
1161 // Don't load $wgUser at this late stage just for statistics purposes
1162 // @todo FIXME: We can detect some anons even if it is not loaded.
1163 // See User::getId()
1164 $user = $context->getUser();
1165 $ctx['anon'] = $user->isItemLoaded( 'id' ) && $user->isAnon();
1167 // Command line script uses a FauxRequest object which does not have
1168 // any knowledge about an URL and throw an exception instead.
1170 $ctx['url'] = urldecode( $request->getRequestURL() );
1171 } catch ( Exception
$ignored ) {
1175 $ctx['output'] = $profiler->getOutput();
1177 $log = LoggerFactory
::getInstance( 'profileoutput' );
1178 $log->info( "Elapsed: {elapsed}; URL: <{url}>\n{output}", $ctx );
1182 * Increment a statistics counter
1184 * @param string $key
1188 function wfIncrStats( $key, $count = 1 ) {
1189 $stats = MediaWikiServices
::getInstance()->getStatsdDataFactory();
1190 $stats->updateCount( $key, $count );
1194 * Check whether the wiki is in read-only mode.
1198 function wfReadOnly() {
1199 return MediaWikiServices
::getInstance()->getReadOnlyMode()
1204 * Check if the site is in read-only mode and return the message if so
1206 * This checks wfConfiguredReadOnlyReason() and the main load balancer
1207 * for replica DB lag. This may result in DB connection being made.
1209 * @return string|bool String when in read-only mode; false otherwise
1211 function wfReadOnlyReason() {
1212 return MediaWikiServices
::getInstance()->getReadOnlyMode()
1217 * Get the value of $wgReadOnly or the contents of $wgReadOnlyFile.
1219 * @return string|bool String when in read-only mode; false otherwise
1222 function wfConfiguredReadOnlyReason() {
1223 return MediaWikiServices
::getInstance()->getConfiguredReadOnlyMode()
1228 * Return a Language object from $langcode
1230 * @param Language|string|bool $langcode Either:
1231 * - a Language object
1232 * - code of the language to get the message for, if it is
1233 * a valid code create a language for that language, if
1234 * it is a string but not a valid code then make a basic
1236 * - a boolean: if it's false then use the global object for
1237 * the current user's language (as a fallback for the old parameter
1238 * functionality), or if it is true then use global object
1239 * for the wiki's content language.
1242 function wfGetLangObj( $langcode = false ) {
1243 # Identify which language to get or create a language object for.
1244 # Using is_object here due to Stub objects.
1245 if ( is_object( $langcode ) ) {
1246 # Great, we already have the object (hopefully)!
1250 global $wgLanguageCode;
1251 if ( $langcode === true ||
$langcode === $wgLanguageCode ) {
1252 # $langcode is the language code of the wikis content language object.
1253 # or it is a boolean and value is true
1254 return MediaWikiServices
::getInstance()->getContentLanguage();
1258 if ( $langcode === false ||
$langcode === $wgLang->getCode() ) {
1259 # $langcode is the language code of user language object.
1260 # or it was a boolean and value is false
1264 $validCodes = array_keys( Language
::fetchLanguageNames() );
1265 if ( in_array( $langcode, $validCodes ) ) {
1266 # $langcode corresponds to a valid language.
1267 return Language
::factory( $langcode );
1270 # $langcode is a string, but not a valid language code; use content language.
1271 wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1272 return MediaWikiServices
::getInstance()->getContentLanguage();
1276 * This is the function for getting translated interface messages.
1278 * @see Message class for documentation how to use them.
1279 * @see https://www.mediawiki.org/wiki/Manual:Messages_API
1281 * This function replaces all old wfMsg* functions.
1283 * @param string|string[]|MessageSpecifier $key Message key, or array of keys, or a MessageSpecifier
1284 * @param string|string[] ...$params Normal message parameters
1289 * @see Message::__construct
1291 function wfMessage( $key, ...$params ) {
1292 $message = new Message( $key );
1294 // We call Message::params() to reduce code duplication
1296 $message->params( ...$params );
1303 * This function accepts multiple message keys and returns a message instance
1304 * for the first message which is non-empty. If all messages are empty then an
1305 * instance of the first message key is returned.
1307 * @param string ...$keys Message keys
1312 * @see Message::newFallbackSequence
1314 function wfMessageFallback( ...$keys ) {
1315 return Message
::newFallbackSequence( ...$keys );
1319 * Replace message parameter keys on the given formatted output.
1321 * @param string $message
1322 * @param array $args
1326 function wfMsgReplaceArgs( $message, $args ) {
1327 # Fix windows line-endings
1328 # Some messages are split with explode("\n", $msg)
1329 $message = str_replace( "\r", '', $message );
1331 // Replace arguments
1332 if ( is_array( $args ) && $args ) {
1333 if ( is_array( $args[0] ) ) {
1334 $args = array_values( $args[0] );
1336 $replacementKeys = [];
1337 foreach ( $args as $n => $param ) {
1338 $replacementKeys['$' . ( $n +
1 )] = $param;
1340 $message = strtr( $message, $replacementKeys );
1347 * Fetch server name for use in error reporting etc.
1348 * Use real server name if available, so we know which machine
1349 * in a server farm generated the current page.
1353 function wfHostname() {
1355 if ( is_null( $host ) ) {
1356 # Hostname overriding
1357 global $wgOverrideHostname;
1358 if ( $wgOverrideHostname !== false ) {
1359 # Set static and skip any detection
1360 $host = $wgOverrideHostname;
1364 if ( function_exists( 'posix_uname' ) ) {
1365 // This function not present on Windows
1366 $uname = posix_uname();
1370 if ( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1371 $host = $uname['nodename'];
1372 } elseif ( getenv( 'COMPUTERNAME' ) ) {
1373 # Windows computer name
1374 $host = getenv( 'COMPUTERNAME' );
1376 # This may be a virtual server.
1377 $host = $_SERVER['SERVER_NAME'];
1384 * Returns a script tag that stores the amount of time it took MediaWiki to
1385 * handle the request in milliseconds as 'wgBackendResponseTime'.
1387 * If $wgShowHostnames is true, the script will also set 'wgHostname' to the
1388 * hostname of the server handling the request.
1390 * @param string|null $nonce Value from OutputPage::getCSPNonce
1391 * @return string|WrappedString HTML
1393 function wfReportTime( $nonce = null ) {
1394 global $wgShowHostnames;
1396 $elapsed = ( microtime( true ) - $_SERVER['REQUEST_TIME_FLOAT'] );
1397 // seconds to milliseconds
1398 $responseTime = round( $elapsed * 1000 );
1399 $reportVars = [ 'wgBackendResponseTime' => $responseTime ];
1400 if ( $wgShowHostnames ) {
1401 $reportVars['wgHostname'] = wfHostname();
1403 return Skin
::makeVariablesScript( $reportVars, $nonce );
1407 * Safety wrapper for debug_backtrace().
1409 * Will return an empty array if debug_backtrace is disabled, otherwise
1410 * the output from debug_backtrace() (trimmed).
1412 * @param int $limit This parameter can be used to limit the number of stack frames returned
1414 * @return array Array of backtrace information
1416 function wfDebugBacktrace( $limit = 0 ) {
1417 static $disabled = null;
1419 if ( is_null( $disabled ) ) {
1420 $disabled = !function_exists( 'debug_backtrace' );
1422 wfDebug( "debug_backtrace() is disabled\n" );
1430 return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT
, $limit +
1 ), 1 );
1432 return array_slice( debug_backtrace(), 1 );
1437 * Get a debug backtrace as a string
1439 * @param bool|null $raw If true, the return value is plain text. If false, HTML.
1440 * Defaults to $wgCommandLineMode if unset.
1442 * @since 1.25 Supports $raw parameter.
1444 function wfBacktrace( $raw = null ) {
1445 global $wgCommandLineMode;
1447 if ( $raw === null ) {
1448 $raw = $wgCommandLineMode;
1452 $frameFormat = "%s line %s calls %s()\n";
1453 $traceFormat = "%s";
1455 $frameFormat = "<li>%s line %s calls %s()</li>\n";
1456 $traceFormat = "<ul>\n%s</ul>\n";
1459 $frames = array_map( function ( $frame ) use ( $frameFormat ) {
1460 $file = !empty( $frame['file'] ) ?
basename( $frame['file'] ) : '-';
1461 $line = $frame['line'] ??
'-';
1462 $call = $frame['function'];
1463 if ( !empty( $frame['class'] ) ) {
1464 $call = $frame['class'] . $frame['type'] . $call;
1466 return sprintf( $frameFormat, $file, $line, $call );
1467 }, wfDebugBacktrace() );
1469 return sprintf( $traceFormat, implode( '', $frames ) );
1473 * Get the name of the function which called this function
1474 * wfGetCaller( 1 ) is the function with the wfGetCaller() call (ie. __FUNCTION__)
1475 * wfGetCaller( 2 ) [default] is the caller of the function running wfGetCaller()
1476 * wfGetCaller( 3 ) is the parent of that.
1481 function wfGetCaller( $level = 2 ) {
1482 $backtrace = wfDebugBacktrace( $level +
1 );
1483 if ( isset( $backtrace[$level] ) ) {
1484 return wfFormatStackFrame( $backtrace[$level] );
1491 * Return a string consisting of callers in the stack. Useful sometimes
1492 * for profiling specific points.
1494 * @param int $limit The maximum depth of the stack frame to return, or false for the entire stack.
1497 function wfGetAllCallers( $limit = 3 ) {
1498 $trace = array_reverse( wfDebugBacktrace() );
1499 if ( !$limit ||
$limit > count( $trace ) - 1 ) {
1500 $limit = count( $trace ) - 1;
1502 $trace = array_slice( $trace, -$limit - 1, $limit );
1503 return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1507 * Return a string representation of frame
1509 * @param array $frame
1512 function wfFormatStackFrame( $frame ) {
1513 if ( !isset( $frame['function'] ) ) {
1514 return 'NO_FUNCTION_GIVEN';
1516 return isset( $frame['class'] ) && isset( $frame['type'] ) ?
1517 $frame['class'] . $frame['type'] . $frame['function'] :
1521 /* Some generic result counters, pulled out of SearchEngine */
1526 * @param int $offset
1530 function wfShowingResults( $offset, $limit ) {
1531 return wfMessage( 'showingresults' )->numParams( $limit, $offset +
1 )->parse();
1535 * Whether the client accept gzip encoding
1537 * Uses the Accept-Encoding header to check if the client supports gzip encoding.
1538 * Use this when considering to send a gzip-encoded response to the client.
1540 * @param bool $force Forces another check even if we already have a cached result.
1543 function wfClientAcceptsGzip( $force = false ) {
1544 static $result = null;
1545 if ( $result === null ||
$force ) {
1547 if ( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
1548 # @todo FIXME: We may want to blacklist some broken browsers
1551 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
1552 $_SERVER['HTTP_ACCEPT_ENCODING'],
1556 if ( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
1560 wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
1569 * Escapes the given text so that it may be output using addWikiText()
1570 * without any linking, formatting, etc. making its way through. This
1571 * is achieved by substituting certain characters with HTML entities.
1572 * As required by the callers, "<nowiki>" is not used.
1574 * @param string $text Text to be escaped
1575 * @param-taint $text escapes_html
1578 function wfEscapeWikiText( $text ) {
1579 global $wgEnableMagicLinks;
1580 static $repl = null, $repl2 = null;
1581 if ( $repl === null ||
defined( 'MW_PARSER_TEST' ) ||
defined( 'MW_PHPUNIT_TEST' ) ) {
1582 // Tests depend upon being able to change $wgEnableMagicLinks, so don't cache
1583 // in those situations
1585 '"' => '"', '&' => '&', "'" => ''', '<' => '<',
1586 '=' => '=', '>' => '>', '[' => '[', ']' => ']',
1587 '{' => '{', '|' => '|', '}' => '}', ';' => ';',
1588 "\n#" => "\n#", "\r#" => "\r#",
1589 "\n*" => "\n*", "\r*" => "\r*",
1590 "\n:" => "\n:", "\r:" => "\r:",
1591 "\n " => "\n ", "\r " => "\r ",
1592 "\n\n" => "\n ", "\r\n" => " \n",
1593 "\n\r" => "\n ", "\r\r" => "\r ",
1594 "\n\t" => "\n	", "\r\t" => "\r	", // "\n\t\n" is treated like "\n\n"
1595 "\n----" => "\n----", "\r----" => "\r----",
1596 '__' => '__', '://' => '://',
1599 $magicLinks = array_keys( array_filter( $wgEnableMagicLinks ) );
1600 // We have to catch everything "\s" matches in PCRE
1601 foreach ( $magicLinks as $magic ) {
1602 $repl["$magic "] = "$magic ";
1603 $repl["$magic\t"] = "$magic	";
1604 $repl["$magic\r"] = "$magic ";
1605 $repl["$magic\n"] = "$magic ";
1606 $repl["$magic\f"] = "$magic";
1609 // And handle protocols that don't use "://"
1610 global $wgUrlProtocols;
1612 foreach ( $wgUrlProtocols as $prot ) {
1613 if ( substr( $prot, -1 ) === ':' ) {
1614 $repl2[] = preg_quote( substr( $prot, 0, -1 ), '/' );
1617 $repl2 = $repl2 ?
'/\b(' . implode( '|', $repl2 ) . '):/i' : '/^(?!)/';
1619 $text = substr( strtr( "\n$text", $repl ), 1 );
1620 $text = preg_replace( $repl2, '$1:', $text );
1625 * Sets dest to source and returns the original value of dest
1626 * If source is NULL, it just returns the value, it doesn't set the variable
1627 * If force is true, it will set the value even if source is NULL
1629 * @param mixed &$dest
1630 * @param mixed $source
1631 * @param bool $force
1634 function wfSetVar( &$dest, $source, $force = false ) {
1636 if ( !is_null( $source ) ||
$force ) {
1643 * As for wfSetVar except setting a bit
1647 * @param bool $state
1651 function wfSetBit( &$dest, $bit, $state = true ) {
1652 $temp = (bool)( $dest & $bit );
1653 if ( !is_null( $state ) ) {
1664 * A wrapper around the PHP function var_export().
1665 * Either print it or add it to the regular output ($wgOut).
1667 * @param mixed $var A PHP variable to dump.
1669 function wfVarDump( $var ) {
1671 $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
1672 if ( headers_sent() ||
!isset( $wgOut ) ||
!is_object( $wgOut ) ) {
1675 $wgOut->addHTML( $s );
1680 * Provide a simple HTTP error.
1682 * @param int|string $code
1683 * @param string $label
1684 * @param string $desc
1686 function wfHttpError( $code, $label, $desc ) {
1688 HttpStatus
::header( $code );
1691 $wgOut->sendCacheControl();
1694 MediaWiki\HeaderCallback
::warnIfHeadersSent();
1695 header( 'Content-type: text/html; charset=utf-8' );
1696 print '<!DOCTYPE html>' .
1697 '<html><head><title>' .
1698 htmlspecialchars( $label ) .
1699 '</title></head><body><h1>' .
1700 htmlspecialchars( $label ) .
1702 nl2br( htmlspecialchars( $desc ) ) .
1703 "</p></body></html>\n";
1707 * Clear away any user-level output buffers, discarding contents.
1709 * Suitable for 'starting afresh', for instance when streaming
1710 * relatively large amounts of data without buffering, or wanting to
1711 * output image files without ob_gzhandler's compression.
1713 * The optional $resetGzipEncoding parameter controls suppression of
1714 * the Content-Encoding header sent by ob_gzhandler; by default it
1715 * is left. See comments for wfClearOutputBuffers() for why it would
1718 * Note that some PHP configuration options may add output buffer
1719 * layers which cannot be removed; these are left in place.
1721 * @param bool $resetGzipEncoding
1723 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
1724 if ( $resetGzipEncoding ) {
1725 // Suppress Content-Encoding and Content-Length
1726 // headers from OutputHandler::handle.
1727 global $wgDisableOutputCompression;
1728 $wgDisableOutputCompression = true;
1730 while ( $status = ob_get_status() ) {
1731 if ( isset( $status['flags'] ) ) {
1732 $flags = PHP_OUTPUT_HANDLER_CLEANABLE | PHP_OUTPUT_HANDLER_REMOVABLE
;
1733 $deleteable = ( $status['flags'] & $flags ) === $flags;
1734 } elseif ( isset( $status['del'] ) ) {
1735 $deleteable = $status['del'];
1737 // Guess that any PHP-internal setting can't be removed.
1738 $deleteable = $status['type'] !== 0; /* PHP_OUTPUT_HANDLER_INTERNAL */
1740 if ( !$deleteable ) {
1741 // Give up, and hope the result doesn't break
1745 if ( $status['name'] === 'MediaWikiTestCase::wfResetOutputBuffersBarrier' ) {
1746 // Unit testing barrier to prevent this function from breaking PHPUnit.
1749 if ( !ob_end_clean() ) {
1750 // Could not remove output buffer handler; abort now
1751 // to avoid getting in some kind of infinite loop.
1754 if ( $resetGzipEncoding && $status['name'] == 'ob_gzhandler' ) {
1755 // Reset the 'Content-Encoding' field set by this handler
1756 // so we can start fresh.
1757 header_remove( 'Content-Encoding' );
1764 * More legible than passing a 'false' parameter to wfResetOutputBuffers():
1766 * Clear away output buffers, but keep the Content-Encoding header
1767 * produced by ob_gzhandler, if any.
1769 * This should be used for HTTP 304 responses, where you need to
1770 * preserve the Content-Encoding header of the real result, but
1771 * also need to suppress the output of ob_gzhandler to keep to spec
1772 * and avoid breaking Firefox in rare cases where the headers and
1773 * body are broken over two packets.
1775 function wfClearOutputBuffers() {
1776 wfResetOutputBuffers( false );
1780 * Converts an Accept-* header into an array mapping string values to quality
1783 * @param string $accept
1784 * @param string $def Default
1785 * @return float[] Associative array of string => float pairs
1787 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
1788 # No arg means accept anything (per HTTP spec)
1790 return [ $def => 1.0 ];
1795 $parts = explode( ',', $accept );
1797 foreach ( $parts as $part ) {
1798 # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
1799 $values = explode( ';', trim( $part ) );
1801 if ( count( $values ) == 1 ) {
1802 $prefs[$values[0]] = 1.0;
1803 } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
1804 $prefs[$values[0]] = floatval( $match[1] );
1812 * Checks if a given MIME type matches any of the keys in the given
1813 * array. Basic wildcards are accepted in the array keys.
1815 * Returns the matching MIME type (or wildcard) if a match, otherwise
1818 * @param string $type
1819 * @param array $avail
1823 function mimeTypeMatch( $type, $avail ) {
1824 if ( array_key_exists( $type, $avail ) ) {
1827 $mainType = explode( '/', $type )[0];
1828 if ( array_key_exists( "$mainType/*", $avail ) ) {
1829 return "$mainType/*";
1830 } elseif ( array_key_exists( '*/*', $avail ) ) {
1839 * Returns the 'best' match between a client's requested internet media types
1840 * and the server's list of available types. Each list should be an associative
1841 * array of type to preference (preference is a float between 0.0 and 1.0).
1842 * Wildcards in the types are acceptable.
1844 * @param array $cprefs Client's acceptable type list
1845 * @param array $sprefs Server's offered types
1848 * @todo FIXME: Doesn't handle params like 'text/plain; charset=UTF-8'
1849 * XXX: generalize to negotiate other stuff
1851 function wfNegotiateType( $cprefs, $sprefs ) {
1854 foreach ( array_keys( $sprefs ) as $type ) {
1855 $subType = explode( '/', $type )[1];
1856 if ( $subType != '*' ) {
1857 $ckey = mimeTypeMatch( $type, $cprefs );
1859 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1864 foreach ( array_keys( $cprefs ) as $type ) {
1865 $subType = explode( '/', $type )[1];
1866 if ( $subType != '*' && !array_key_exists( $type, $sprefs ) ) {
1867 $skey = mimeTypeMatch( $type, $sprefs );
1869 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1877 foreach ( array_keys( $combine ) as $type ) {
1878 if ( $combine[$type] > $bestq ) {
1880 $bestq = $combine[$type];
1888 * Reference-counted warning suppression
1890 * @deprecated since 1.26, use Wikimedia\suppressWarnings() directly
1893 function wfSuppressWarnings( $end = false ) {
1894 Wikimedia\
suppressWarnings( $end );
1898 * @deprecated since 1.26, use Wikimedia\restoreWarnings() directly
1899 * Restore error level to previous value
1901 function wfRestoreWarnings() {
1902 Wikimedia\restoreWarnings
();
1906 * Get a timestamp string in one of various formats
1908 * @param mixed $outputtype A timestamp in one of the supported formats, the
1909 * function will autodetect which format is supplied and act accordingly.
1910 * @param mixed $ts Optional timestamp to convert, default 0 for the current time
1911 * @return string|bool String / false The same date in the format specified in $outputtype or false
1913 function wfTimestamp( $outputtype = TS_UNIX
, $ts = 0 ) {
1914 $ret = MWTimestamp
::convert( $outputtype, $ts );
1915 if ( $ret === false ) {
1916 wfDebug( "wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n" );
1922 * Return a formatted timestamp, or null if input is null.
1923 * For dealing with nullable timestamp columns in the database.
1925 * @param int $outputtype
1926 * @param string|null $ts
1929 function wfTimestampOrNull( $outputtype = TS_UNIX
, $ts = null ) {
1930 if ( is_null( $ts ) ) {
1933 return wfTimestamp( $outputtype, $ts );
1938 * Convenience function; returns MediaWiki timestamp for the present time.
1942 function wfTimestampNow() {
1944 return MWTimestamp
::now( TS_MW
);
1948 * Check if the operating system is Windows
1950 * @return bool True if it's Windows, false otherwise.
1952 function wfIsWindows() {
1953 static $isWindows = null;
1954 if ( $isWindows === null ) {
1955 $isWindows = strtoupper( substr( PHP_OS
, 0, 3 ) ) === 'WIN';
1961 * Check if we are running under HHVM
1965 function wfIsHHVM() {
1966 return defined( 'HHVM_VERSION' );
1970 * Check if we are running from the commandline
1975 function wfIsCLI() {
1976 return PHP_SAPI
=== 'cli' || PHP_SAPI
=== 'phpdbg';
1980 * Tries to get the system directory for temporary files. First
1981 * $wgTmpDirectory is checked, and then the TMPDIR, TMP, and TEMP
1982 * environment variables are then checked in sequence, then
1983 * sys_get_temp_dir(), then upload_tmp_dir from php.ini.
1985 * NOTE: When possible, use instead the tmpfile() function to create
1986 * temporary files to avoid race conditions on file creation, etc.
1990 function wfTempDir() {
1991 global $wgTmpDirectory;
1993 if ( $wgTmpDirectory !== false ) {
1994 return $wgTmpDirectory;
1997 return TempFSFile
::getUsableTempDirectory();
2001 * Make directory, and make all parent directories if they don't exist
2003 * @param string $dir Full path to directory to create
2004 * @param int|null $mode Chmod value to use, default is $wgDirectoryMode
2005 * @param string|null $caller Optional caller param for debugging.
2006 * @throws MWException
2009 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2010 global $wgDirectoryMode;
2012 if ( FileBackend
::isStoragePath( $dir ) ) { // sanity
2013 throw new MWException( __FUNCTION__
. " given storage path '$dir'." );
2016 if ( !is_null( $caller ) ) {
2017 wfDebug( "$caller: called wfMkdirParents($dir)\n" );
2020 if ( strval( $dir ) === '' ||
is_dir( $dir ) ) {
2024 $dir = str_replace( [ '\\', '/' ], DIRECTORY_SEPARATOR
, $dir );
2026 if ( is_null( $mode ) ) {
2027 $mode = $wgDirectoryMode;
2030 // Turn off the normal warning, we're doing our own below
2031 Wikimedia\
suppressWarnings();
2032 $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2033 Wikimedia\restoreWarnings
();
2036 // directory may have been created on another request since we last checked
2037 if ( is_dir( $dir ) ) {
2041 // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2042 wfLogWarning( sprintf( "failed to mkdir \"%s\" mode 0%o", $dir, $mode ) );
2048 * Remove a directory and all its content.
2049 * Does not hide error.
2050 * @param string $dir
2052 function wfRecursiveRemoveDir( $dir ) {
2053 wfDebug( __FUNCTION__
. "( $dir )\n" );
2054 // taken from https://www.php.net/manual/en/function.rmdir.php#98622
2055 if ( is_dir( $dir ) ) {
2056 $objects = scandir( $dir );
2057 foreach ( $objects as $object ) {
2058 if ( $object != "." && $object != ".." ) {
2059 if ( filetype( $dir . '/' . $object ) == "dir" ) {
2060 wfRecursiveRemoveDir( $dir . '/' . $object );
2062 unlink( $dir . '/' . $object );
2072 * @param int $nr The number to format
2073 * @param int $acc The number of digits after the decimal point, default 2
2074 * @param bool $round Whether or not to round the value, default true
2077 function wfPercent( $nr, $acc = 2, $round = true ) {
2078 $ret = sprintf( "%.${acc}f", $nr );
2079 return $round ?
round( $ret, $acc ) . '%' : "$ret%";
2083 * Safety wrapper around ini_get() for boolean settings.
2084 * The values returned from ini_get() are pre-normalized for settings
2085 * set via php.ini or php_flag/php_admin_flag... but *not*
2086 * for those set via php_value/php_admin_value.
2088 * It's fairly common for people to use php_value instead of php_flag,
2089 * which can leave you with an 'off' setting giving a false positive
2090 * for code that just takes the ini_get() return value as a boolean.
2092 * To make things extra interesting, setting via php_value accepts
2093 * "true" and "yes" as true, but php.ini and php_flag consider them false. :)
2094 * Unrecognized values go false... again opposite PHP's own coercion
2095 * from string to bool.
2097 * Luckily, 'properly' set settings will always come back as '0' or '1',
2098 * so we only have to worry about them and the 'improper' settings.
2100 * I frickin' hate PHP... :P
2102 * @param string $setting
2105 function wfIniGetBool( $setting ) {
2106 return wfStringToBool( ini_get( $setting ) );
2110 * Convert string value to boolean, when the following are interpreted as true:
2114 * - Any number, except 0
2115 * All other strings are interpreted as false.
2117 * @param string $val
2121 function wfStringToBool( $val ) {
2122 $val = strtolower( $val );
2123 // 'on' and 'true' can't have whitespace around them, but '1' can.
2127 ||
preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2131 * Version of escapeshellarg() that works better on Windows.
2133 * Originally, this fixed the incorrect use of single quotes on Windows
2134 * (https://bugs.php.net/bug.php?id=26285) and the locale problems on Linux in
2135 * PHP 5.2.6+ (bug backported to earlier distro releases of PHP).
2137 * @param string|string[] ...$args strings to escape and glue together,
2138 * or a single array of strings parameter
2140 * @deprecated since 1.30 use MediaWiki\Shell\Shell::escape()
2142 function wfEscapeShellArg( ...$args ) {
2143 return Shell
::escape( ...$args );
2147 * Execute a shell command, with time and memory limits mirrored from the PHP
2148 * configuration if supported.
2150 * @param string|string[] $cmd If string, a properly shell-escaped command line,
2151 * or an array of unescaped arguments, in which case each value will be escaped
2152 * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
2153 * @param null|mixed &$retval Optional, will receive the program's exit code.
2154 * (non-zero is usually failure). If there is an error from
2155 * read, select, or proc_open(), this will be set to -1.
2156 * @param array $environ Optional environment variables which should be
2157 * added to the executed command environment.
2158 * @param array $limits Optional array with limits(filesize, memory, time, walltime)
2159 * this overwrites the global wgMaxShell* limits.
2160 * @param array $options Array of options:
2161 * - duplicateStderr: Set this to true to duplicate stderr to stdout,
2162 * including errors from limit.sh
2163 * - profileMethod: By default this function will profile based on the calling
2164 * method. Set this to a string for an alternative method to profile from
2166 * @return string Collected stdout as a string
2167 * @deprecated since 1.30 use class MediaWiki\Shell\Shell
2169 function wfShellExec( $cmd, &$retval = null, $environ = [],
2170 $limits = [], $options = []
2172 if ( Shell
::isDisabled() ) {
2174 // Backwards compatibility be upon us...
2175 return 'Unable to run external programs, proc_open() is disabled.';
2178 if ( is_array( $cmd ) ) {
2179 $cmd = Shell
::escape( $cmd );
2182 $includeStderr = isset( $options['duplicateStderr'] ) && $options['duplicateStderr'];
2183 $profileMethod = $options['profileMethod'] ??
wfGetCaller();
2186 $result = Shell
::command( [] )
2187 ->unsafeParams( (array)$cmd )
2188 ->environment( $environ )
2190 ->includeStderr( $includeStderr )
2191 ->profileMethod( $profileMethod )
2193 ->restrict( Shell
::RESTRICT_NONE
)
2195 } catch ( ProcOpenError
$ex ) {
2200 $retval = $result->getExitCode();
2202 return $result->getStdout();
2206 * Execute a shell command, returning both stdout and stderr. Convenience
2207 * function, as all the arguments to wfShellExec can become unwieldy.
2209 * @note This also includes errors from limit.sh, e.g. if $wgMaxShellFileSize is exceeded.
2210 * @param string|string[] $cmd If string, a properly shell-escaped command line,
2211 * or an array of unescaped arguments, in which case each value will be escaped
2212 * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
2213 * @param null|mixed &$retval Optional, will receive the program's exit code.
2214 * (non-zero is usually failure)
2215 * @param array $environ Optional environment variables which should be
2216 * added to the executed command environment.
2217 * @param array $limits Optional array with limits(filesize, memory, time, walltime)
2218 * this overwrites the global wgMaxShell* limits.
2219 * @return string Collected stdout and stderr as a string
2220 * @deprecated since 1.30 use class MediaWiki\Shell\Shell
2222 function wfShellExecWithStderr( $cmd, &$retval = null, $environ = [], $limits = [] ) {
2223 return wfShellExec( $cmd, $retval, $environ, $limits,
2224 [ 'duplicateStderr' => true, 'profileMethod' => wfGetCaller() ] );
2228 * Generate a shell-escaped command line string to run a MediaWiki cli script.
2229 * Note that $parameters should be a flat array and an option with an argument
2230 * should consist of two consecutive items in the array (do not use "--option value").
2232 * @deprecated since 1.31, use Shell::makeScriptCommand()
2234 * @param string $script MediaWiki cli script path
2235 * @param array $parameters Arguments and options to the script
2236 * @param array $options Associative array of options:
2237 * 'php': The path to the php executable
2238 * 'wrapper': Path to a PHP wrapper to handle the maintenance script
2241 function wfShellWikiCmd( $script, array $parameters = [], array $options = [] ) {
2243 // Give site config file a chance to run the script in a wrapper.
2244 // The caller may likely want to call wfBasename() on $script.
2245 Hooks
::run( 'wfShellWikiCmd', [ &$script, &$parameters, &$options ] );
2246 $cmd = [ $options['php'] ??
$wgPhpCli ];
2247 if ( isset( $options['wrapper'] ) ) {
2248 $cmd[] = $options['wrapper'];
2251 // Escape each parameter for shell
2252 return Shell
::escape( array_merge( $cmd, $parameters ) );
2256 * wfMerge attempts to merge differences between three texts.
2257 * Returns true for a clean merge and false for failure or a conflict.
2259 * @param string $old
2260 * @param string $mine
2261 * @param string $yours
2262 * @param string &$result
2263 * @param string|null &$mergeAttemptResult
2266 function wfMerge( $old, $mine, $yours, &$result, &$mergeAttemptResult = null ) {
2269 # This check may also protect against code injection in
2270 # case of broken installations.
2271 Wikimedia\
suppressWarnings();
2272 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
2273 Wikimedia\restoreWarnings
();
2275 if ( !$haveDiff3 ) {
2276 wfDebug( "diff3 not found\n" );
2280 # Make temporary files
2282 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2283 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
2284 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
2286 # NOTE: diff3 issues a warning to stderr if any of the files does not end with
2287 # a newline character. To avoid this, we normalize the trailing whitespace before
2288 # creating the diff.
2290 fwrite( $oldtextFile, rtrim( $old ) . "\n" );
2291 fclose( $oldtextFile );
2292 fwrite( $mytextFile, rtrim( $mine ) . "\n" );
2293 fclose( $mytextFile );
2294 fwrite( $yourtextFile, rtrim( $yours ) . "\n" );
2295 fclose( $yourtextFile );
2297 # Check for a conflict
2298 $cmd = Shell
::escape( $wgDiff3, '-a', '--overlap-only', $mytextName,
2299 $oldtextName, $yourtextName );
2300 $handle = popen( $cmd, 'r' );
2302 $mergeAttemptResult = '';
2304 $data = fread( $handle, 8192 );
2305 if ( strlen( $data ) == 0 ) {
2308 $mergeAttemptResult .= $data;
2312 $conflict = $mergeAttemptResult !== '';
2315 $cmd = Shell
::escape( $wgDiff3, '-a', '-e', '--merge', $mytextName,
2316 $oldtextName, $yourtextName );
2317 $handle = popen( $cmd, 'r' );
2320 $data = fread( $handle, 8192 );
2321 if ( strlen( $data ) == 0 ) {
2327 unlink( $mytextName );
2328 unlink( $oldtextName );
2329 unlink( $yourtextName );
2331 if ( $result === '' && $old !== '' && !$conflict ) {
2332 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
2339 * Returns unified plain-text diff of two texts.
2340 * "Useful" for machine processing of diffs.
2342 * @deprecated since 1.25, use DiffEngine/UnifiedDiffFormatter directly
2344 * @param string $before The text before the changes.
2345 * @param string $after The text after the changes.
2346 * @param string $params Command-line options for the diff command.
2347 * @return string Unified diff of $before and $after
2349 function wfDiff( $before, $after, $params = '-u' ) {
2350 if ( $before == $after ) {
2355 Wikimedia\
suppressWarnings();
2356 $haveDiff = $wgDiff && file_exists( $wgDiff );
2357 Wikimedia\restoreWarnings
();
2359 # This check may also protect against code injection in
2360 # case of broken installations.
2362 wfDebug( "diff executable not found\n" );
2363 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
2364 $format = new UnifiedDiffFormatter();
2365 return $format->format( $diffs );
2368 # Make temporary files
2370 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2371 $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
2373 fwrite( $oldtextFile, $before );
2374 fclose( $oldtextFile );
2375 fwrite( $newtextFile, $after );
2376 fclose( $newtextFile );
2378 // Get the diff of the two files
2379 $cmd = "$wgDiff " . $params . ' ' . Shell
::escape( $oldtextName, $newtextName );
2381 $h = popen( $cmd, 'r' );
2383 unlink( $oldtextName );
2384 unlink( $newtextName );
2385 throw new Exception( __METHOD__
. '(): popen() failed' );
2391 $data = fread( $h, 8192 );
2392 if ( strlen( $data ) == 0 ) {
2400 unlink( $oldtextName );
2401 unlink( $newtextName );
2403 // Kill the --- and +++ lines. They're not useful.
2404 $diff_lines = explode( "\n", $diff );
2405 if ( isset( $diff_lines[0] ) && strpos( $diff_lines[0], '---' ) === 0 ) {
2406 unset( $diff_lines[0] );
2408 if ( isset( $diff_lines[1] ) && strpos( $diff_lines[1], '+++' ) === 0 ) {
2409 unset( $diff_lines[1] );
2412 $diff = implode( "\n", $diff_lines );
2418 * Return the final portion of a pathname.
2419 * Reimplemented because PHP5's "basename()" is buggy with multibyte text.
2420 * https://bugs.php.net/bug.php?id=33898
2422 * PHP's basename() only considers '\' a pathchar on Windows and Netware.
2423 * We'll consider it so always, as we don't want '\s' in our Unix paths either.
2425 * @param string $path
2426 * @param string $suffix String to remove if present
2429 function wfBaseName( $path, $suffix = '' ) {
2430 if ( $suffix == '' ) {
2433 $encSuffix = '(?:' . preg_quote( $suffix, '#' ) . ')?';
2437 if ( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
2445 * Generate a relative path name to the given file.
2446 * May explode on non-matching case-insensitive paths,
2447 * funky symlinks, etc.
2449 * @param string $path Absolute destination path including target filename
2450 * @param string $from Absolute source path, directory only
2453 function wfRelativePath( $path, $from ) {
2454 // Normalize mixed input on Windows...
2455 $path = str_replace( '/', DIRECTORY_SEPARATOR
, $path );
2456 $from = str_replace( '/', DIRECTORY_SEPARATOR
, $from );
2458 // Trim trailing slashes -- fix for drive root
2459 $path = rtrim( $path, DIRECTORY_SEPARATOR
);
2460 $from = rtrim( $from, DIRECTORY_SEPARATOR
);
2462 $pieces = explode( DIRECTORY_SEPARATOR
, dirname( $path ) );
2463 $against = explode( DIRECTORY_SEPARATOR
, $from );
2465 if ( $pieces[0] !== $against[0] ) {
2466 // Non-matching Windows drive letters?
2467 // Return a full path.
2471 // Trim off common prefix
2472 while ( count( $pieces ) && count( $against )
2473 && $pieces[0] == $against[0] ) {
2474 array_shift( $pieces );
2475 array_shift( $against );
2478 // relative dots to bump us to the parent
2479 while ( count( $against ) ) {
2480 array_unshift( $pieces, '..' );
2481 array_shift( $against );
2484 array_push( $pieces, wfBaseName( $path ) );
2486 return implode( DIRECTORY_SEPARATOR
, $pieces );
2490 * Reset the session id
2492 * @deprecated since 1.27, use MediaWiki\Session\SessionManager instead
2495 function wfResetSessionID() {
2496 wfDeprecated( __FUNCTION__
, '1.27' );
2497 $session = SessionManager
::getGlobalSession();
2498 $delay = $session->delaySave();
2500 $session->resetId();
2502 // Make sure a session is started, since that's what the old
2503 // wfResetSessionID() did.
2504 if ( session_id() !== $session->getId() ) {
2505 wfSetupSession( $session->getId() );
2508 ScopedCallback
::consume( $delay );
2512 * Initialise php session
2514 * @deprecated since 1.27, use MediaWiki\Session\SessionManager instead.
2515 * Generally, "using" SessionManager will be calling ->getSessionById() or
2516 * ::getGlobalSession() (depending on whether you were passing $sessionId
2517 * here), then calling $session->persist().
2518 * @param bool|string $sessionId
2520 function wfSetupSession( $sessionId = false ) {
2521 wfDeprecated( __FUNCTION__
, '1.27' );
2524 session_id( $sessionId );
2527 $session = SessionManager
::getGlobalSession();
2528 $session->persist();
2530 if ( session_id() !== $session->getId() ) {
2531 session_id( $session->getId() );
2533 Wikimedia\
quietCall( 'session_start' );
2537 * Get an object from the precompiled serialized directory
2539 * @param string $name
2540 * @return mixed The variable on success, false on failure
2542 function wfGetPrecompiledData( $name ) {
2545 $file = "$IP/serialized/$name";
2546 if ( file_exists( $file ) ) {
2547 $blob = file_get_contents( $file );
2549 return unserialize( $blob );
2556 * Make a cache key for the local wiki.
2558 * @deprecated since 1.30 Call makeKey on a BagOStuff instance
2559 * @param string ...$args
2562 function wfMemcKey( ...$args ) {
2563 return ObjectCache
::getLocalClusterInstance()->makeKey( ...$args );
2567 * Make a cache key for a foreign DB.
2569 * Must match what wfMemcKey() would produce in context of the foreign wiki.
2572 * @param string $prefix
2573 * @param string ...$args
2576 function wfForeignMemcKey( $db, $prefix, ...$args ) {
2577 $keyspace = $prefix ?
"$db-$prefix" : $db;
2578 return ObjectCache
::getLocalClusterInstance()->makeKeyInternal( $keyspace, $args );
2582 * Make a cache key with database-agnostic prefix.
2584 * Doesn't have a wiki-specific namespace. Uses a generic 'global' prefix
2585 * instead. Must have a prefix as otherwise keys that use a database name
2586 * in the first segment will clash with wfMemcKey/wfForeignMemcKey.
2588 * @deprecated since 1.30 Call makeGlobalKey on a BagOStuff instance
2590 * @param string ...$args
2593 function wfGlobalCacheKey( ...$args ) {
2594 return ObjectCache
::getLocalClusterInstance()->makeGlobalKey( ...$args );
2598 * Get an ASCII string identifying this wiki
2599 * This is used as a prefix in memcached keys
2603 function wfWikiID() {
2604 global $wgDBprefix, $wgDBname;
2605 if ( $wgDBprefix ) {
2606 return "$wgDBname-$wgDBprefix";
2613 * Get a Database object.
2615 * @param int $db Index of the connection to get. May be DB_MASTER for the
2616 * master (for write queries), DB_REPLICA for potentially lagged read
2617 * queries, or an integer >= 0 for a particular server.
2619 * @param string|string[] $groups Query groups. An array of group names that this query
2620 * belongs to. May contain a single string if the query is only
2623 * @param string|bool $wiki The wiki ID, or false for the current wiki
2625 * Note: multiple calls to wfGetDB(DB_REPLICA) during the course of one request
2626 * will always return the same object, unless the underlying connection or load
2627 * balancer is manually destroyed.
2629 * Note 2: use $this->getDB() in maintenance scripts that may be invoked by
2630 * updater to ensure that a proper database is being updated.
2632 * @todo Replace calls to wfGetDB with calls to LoadBalancer::getConnection()
2633 * on an injected instance of LoadBalancer.
2635 * @return \Wikimedia\Rdbms\Database
2637 function wfGetDB( $db, $groups = [], $wiki = false ) {
2638 return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
2642 * Get a load balancer object.
2644 * @deprecated since 1.27, use MediaWikiServices::getInstance()->getDBLoadBalancer()
2645 * or MediaWikiServices::getInstance()->getDBLoadBalancerFactory() instead.
2647 * @param string|bool $wiki Wiki ID, or false for the current wiki
2648 * @return \Wikimedia\Rdbms\LoadBalancer
2650 function wfGetLB( $wiki = false ) {
2651 if ( $wiki === false ) {
2652 return MediaWikiServices
::getInstance()->getDBLoadBalancer();
2654 $factory = MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
2655 return $factory->getMainLB( $wiki );
2660 * Get the load balancer factory object
2662 * @deprecated since 1.27, use MediaWikiServices::getInstance()->getDBLoadBalancerFactory() instead.
2664 * @return \Wikimedia\Rdbms\LBFactory
2666 function wfGetLBFactory() {
2667 return MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
2672 * Shortcut for RepoGroup::singleton()->findFile()
2674 * @param string|LinkTarget $title String or LinkTarget object
2675 * @param array $options Associative array of options (see RepoGroup::findFile)
2676 * @return File|bool File, or false if the file does not exist
2678 function wfFindFile( $title, $options = [] ) {
2679 return RepoGroup
::singleton()->findFile( $title, $options );
2683 * Get an object referring to a locally registered file.
2684 * Returns a valid placeholder object if the file does not exist.
2686 * @param Title|string $title
2687 * @return LocalFile|null A File, or null if passed an invalid Title
2689 function wfLocalFile( $title ) {
2690 return RepoGroup
::singleton()->getLocalRepo()->newFile( $title );
2694 * Should low-performance queries be disabled?
2697 * @codeCoverageIgnore
2699 function wfQueriesMustScale() {
2700 global $wgMiserMode;
2702 ||
( SiteStats
::pages() > 100000
2703 && SiteStats
::edits() > 1000000
2704 && SiteStats
::users() > 10000 );
2708 * Get the path to a specified script file, respecting file
2709 * extensions; this is a wrapper around $wgScriptPath etc.
2710 * except for 'index' and 'load' which use $wgScript/$wgLoadScript
2712 * @param string $script Script filename, sans extension
2715 function wfScript( $script = 'index' ) {
2716 global $wgScriptPath, $wgScript, $wgLoadScript;
2717 if ( $script === 'index' ) {
2719 } elseif ( $script === 'load' ) {
2720 return $wgLoadScript;
2722 return "{$wgScriptPath}/{$script}.php";
2727 * Get the script URL.
2729 * @return string Script URL
2731 function wfGetScriptUrl() {
2732 if ( isset( $_SERVER['SCRIPT_NAME'] ) ) {
2733 /* as it was called, minus the query string.
2735 * Some sites use Apache rewrite rules to handle subdomains,
2736 * and have PHP set up in a weird way that causes PHP_SELF
2737 * to contain the rewritten URL instead of the one that the
2738 * outside world sees.
2740 * If in this mode, use SCRIPT_URL instead, which mod_rewrite
2741 * provides containing the "before" URL.
2743 return $_SERVER['SCRIPT_NAME'];
2745 return $_SERVER['URL'];
2750 * Convenience function converts boolean values into "true"
2751 * or "false" (string) values
2753 * @param bool $value
2756 function wfBoolToStr( $value ) {
2757 return $value ?
'true' : 'false';
2761 * Get a platform-independent path to the null file, e.g. /dev/null
2765 function wfGetNull() {
2766 return wfIsWindows() ?
'NUL' : '/dev/null';
2770 * Waits for the replica DBs to catch up to the master position
2772 * Use this when updating very large numbers of rows, as in maintenance scripts,
2773 * to avoid causing too much lag. Of course, this is a no-op if there are no replica DBs.
2775 * By default this waits on the main DB cluster of the current wiki.
2776 * If $cluster is set to "*" it will wait on all DB clusters, including
2777 * external ones. If the lag being waiting on is caused by the code that
2778 * does this check, it makes since to use $ifWritesSince, particularly if
2779 * cluster is "*", to avoid excess overhead.
2781 * Never call this function after a big DB write that is still in a transaction.
2782 * This only makes sense after the possible lag inducing changes were committed.
2784 * @param float|null $ifWritesSince Only wait if writes were done since this UNIX timestamp
2785 * @param string|bool $wiki Wiki identifier accepted by wfGetLB
2786 * @param string|bool $cluster Cluster name accepted by LBFactory. Default: false.
2787 * @param int|null $timeout Max wait time. Default: 60 seconds (cli), 1 second (web)
2788 * @return bool Success (able to connect and no timeouts reached)
2789 * @deprecated since 1.27 Use LBFactory::waitForReplication
2791 function wfWaitForSlaves(
2792 $ifWritesSince = null, $wiki = false, $cluster = false, $timeout = null
2794 $lbFactory = MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
2796 if ( $cluster === '*' ) {
2799 } elseif ( $wiki === false ) {
2800 $domain = $lbFactory->getLocalDomainID();
2806 'domain' => $domain,
2807 'cluster' => $cluster,
2808 // B/C: first argument used to be "max seconds of lag"; ignore such values
2809 'ifWritesSince' => ( $ifWritesSince > 1e9
) ?
$ifWritesSince : null
2811 if ( $timeout !== null ) {
2812 $opts['timeout'] = $timeout;
2815 return $lbFactory->waitForReplication( $opts );
2819 * Count down from $seconds to zero on the terminal, with a one-second pause
2820 * between showing each number. For use in command-line scripts.
2822 * @deprecated since 1.31, use Maintenance::countDown()
2824 * @codeCoverageIgnore
2825 * @param int $seconds
2827 function wfCountDown( $seconds ) {
2828 wfDeprecated( __FUNCTION__
, '1.31' );
2829 for ( $i = $seconds; $i >= 0; $i-- ) {
2830 if ( $i != $seconds ) {
2831 echo str_repeat( "\x08", strlen( $i +
1 ) );
2843 * Replace all invalid characters with '-'.
2844 * Additional characters can be defined in $wgIllegalFileChars (see T22489).
2845 * By default, $wgIllegalFileChars includes ':', '/', '\'.
2847 * @param string $name Filename to process
2850 function wfStripIllegalFilenameChars( $name ) {
2851 global $wgIllegalFileChars;
2852 $illegalFileChars = $wgIllegalFileChars ?
"|[" . $wgIllegalFileChars . "]" : '';
2853 $name = preg_replace(
2854 "/[^" . Title
::legalChars() . "]" . $illegalFileChars . "/",
2858 // $wgIllegalFileChars may not include '/' and '\', so we still need to do this
2859 $name = wfBaseName( $name );
2864 * Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit
2866 * @return int Resulting value of the memory limit.
2868 function wfMemoryLimit() {
2869 global $wgMemoryLimit;
2870 $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
2871 if ( $memlimit != -1 ) {
2872 $conflimit = wfShorthandToInteger( $wgMemoryLimit );
2873 if ( $conflimit == -1 ) {
2874 wfDebug( "Removing PHP's memory limit\n" );
2875 Wikimedia\
suppressWarnings();
2876 ini_set( 'memory_limit', $conflimit );
2877 Wikimedia\restoreWarnings
();
2879 } elseif ( $conflimit > $memlimit ) {
2880 wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
2881 Wikimedia\
suppressWarnings();
2882 ini_set( 'memory_limit', $conflimit );
2883 Wikimedia\restoreWarnings
();
2891 * Set PHP's time limit to the larger of php.ini or $wgTransactionalTimeLimit
2893 * @return int Prior time limit
2896 function wfTransactionalTimeLimit() {
2897 global $wgTransactionalTimeLimit;
2899 $timeLimit = ini_get( 'max_execution_time' );
2900 // Note that CLI scripts use 0
2901 if ( $timeLimit > 0 && $wgTransactionalTimeLimit > $timeLimit ) {
2902 set_time_limit( $wgTransactionalTimeLimit );
2905 ignore_user_abort( true ); // ignore client disconnects
2911 * Converts shorthand byte notation to integer form
2913 * @param string $string
2914 * @param int $default Returned if $string is empty
2917 function wfShorthandToInteger( $string = '', $default = -1 ) {
2918 $string = trim( $string );
2919 if ( $string === '' ) {
2922 $last = $string[strlen( $string ) - 1];
2923 $val = intval( $string );
2928 // break intentionally missing
2932 // break intentionally missing
2942 * Get the normalised IETF language tag
2943 * See unit test for examples.
2944 * See mediawiki.language.bcp47 for the JavaScript implementation.
2946 * @deprecated since 1.31, use LanguageCode::bcp47() directly.
2948 * @param string $code The language code.
2949 * @return string The language code which complying with BCP 47 standards.
2951 function wfBCP47( $code ) {
2952 wfDeprecated( __METHOD__
, '1.31' );
2953 return LanguageCode
::bcp47( $code );
2957 * Get a specific cache object.
2959 * @deprecated since 1.32, use ObjectCache::getInstance() instead
2960 * @param int|string $cacheType A CACHE_* constants, or other key in $wgObjectCaches
2963 function wfGetCache( $cacheType ) {
2964 return ObjectCache
::getInstance( $cacheType );
2968 * Get the main cache object
2970 * @deprecated since 1.32, use ObjectCache::getLocalClusterInstance() instead
2973 function wfGetMainCache() {
2974 return ObjectCache
::getLocalClusterInstance();
2978 * Get the cache object used by the message cache
2982 function wfGetMessageCacheStorage() {
2983 global $wgMessageCacheType;
2984 return ObjectCache
::getInstance( $wgMessageCacheType );
2988 * Wrapper around php's unpack.
2990 * @param string $format The format string (See php's docs)
2991 * @param string $data A binary string of binary data
2992 * @param int|bool $length The minimum length of $data or false. This is to
2993 * prevent reading beyond the end of $data. false to disable the check.
2995 * Also be careful when using this function to read unsigned 32 bit integer
2996 * because php might make it negative.
2998 * @throws MWException If $data not long enough, or if unpack fails
2999 * @return array Associative array of the extracted data
3001 function wfUnpack( $format, $data, $length = false ) {
3002 if ( $length !== false ) {
3003 $realLen = strlen( $data );
3004 if ( $realLen < $length ) {
3005 throw new MWException( "Tried to use wfUnpack on a "
3006 . "string of length $realLen, but needed one "
3007 . "of at least length $length."
3012 Wikimedia\
suppressWarnings();
3013 $result = unpack( $format, $data );
3014 Wikimedia\restoreWarnings
();
3016 if ( $result === false ) {
3017 // If it cannot extract the packed data.
3018 throw new MWException( "unpack could not unpack binary data" );
3024 * Determine if an image exists on the 'bad image list'.
3026 * The format of MediaWiki:Bad_image_list is as follows:
3027 * * Only list items (lines starting with "*") are considered
3028 * * The first link on a line must be a link to a bad image
3029 * * Any subsequent links on the same line are considered to be exceptions,
3030 * i.e. articles where the image may occur inline.
3032 * @param string $name The image name to check
3033 * @param Title|bool $contextTitle The page on which the image occurs, if known
3034 * @param string|null $blacklist Wikitext of a file blacklist
3037 function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
3038 # Handle redirects; callers almost always hit wfFindFile() anyway,
3039 # so just use that method because it has a fast process cache.
3040 $file = wfFindFile( $name ); // get the final name
3041 $name = $file ?
$file->getTitle()->getDBkey() : $name;
3043 # Run the extension hook
3045 if ( !Hooks
::run( 'BadImage', [ $name, &$bad ] ) ) {
3049 $cache = ObjectCache
::getLocalServerInstance( 'hash' );
3050 $key = $cache->makeKey(
3051 'bad-image-list', ( $blacklist === null ) ?
'default' : md5( $blacklist )
3053 $badImages = $cache->get( $key );
3055 if ( $badImages === false ) { // cache miss
3056 if ( $blacklist === null ) {
3057 $blacklist = wfMessage( 'bad_image_list' )->inContentLanguage()->plain(); // site list
3059 # Build the list now
3061 $lines = explode( "\n", $blacklist );
3062 foreach ( $lines as $line ) {
3064 if ( substr( $line, 0, 1 ) !== '*' ) {
3070 if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
3075 $imageDBkey = false;
3076 foreach ( $m[1] as $i => $titleText ) {
3077 $title = Title
::newFromText( $titleText );
3078 if ( !is_null( $title ) ) {
3080 $imageDBkey = $title->getDBkey();
3082 $exceptions[$title->getPrefixedDBkey()] = true;
3087 if ( $imageDBkey !== false ) {
3088 $badImages[$imageDBkey] = $exceptions;
3091 $cache->set( $key, $badImages, 60 );
3094 $contextKey = $contextTitle ?
$contextTitle->getPrefixedDBkey() : false;
3095 $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
3101 * Determine whether the client at a given source IP is likely to be able to
3102 * access the wiki via HTTPS.
3104 * @param string $ip The IPv4/6 address in the normal human-readable form
3107 function wfCanIPUseHTTPS( $ip ) {
3109 Hooks
::run( 'CanIPUseHTTPS', [ $ip, &$canDo ] );
3110 return (bool)$canDo;
3114 * Determine input string is represents as infinity
3116 * @param string $str The string to determine
3120 function wfIsInfinity( $str ) {
3121 // These are hardcoded elsewhere in MediaWiki (e.g. mediawiki.special.block.js).
3122 $infinityValues = [ 'infinite', 'indefinite', 'infinity', 'never' ];
3123 return in_array( $str, $infinityValues );
3127 * Returns true if these thumbnail parameters match one that MediaWiki
3128 * requests from file description pages and/or parser output.
3130 * $params is considered non-standard if they involve a non-standard
3131 * width or any non-default parameters aside from width and page number.
3132 * The number of possible files with standard parameters is far less than
3133 * that of all combinations; rate-limiting for them can thus be more generious.
3136 * @param array $params
3138 * @since 1.24 Moved from thumb.php to GlobalFunctions in 1.25
3140 function wfThumbIsStandard( File
$file, array $params ) {
3141 global $wgThumbLimits, $wgImageLimits, $wgResponsiveImages;
3143 $multipliers = [ 1 ];
3144 if ( $wgResponsiveImages ) {
3145 // These available sizes are hardcoded currently elsewhere in MediaWiki.
3146 // @see Linker::processResponsiveImages
3147 $multipliers[] = 1.5;
3151 $handler = $file->getHandler();
3152 if ( !$handler ||
!isset( $params['width'] ) ) {
3157 if ( isset( $params['page'] ) ) {
3158 $basicParams['page'] = $params['page'];
3163 // Expand limits to account for multipliers
3164 foreach ( $multipliers as $multiplier ) {
3165 $thumbLimits = array_merge( $thumbLimits, array_map(
3166 function ( $width ) use ( $multiplier ) {
3167 return round( $width * $multiplier );
3170 $imageLimits = array_merge( $imageLimits, array_map(
3171 function ( $pair ) use ( $multiplier ) {
3173 round( $pair[0] * $multiplier ),
3174 round( $pair[1] * $multiplier ),
3180 // Check if the width matches one of $wgThumbLimits
3181 if ( in_array( $params['width'], $thumbLimits ) ) {
3182 $normalParams = $basicParams +
[ 'width' => $params['width'] ];
3183 // Append any default values to the map (e.g. "lossy", "lossless", ...)
3184 $handler->normaliseParams( $file, $normalParams );
3186 // If not, then check if the width matchs one of $wgImageLimits
3188 foreach ( $imageLimits as $pair ) {
3189 $normalParams = $basicParams +
[ 'width' => $pair[0], 'height' => $pair[1] ];
3190 // Decide whether the thumbnail should be scaled on width or height.
3191 // Also append any default values to the map (e.g. "lossy", "lossless", ...)
3192 $handler->normaliseParams( $file, $normalParams );
3193 // Check if this standard thumbnail size maps to the given width
3194 if ( $normalParams['width'] == $params['width'] ) {
3200 return false; // not standard for description pages
3204 // Check that the given values for non-page, non-width, params are just defaults
3205 foreach ( $params as $key => $value ) {
3206 if ( !isset( $normalParams[$key] ) ||
$normalParams[$key] != $value ) {
3215 * Merges two (possibly) 2 dimensional arrays into the target array ($baseArray).
3217 * Values that exist in both values will be combined with += (all values of the array
3218 * of $newValues will be added to the values of the array of $baseArray, while values,
3219 * that exists in both, the value of $baseArray will be used).
3221 * @param array $baseArray The array where you want to add the values of $newValues to
3222 * @param array $newValues An array with new values
3223 * @return array The combined array
3226 function wfArrayPlus2d( array $baseArray, array $newValues ) {
3227 // First merge items that are in both arrays
3228 foreach ( $baseArray as $name => &$groupVal ) {
3229 if ( isset( $newValues[$name] ) ) {
3230 $groupVal +
= $newValues[$name];
3233 // Now add items that didn't exist yet
3234 $baseArray +
= $newValues;
3240 * Get system resource usage of current request context.
3241 * Invokes the getrusage(2) system call, requesting RUSAGE_SELF if on PHP5
3242 * or RUSAGE_THREAD if on HHVM. Returns false if getrusage is not available.
3245 * @return array|bool Resource usage data or false if no data available.
3247 function wfGetRusage() {
3248 if ( !function_exists( 'getrusage' ) ) {
3250 } elseif ( defined( 'HHVM_VERSION' ) && PHP_OS
=== 'Linux' ) {
3251 return getrusage( 2 /* RUSAGE_THREAD */ );
3253 return getrusage( 0 /* RUSAGE_SELF */ );