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\WrappedString
;
34 use Wikimedia\AtEase\AtEase
;
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 * Appends to second array if $value differs from that in $default
146 * @param string|int $key
147 * @param mixed $value
148 * @param mixed $default
149 * @param array &$changed Array to alter
150 * @throws MWException
152 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
153 if ( is_null( $changed ) ) {
154 throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' );
156 if ( $default[$key] !== $value ) {
157 $changed[$key] = $value;
162 * Merge arrays in the style of getUserPermissionsErrors, with duplicate removal
164 * wfMergeErrorArrays(
177 * @param array ...$args
180 function wfMergeErrorArrays( ...$args ) {
182 foreach ( $args as $errors ) {
183 foreach ( $errors as $params ) {
184 $originalParams = $params;
185 if ( $params[0] instanceof MessageSpecifier
) {
187 $params = array_merge( [ $msg->getKey() ], $msg->getParams() );
189 # @todo FIXME: Sometimes get nested arrays for $params,
190 # which leads to E_NOTICEs
191 $spec = implode( "\t", $params );
192 $out[$spec] = $originalParams;
195 return array_values( $out );
199 * Insert array into another array after the specified *KEY*
201 * @param array $array The array.
202 * @param array $insert The array to insert.
203 * @param mixed $after The key to insert after. Callers need to make sure the key is set.
206 function wfArrayInsertAfter( array $array, array $insert, $after ) {
207 // Find the offset of the element to insert after.
208 $keys = array_keys( $array );
209 $offsetByKey = array_flip( $keys );
211 $offset = $offsetByKey[$after];
213 // Insert at the specified offset
214 $before = array_slice( $array, 0, $offset +
1, true );
215 $after = array_slice( $array, $offset +
1, count( $array ) - $offset, true );
217 $output = $before +
$insert +
$after;
223 * Recursively converts the parameter (an object) to an array with the same data
225 * @param object|array $objOrArray
226 * @param bool $recursive
229 function wfObjectToArray( $objOrArray, $recursive = true ) {
231 if ( is_object( $objOrArray ) ) {
232 $objOrArray = get_object_vars( $objOrArray );
234 foreach ( $objOrArray as $key => $value ) {
235 if ( $recursive && ( is_object( $value ) ||
is_array( $value ) ) ) {
236 $value = wfObjectToArray( $value );
239 $array[$key] = $value;
246 * Get a random decimal value in the domain of [0, 1), in a way
247 * not likely to give duplicate values for any realistic
248 * number of articles.
250 * @note This is designed for use in relation to Special:RandomPage
251 * and the page_random database field.
255 function wfRandom() {
256 // The maximum random value is "only" 2^31-1, so get two random
257 // values to reduce the chance of dupes
258 $max = mt_getrandmax() +
1;
259 $rand = number_format( ( mt_rand() * $max +
mt_rand() ) / $max / $max, 12, '.', '' );
264 * Get a random string containing a number of pseudo-random hex characters.
266 * @note This is not secure, if you are trying to generate some sort
267 * of token please use MWCryptRand instead.
269 * @param int $length The length of the string to generate
273 function wfRandomString( $length = 32 ) {
275 for ( $n = 0; $n < $length; $n +
= 7 ) {
276 $str .= sprintf( '%07x', mt_rand() & 0xfffffff );
278 return substr( $str, 0, $length );
282 * We want some things to be included as literal characters in our title URLs
283 * for prettiness, which urlencode encodes by default. According to RFC 1738,
284 * all of the following should be safe:
288 * RFC 1738 says ~ is unsafe, however RFC 3986 considers it an unreserved
289 * character which should not be encoded. More importantly, google chrome
290 * always converts %7E back to ~, and converting it in this function can
291 * cause a redirect loop (T105265).
293 * But + is not safe because it's used to indicate a space; &= are only safe in
294 * paths and not in queries (and we don't distinguish here); ' seems kind of
295 * scary; and urlencode() doesn't touch -_. to begin with. Plus, although /
296 * is reserved, we don't care. So the list we unescape is:
300 * However, IIS7 redirects fail when the url contains a colon (see T24709),
301 * so no fancy : for IIS7.
303 * %2F in the page titles seems to fatally break for some reason.
308 function wfUrlencode( $s ) {
311 if ( is_null( $s ) ) {
312 // Reset $needle for testing.
317 if ( is_null( $needle ) ) {
318 $needle = [ '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F', '%7E' ];
319 if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) ||
320 ( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false )
326 $s = urlencode( $s );
329 [ ';', '@', '$', '!', '*', '(', ')', ',', '/', '~', ':' ],
337 * This function takes one or two arrays as input, and returns a CGI-style string, e.g.
338 * "days=7&limit=100". Options in the first array override options in the second.
339 * Options set to null or false will not be output.
341 * @param array $array1 ( String|Array )
342 * @param array|null $array2 ( String|Array )
343 * @param string $prefix
346 function wfArrayToCgi( $array1, $array2 = null, $prefix = '' ) {
347 if ( !is_null( $array2 ) ) {
348 $array1 = $array1 +
$array2;
352 foreach ( $array1 as $key => $value ) {
353 if ( !is_null( $value ) && $value !== false ) {
357 if ( $prefix !== '' ) {
358 $key = $prefix . "[$key]";
360 if ( is_array( $value ) ) {
362 foreach ( $value as $k => $v ) {
363 $cgi .= $firstTime ?
'' : '&';
364 if ( is_array( $v ) ) {
365 $cgi .= wfArrayToCgi( $v, null, $key . "[$k]" );
367 $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v );
372 if ( is_object( $value ) ) {
373 $value = $value->__toString();
375 $cgi .= urlencode( $key ) . '=' . urlencode( $value );
383 * This is the logical opposite of wfArrayToCgi(): it accepts a query string as
384 * its argument and returns the same string in array form. This allows compatibility
385 * with legacy functions that accept raw query strings instead of nice
386 * arrays. Of course, keys and values are urldecode()d.
388 * @param string $query Query string
389 * @return string[] Array version of input
391 function wfCgiToArray( $query ) {
392 if ( isset( $query[0] ) && $query[0] == '?' ) {
393 $query = substr( $query, 1 );
395 $bits = explode( '&', $query );
397 foreach ( $bits as $bit ) {
401 if ( strpos( $bit, '=' ) === false ) {
402 // Pieces like &qwerty become 'qwerty' => '' (at least this is what php does)
406 list( $key, $value ) = explode( '=', $bit );
408 $key = urldecode( $key );
409 $value = urldecode( $value );
410 if ( strpos( $key, '[' ) !== false ) {
411 $keys = array_reverse( explode( '[', $key ) );
412 $key = array_pop( $keys );
414 foreach ( $keys as $k ) {
415 $k = substr( $k, 0, -1 );
416 $temp = [ $k => $temp ];
418 if ( isset( $ret[$key] ) ) {
419 $ret[$key] = array_merge( $ret[$key], $temp );
431 * Append a query string to an existing URL, which may or may not already
432 * have query string parameters already. If so, they will be combined.
435 * @param string|string[] $query String or associative array
438 function wfAppendQuery( $url, $query ) {
439 if ( is_array( $query ) ) {
440 $query = wfArrayToCgi( $query );
442 if ( $query != '' ) {
443 // Remove the fragment, if there is one
445 $hashPos = strpos( $url, '#' );
446 if ( $hashPos !== false ) {
447 $fragment = substr( $url, $hashPos );
448 $url = substr( $url, 0, $hashPos );
452 if ( strpos( $url, '?' ) === false ) {
459 // Put the fragment back
460 if ( $fragment !== false ) {
468 * Expand a potentially local URL to a fully-qualified URL. Assumes $wgServer
471 * The meaning of the PROTO_* constants is as follows:
472 * PROTO_HTTP: Output a URL starting with http://
473 * PROTO_HTTPS: Output a URL starting with https://
474 * PROTO_RELATIVE: Output a URL starting with // (protocol-relative URL)
475 * PROTO_CURRENT: Output a URL starting with either http:// or https:// , depending
476 * on which protocol was used for the current incoming request
477 * PROTO_CANONICAL: For URLs without a domain, like /w/index.php , use $wgCanonicalServer.
478 * For protocol-relative URLs, use the protocol of $wgCanonicalServer
479 * PROTO_INTERNAL: Like PROTO_CANONICAL, but uses $wgInternalServer instead of $wgCanonicalServer
481 * @todo this won't work with current-path-relative URLs
482 * like "subdir/foo.html", etc.
484 * @param string $url Either fully-qualified or a local path + query
485 * @param string|int|null $defaultProto One of the PROTO_* constants. Determines the
486 * protocol to use if $url or $wgServer is protocol-relative
487 * @return string|false Fully-qualified URL, current-path-relative URL or false if
488 * no valid URL can be constructed
490 function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT
) {
491 global $wgServer, $wgCanonicalServer, $wgInternalServer, $wgRequest,
493 if ( $defaultProto === PROTO_CANONICAL
) {
494 $serverUrl = $wgCanonicalServer;
495 } elseif ( $defaultProto === PROTO_INTERNAL
&& $wgInternalServer !== false ) {
496 // Make $wgInternalServer fall back to $wgServer if not set
497 $serverUrl = $wgInternalServer;
499 $serverUrl = $wgServer;
500 if ( $defaultProto === PROTO_CURRENT
) {
501 $defaultProto = $wgRequest->getProtocol() . '://';
505 // Analyze $serverUrl to obtain its protocol
506 $bits = wfParseUrl( $serverUrl );
507 $serverHasProto = $bits && $bits['scheme'] != '';
509 if ( $defaultProto === PROTO_CANONICAL ||
$defaultProto === PROTO_INTERNAL
) {
510 if ( $serverHasProto ) {
511 $defaultProto = $bits['scheme'] . '://';
513 // $wgCanonicalServer or $wgInternalServer doesn't have a protocol.
514 // This really isn't supposed to happen. Fall back to HTTP in this
516 $defaultProto = PROTO_HTTP
;
520 $defaultProtoWithoutSlashes = substr( $defaultProto, 0, -2 );
522 if ( substr( $url, 0, 2 ) == '//' ) {
523 $url = $defaultProtoWithoutSlashes . $url;
524 } elseif ( substr( $url, 0, 1 ) == '/' ) {
525 // If $serverUrl is protocol-relative, prepend $defaultProtoWithoutSlashes,
526 // otherwise leave it alone.
527 if ( $serverHasProto ) {
528 $url = $serverUrl . $url;
530 // If an HTTPS URL is synthesized from a protocol-relative $wgServer, allow the
531 // user to override the port number (T67184)
532 if ( $defaultProto === PROTO_HTTPS
&& $wgHttpsPort != 443 ) {
533 if ( isset( $bits['port'] ) ) {
534 throw new Exception( 'A protocol-relative $wgServer may not contain a port number' );
536 $url = $defaultProtoWithoutSlashes . $serverUrl . ':' . $wgHttpsPort . $url;
538 $url = $defaultProtoWithoutSlashes . $serverUrl . $url;
543 $bits = wfParseUrl( $url );
545 if ( $bits && isset( $bits['path'] ) ) {
546 $bits['path'] = wfRemoveDotSegments( $bits['path'] );
547 return wfAssembleUrl( $bits );
551 } elseif ( substr( $url, 0, 1 ) != '/' ) {
552 # URL is a relative path
553 return wfRemoveDotSegments( $url );
556 # Expanded URL is not valid.
561 * Get the wiki's "server", i.e. the protocol and host part of the URL, with a
562 * protocol specified using a PROTO_* constant as in wfExpandUrl()
565 * @param string|int|null $proto One of the PROTO_* constants.
566 * @return string The URL
568 function wfGetServerUrl( $proto ) {
569 $url = wfExpandUrl( '/', $proto );
570 return substr( $url, 0, -1 );
574 * This function will reassemble a URL parsed with wfParseURL. This is useful
575 * if you need to edit part of a URL and put it back together.
577 * This is the basic structure used (brackets contain keys for $urlParts):
578 * [scheme][delimiter][user]:[pass]@[host]:[port][path]?[query]#[fragment]
580 * @todo Need to integrate this into wfExpandUrl (see T34168)
583 * @param array $urlParts URL parts, as output from wfParseUrl
584 * @return string URL assembled from its component parts
586 function wfAssembleUrl( $urlParts ) {
589 if ( isset( $urlParts['delimiter'] ) ) {
590 if ( isset( $urlParts['scheme'] ) ) {
591 $result .= $urlParts['scheme'];
594 $result .= $urlParts['delimiter'];
597 if ( isset( $urlParts['host'] ) ) {
598 if ( isset( $urlParts['user'] ) ) {
599 $result .= $urlParts['user'];
600 if ( isset( $urlParts['pass'] ) ) {
601 $result .= ':' . $urlParts['pass'];
606 $result .= $urlParts['host'];
608 if ( isset( $urlParts['port'] ) ) {
609 $result .= ':' . $urlParts['port'];
613 if ( isset( $urlParts['path'] ) ) {
614 $result .= $urlParts['path'];
617 if ( isset( $urlParts['query'] ) ) {
618 $result .= '?' . $urlParts['query'];
621 if ( isset( $urlParts['fragment'] ) ) {
622 $result .= '#' . $urlParts['fragment'];
629 * Remove all dot-segments in the provided URL path. For example,
630 * '/a/./b/../c/' becomes '/a/c/'. For details on the algorithm, please see
631 * RFC3986 section 5.2.4.
633 * @todo Need to integrate this into wfExpandUrl (see T34168)
637 * @param string $urlPath URL path, potentially containing dot-segments
638 * @return string URL path with all dot-segments removed
640 function wfRemoveDotSegments( $urlPath ) {
643 $inputLength = strlen( $urlPath );
645 while ( $inputOffset < $inputLength ) {
646 $prefixLengthOne = substr( $urlPath, $inputOffset, 1 );
647 $prefixLengthTwo = substr( $urlPath, $inputOffset, 2 );
648 $prefixLengthThree = substr( $urlPath, $inputOffset, 3 );
649 $prefixLengthFour = substr( $urlPath, $inputOffset, 4 );
652 if ( $prefixLengthTwo == './' ) {
653 # Step A, remove leading "./"
655 } elseif ( $prefixLengthThree == '../' ) {
656 # Step A, remove leading "../"
658 } elseif ( ( $prefixLengthTwo == '/.' ) && ( $inputOffset +
2 == $inputLength ) ) {
659 # Step B, replace leading "/.$" with "/"
661 $urlPath[$inputOffset] = '/';
662 } elseif ( $prefixLengthThree == '/./' ) {
663 # Step B, replace leading "/./" with "/"
665 } elseif ( $prefixLengthThree == '/..' && ( $inputOffset +
3 == $inputLength ) ) {
666 # Step C, replace leading "/..$" with "/" and
667 # remove last path component in output
669 $urlPath[$inputOffset] = '/';
671 } elseif ( $prefixLengthFour == '/../' ) {
672 # Step C, replace leading "/../" with "/" and
673 # remove last path component in output
676 } elseif ( ( $prefixLengthOne == '.' ) && ( $inputOffset +
1 == $inputLength ) ) {
677 # Step D, remove "^.$"
679 } elseif ( ( $prefixLengthTwo == '..' ) && ( $inputOffset +
2 == $inputLength ) ) {
680 # Step D, remove "^..$"
683 # Step E, move leading path segment to output
684 if ( $prefixLengthOne == '/' ) {
685 $slashPos = strpos( $urlPath, '/', $inputOffset +
1 );
687 $slashPos = strpos( $urlPath, '/', $inputOffset );
689 if ( $slashPos === false ) {
690 $output .= substr( $urlPath, $inputOffset );
691 $inputOffset = $inputLength;
693 $output .= substr( $urlPath, $inputOffset, $slashPos - $inputOffset );
694 $inputOffset +
= $slashPos - $inputOffset;
699 $slashPos = strrpos( $output, '/' );
700 if ( $slashPos === false ) {
703 $output = substr( $output, 0, $slashPos );
712 * Returns a regular expression of url protocols
714 * @param bool $includeProtocolRelative If false, remove '//' from the returned protocol list.
715 * DO NOT USE this directly, use wfUrlProtocolsWithoutProtRel() instead
718 function wfUrlProtocols( $includeProtocolRelative = true ) {
719 global $wgUrlProtocols;
721 // Cache return values separately based on $includeProtocolRelative
722 static $withProtRel = null, $withoutProtRel = null;
723 $cachedValue = $includeProtocolRelative ?
$withProtRel : $withoutProtRel;
724 if ( !is_null( $cachedValue ) ) {
728 // Support old-style $wgUrlProtocols strings, for backwards compatibility
729 // with LocalSettings files from 1.5
730 if ( is_array( $wgUrlProtocols ) ) {
732 foreach ( $wgUrlProtocols as $protocol ) {
733 // Filter out '//' if !$includeProtocolRelative
734 if ( $includeProtocolRelative ||
$protocol !== '//' ) {
735 $protocols[] = preg_quote( $protocol, '/' );
739 $retval = implode( '|', $protocols );
741 // Ignore $includeProtocolRelative in this case
742 // This case exists for pre-1.6 compatibility, and we can safely assume
743 // that '//' won't appear in a pre-1.6 config because protocol-relative
744 // URLs weren't supported until 1.18
745 $retval = $wgUrlProtocols;
748 // Cache return value
749 if ( $includeProtocolRelative ) {
750 $withProtRel = $retval;
752 $withoutProtRel = $retval;
758 * Like wfUrlProtocols(), but excludes '//' from the protocol list. Use this if
759 * you need a regex that matches all URL protocols but does not match protocol-
763 function wfUrlProtocolsWithoutProtRel() {
764 return wfUrlProtocols( false );
768 * parse_url() work-alike, but non-broken. Differences:
770 * 1) Does not raise warnings on bad URLs (just returns false).
771 * 2) Handles protocols that don't use :// (e.g., mailto: and news:, as well as
772 * protocol-relative URLs) correctly.
773 * 3) Adds a "delimiter" element to the array (see (2)).
774 * 4) Verifies that the protocol is on the $wgUrlProtocols whitelist.
775 * 5) Rejects some invalid URLs that parse_url doesn't, e.g. the empty string or URLs starting with
776 * a line feed character.
778 * @param string $url A URL to parse
779 * @return string[]|bool Bits of the URL in an associative array, or false on failure.
781 * - scheme: URI scheme (protocol), e.g. 'http', 'mailto'. Lowercase, always present, but can
782 * be an empty string for protocol-relative URLs.
783 * - delimiter: either '://', ':' or '//'. Always present.
784 * - host: domain name / IP. Always present, but could be an empty string, e.g. for file: URLs.
785 * - user: user name, e.g. for HTTP Basic auth URLs such as http://user:pass@example.com/
786 * Missing when there is no username.
787 * - pass: password, same as above.
788 * - path: path including the leading /. Will be missing when empty (e.g. 'http://example.com')
789 * - query: query string (as a string; see wfCgiToArray() for parsing it), can be missing.
790 * - fragment: the part after #, can be missing.
792 function wfParseUrl( $url ) {
793 global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
795 // Protocol-relative URLs are handled really badly by parse_url(). It's so
796 // bad that the easiest way to handle them is to just prepend 'http:' and
797 // strip the protocol out later.
798 $wasRelative = substr( $url, 0, 2 ) == '//';
799 if ( $wasRelative ) {
802 AtEase
::suppressWarnings();
803 $bits = parse_url( $url );
804 AtEase
::restoreWarnings();
805 // parse_url() returns an array without scheme for some invalid URLs, e.g.
806 // parse_url("%0Ahttp://example.com") == [ 'host' => '%0Ahttp', 'path' => 'example.com' ]
807 if ( !$bits ||
!isset( $bits['scheme'] ) ) {
811 // parse_url() incorrectly handles schemes case-sensitively. Convert it to lowercase.
812 $bits['scheme'] = strtolower( $bits['scheme'] );
814 // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
815 if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
816 $bits['delimiter'] = '://';
817 } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
818 $bits['delimiter'] = ':';
819 // parse_url detects for news: and mailto: the host part of an url as path
820 // We have to correct this wrong detection
821 if ( isset( $bits['path'] ) ) {
822 $bits['host'] = $bits['path'];
829 /* Provide an empty host for eg. file:/// urls (see T30627) */
830 if ( !isset( $bits['host'] ) ) {
834 if ( isset( $bits['path'] ) ) {
835 /* parse_url loses the third / for file:///c:/ urls (but not on variants) */
836 if ( substr( $bits['path'], 0, 1 ) !== '/' ) {
837 $bits['path'] = '/' . $bits['path'];
844 // If the URL was protocol-relative, fix scheme and delimiter
845 if ( $wasRelative ) {
846 $bits['scheme'] = '';
847 $bits['delimiter'] = '//';
853 * Take a URL, make sure it's expanded to fully qualified, and replace any
854 * encoded non-ASCII Unicode characters with their UTF-8 original forms
855 * for more compact display and legibility for local audiences.
857 * @todo handle punycode domains too
862 function wfExpandIRI( $url ) {
863 return preg_replace_callback(
864 '/((?:%[89A-F][0-9A-F])+)/i',
865 function ( array $matches ) {
866 return urldecode( $matches[1] );
873 * Check whether a given URL has a domain that occurs in a given set of domains
875 * @param array $domains Array of domains (strings)
876 * @return bool True if the host part of $url ends in one of the strings in $domains
878 function wfMatchesDomainList( $url, $domains ) {
879 $bits = wfParseUrl( $url );
880 if ( is_array( $bits ) && isset( $bits['host'] ) ) {
881 $host = '.' . $bits['host'];
882 foreach ( (array)$domains as $domain ) {
883 $domain = '.' . $domain;
884 if ( substr( $host, -strlen( $domain ) ) === $domain ) {
893 * Sends a line to the debug log if enabled or, optionally, to a comment in output.
894 * In normal operation this is a NOP.
896 * Controlling globals:
897 * $wgDebugLogFile - points to the log file
898 * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
899 * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
901 * @since 1.25 support for additional context data
903 * @param string $text
904 * @param string|bool $dest Destination of the message:
905 * - 'all': both to the log and HTML (debug toolbar or HTML comments)
906 * - 'private': excluded from HTML output
907 * For backward compatibility, it can also take a boolean:
908 * - true: same as 'all'
909 * - false: same as 'private'
910 * @param array $context Additional logging context data
912 function wfDebug( $text, $dest = 'all', array $context = [] ) {
913 global $wgDebugRawPage, $wgDebugLogPrefix;
914 global $wgDebugTimestamps;
916 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
920 $text = trim( $text );
922 if ( $wgDebugTimestamps ) {
923 $context['seconds_elapsed'] = sprintf(
925 microtime( true ) - $_SERVER['REQUEST_TIME_FLOAT']
927 $context['memory_used'] = sprintf(
929 ( memory_get_usage( true ) / ( 1024 * 1024 ) )
933 if ( $wgDebugLogPrefix !== '' ) {
934 $context['prefix'] = $wgDebugLogPrefix;
936 $context['private'] = ( $dest === false ||
$dest === 'private' );
938 $logger = LoggerFactory
::getInstance( 'wfDebug' );
939 $logger->debug( $text, $context );
943 * Returns true if debug logging should be suppressed if $wgDebugRawPage = false
946 function wfIsDebugRawPage() {
948 if ( $cache !== null ) {
951 // Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
952 // phpcs:ignore MediaWiki.Usage.SuperGlobalsUsage.SuperGlobals
953 if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
955 isset( $_SERVER['SCRIPT_NAME'] )
956 && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
967 * Send a line giving PHP memory usage.
969 * @param bool $exact Print exact byte values instead of kibibytes (default: false)
971 function wfDebugMem( $exact = false ) {
972 $mem = memory_get_usage();
974 $mem = floor( $mem / 1024 ) . ' KiB';
978 wfDebug( "Memory usage: $mem\n" );
982 * Send a line to a supplementary debug log file, if configured, or main debug
985 * To configure a supplementary log file, set $wgDebugLogGroups[$logGroup] to
986 * a string filename or an associative array mapping 'destination' to the
987 * desired filename. The associative array may also contain a 'sample' key
988 * with an integer value, specifying a sampling factor. Sampled log events
989 * will be emitted with a 1 in N random chance.
991 * @since 1.23 support for sampling log messages via $wgDebugLogGroups.
992 * @since 1.25 support for additional context data
993 * @since 1.25 sample behavior dependent on configured $wgMWLoggerDefaultSpi
995 * @param string $logGroup
996 * @param string $text
997 * @param string|bool $dest Destination of the message:
998 * - 'all': both to the log and HTML (debug toolbar or HTML comments)
999 * - 'private': only to the specific log if set in $wgDebugLogGroups and
1000 * discarded otherwise
1001 * For backward compatibility, it can also take a boolean:
1002 * - true: same as 'all'
1003 * - false: same as 'private'
1004 * @param array $context Additional logging context data
1006 function wfDebugLog(
1007 $logGroup, $text, $dest = 'all', array $context = []
1009 $text = trim( $text );
1011 $logger = LoggerFactory
::getInstance( $logGroup );
1012 $context['private'] = ( $dest === false ||
$dest === 'private' );
1013 $logger->info( $text, $context );
1017 * Log for database errors
1019 * @since 1.25 support for additional context data
1021 * @param string $text Database error message.
1022 * @param array $context Additional logging context data
1024 function wfLogDBError( $text, array $context = [] ) {
1025 $logger = LoggerFactory
::getInstance( 'wfLogDBError' );
1026 $logger->error( trim( $text ), $context );
1030 * Throws a warning that $function is deprecated
1032 * @param string $function Function that is deprecated.
1033 * @param string|bool $version Version of MediaWiki that the function
1034 * was deprecated in (Added in 1.19).
1035 * @param string|bool $component Component to which the function belongs.
1036 * If false, it is assumed the function is in MediaWiki core (Added in 1.19).
1037 * @param int $callerOffset How far up the call stack is the original
1038 * caller. 2 = function that called the function that called
1039 * wfDeprecated (Added in 1.20).
1041 function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) {
1042 MWDebug
::deprecated( $function, $version, $component, $callerOffset +
1 );
1046 * Send a warning either to the debug log or in a PHP error depending on
1047 * $wgDevelopmentWarnings. To log warnings in production, use wfLogWarning() instead.
1049 * @param string $msg Message to send
1050 * @param int $callerOffset Number of items to go back in the backtrace to
1051 * find the correct caller (1 = function calling wfWarn, ...)
1052 * @param int $level PHP error level; defaults to E_USER_NOTICE;
1053 * only used when $wgDevelopmentWarnings is true
1055 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE
) {
1056 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'auto' );
1060 * Send a warning as a PHP error and the debug log. This is intended for logging
1061 * warnings in production. For logging development warnings, use WfWarn instead.
1063 * @param string $msg Message to send
1064 * @param int $callerOffset Number of items to go back in the backtrace to
1065 * find the correct caller (1 = function calling wfLogWarning, ...)
1066 * @param int $level PHP error level; defaults to E_USER_WARNING
1068 function wfLogWarning( $msg, $callerOffset = 1, $level = E_USER_WARNING
) {
1069 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'production' );
1074 * @todo Move logic to MediaWiki.php
1076 function wfLogProfilingData() {
1077 global $wgDebugLogGroups, $wgDebugRawPage;
1079 $context = RequestContext
::getMain();
1080 $request = $context->getRequest();
1082 $profiler = Profiler
::instance();
1083 $profiler->setContext( $context );
1084 $profiler->logData();
1086 // Send out any buffered statsd metrics as needed
1087 MediaWiki
::emitBufferedStatsdData(
1088 MediaWikiServices
::getInstance()->getStatsdDataFactory(),
1089 $context->getConfig()
1092 // Profiling must actually be enabled...
1093 if ( $profiler instanceof ProfilerStub
) {
1097 if ( isset( $wgDebugLogGroups['profileoutput'] )
1098 && $wgDebugLogGroups['profileoutput'] === false
1100 // Explicitly disabled
1103 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1107 $ctx = [ 'elapsed' => $request->getElapsedTime() ];
1108 if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1109 $ctx['forwarded_for'] = $_SERVER['HTTP_X_FORWARDED_FOR'];
1111 if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1112 $ctx['client_ip'] = $_SERVER['HTTP_CLIENT_IP'];
1114 if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1115 $ctx['from'] = $_SERVER['HTTP_FROM'];
1117 if ( isset( $ctx['forwarded_for'] ) ||
1118 isset( $ctx['client_ip'] ) ||
1119 isset( $ctx['from'] ) ) {
1120 $ctx['proxy'] = $_SERVER['REMOTE_ADDR'];
1123 // Don't load $wgUser at this late stage just for statistics purposes
1124 // @todo FIXME: We can detect some anons even if it is not loaded.
1125 // See User::getId()
1126 $user = $context->getUser();
1127 $ctx['anon'] = $user->isItemLoaded( 'id' ) && $user->isAnon();
1129 // Command line script uses a FauxRequest object which does not have
1130 // any knowledge about an URL and throw an exception instead.
1132 $ctx['url'] = urldecode( $request->getRequestURL() );
1133 } catch ( Exception
$ignored ) {
1137 $ctx['output'] = $profiler->getOutput();
1139 $log = LoggerFactory
::getInstance( 'profileoutput' );
1140 $log->info( "Elapsed: {elapsed}; URL: <{url}>\n{output}", $ctx );
1144 * Increment a statistics counter
1146 * @param string $key
1150 function wfIncrStats( $key, $count = 1 ) {
1151 $stats = MediaWikiServices
::getInstance()->getStatsdDataFactory();
1152 $stats->updateCount( $key, $count );
1156 * Check whether the wiki is in read-only mode.
1160 function wfReadOnly() {
1161 return MediaWikiServices
::getInstance()->getReadOnlyMode()
1166 * Check if the site is in read-only mode and return the message if so
1168 * This checks wfConfiguredReadOnlyReason() and the main load balancer
1169 * for replica DB lag. This may result in DB connection being made.
1171 * @return string|bool String when in read-only mode; false otherwise
1173 function wfReadOnlyReason() {
1174 return MediaWikiServices
::getInstance()->getReadOnlyMode()
1179 * Get the value of $wgReadOnly or the contents of $wgReadOnlyFile.
1181 * @return string|bool String when in read-only mode; false otherwise
1184 function wfConfiguredReadOnlyReason() {
1185 return MediaWikiServices
::getInstance()->getConfiguredReadOnlyMode()
1190 * Return a Language object from $langcode
1192 * @param Language|string|bool $langcode Either:
1193 * - a Language object
1194 * - code of the language to get the message for, if it is
1195 * a valid code create a language for that language, if
1196 * it is a string but not a valid code then make a basic
1198 * - a boolean: if it's false then use the global object for
1199 * the current user's language (as a fallback for the old parameter
1200 * functionality), or if it is true then use global object
1201 * for the wiki's content language.
1204 function wfGetLangObj( $langcode = false ) {
1205 # Identify which language to get or create a language object for.
1206 # Using is_object here due to Stub objects.
1207 if ( is_object( $langcode ) ) {
1208 # Great, we already have the object (hopefully)!
1212 global $wgLanguageCode;
1213 if ( $langcode === true ||
$langcode === $wgLanguageCode ) {
1214 # $langcode is the language code of the wikis content language object.
1215 # or it is a boolean and value is true
1216 return MediaWikiServices
::getInstance()->getContentLanguage();
1220 if ( $langcode === false ||
$langcode === $wgLang->getCode() ) {
1221 # $langcode is the language code of user language object.
1222 # or it was a boolean and value is false
1226 $validCodes = array_keys( Language
::fetchLanguageNames() );
1227 if ( in_array( $langcode, $validCodes ) ) {
1228 # $langcode corresponds to a valid language.
1229 return Language
::factory( $langcode );
1232 # $langcode is a string, but not a valid language code; use content language.
1233 wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1234 return MediaWikiServices
::getInstance()->getContentLanguage();
1238 * This is the function for getting translated interface messages.
1240 * @see Message class for documentation how to use them.
1241 * @see https://www.mediawiki.org/wiki/Manual:Messages_API
1243 * This function replaces all old wfMsg* functions.
1245 * @param string|string[]|MessageSpecifier $key Message key, or array of keys, or a MessageSpecifier
1246 * @param string|string[] ...$params Normal message parameters
1251 * @see Message::__construct
1253 function wfMessage( $key, ...$params ) {
1254 $message = new Message( $key );
1256 // We call Message::params() to reduce code duplication
1258 $message->params( ...$params );
1265 * This function accepts multiple message keys and returns a message instance
1266 * for the first message which is non-empty. If all messages are empty then an
1267 * instance of the first message key is returned.
1269 * @param string ...$keys Message keys
1274 * @see Message::newFallbackSequence
1276 function wfMessageFallback( ...$keys ) {
1277 return Message
::newFallbackSequence( ...$keys );
1281 * Replace message parameter keys on the given formatted output.
1283 * @param string $message
1284 * @param array $args
1288 function wfMsgReplaceArgs( $message, $args ) {
1289 # Fix windows line-endings
1290 # Some messages are split with explode("\n", $msg)
1291 $message = str_replace( "\r", '', $message );
1293 // Replace arguments
1294 if ( is_array( $args ) && $args ) {
1295 if ( is_array( $args[0] ) ) {
1296 $args = array_values( $args[0] );
1298 $replacementKeys = [];
1299 foreach ( $args as $n => $param ) {
1300 $replacementKeys['$' . ( $n +
1 )] = $param;
1302 $message = strtr( $message, $replacementKeys );
1309 * Fetch server name for use in error reporting etc.
1310 * Use real server name if available, so we know which machine
1311 * in a server farm generated the current page.
1315 function wfHostname() {
1317 if ( is_null( $host ) ) {
1318 # Hostname overriding
1319 global $wgOverrideHostname;
1320 if ( $wgOverrideHostname !== false ) {
1321 # Set static and skip any detection
1322 $host = $wgOverrideHostname;
1326 if ( function_exists( 'posix_uname' ) ) {
1327 // This function not present on Windows
1328 $uname = posix_uname();
1332 if ( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1333 $host = $uname['nodename'];
1334 } elseif ( getenv( 'COMPUTERNAME' ) ) {
1335 # Windows computer name
1336 $host = getenv( 'COMPUTERNAME' );
1338 # This may be a virtual server.
1339 $host = $_SERVER['SERVER_NAME'];
1346 * Returns a script tag that stores the amount of time it took MediaWiki to
1347 * handle the request in milliseconds as 'wgBackendResponseTime'.
1349 * If $wgShowHostnames is true, the script will also set 'wgHostname' to the
1350 * hostname of the server handling the request.
1352 * @param string|null $nonce Value from OutputPage::getCSPNonce
1353 * @return string|WrappedString HTML
1355 function wfReportTime( $nonce = null ) {
1356 global $wgShowHostnames;
1358 $elapsed = ( microtime( true ) - $_SERVER['REQUEST_TIME_FLOAT'] );
1359 // seconds to milliseconds
1360 $responseTime = round( $elapsed * 1000 );
1361 $reportVars = [ 'wgBackendResponseTime' => $responseTime ];
1362 if ( $wgShowHostnames ) {
1363 $reportVars['wgHostname'] = wfHostname();
1365 return Skin
::makeVariablesScript( $reportVars, $nonce );
1369 * Safety wrapper for debug_backtrace().
1371 * Will return an empty array if debug_backtrace is disabled, otherwise
1372 * the output from debug_backtrace() (trimmed).
1374 * @param int $limit This parameter can be used to limit the number of stack frames returned
1376 * @return array Array of backtrace information
1378 function wfDebugBacktrace( $limit = 0 ) {
1379 static $disabled = null;
1381 if ( is_null( $disabled ) ) {
1382 $disabled = !function_exists( 'debug_backtrace' );
1384 wfDebug( "debug_backtrace() is disabled\n" );
1392 return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT
, $limit +
1 ), 1 );
1394 return array_slice( debug_backtrace(), 1 );
1399 * Get a debug backtrace as a string
1401 * @param bool|null $raw If true, the return value is plain text. If false, HTML.
1402 * Defaults to $wgCommandLineMode if unset.
1404 * @since 1.25 Supports $raw parameter.
1406 function wfBacktrace( $raw = null ) {
1407 global $wgCommandLineMode;
1409 if ( $raw === null ) {
1410 $raw = $wgCommandLineMode;
1414 $frameFormat = "%s line %s calls %s()\n";
1415 $traceFormat = "%s";
1417 $frameFormat = "<li>%s line %s calls %s()</li>\n";
1418 $traceFormat = "<ul>\n%s</ul>\n";
1421 $frames = array_map( function ( $frame ) use ( $frameFormat ) {
1422 $file = !empty( $frame['file'] ) ?
basename( $frame['file'] ) : '-';
1423 $line = $frame['line'] ??
'-';
1424 $call = $frame['function'];
1425 if ( !empty( $frame['class'] ) ) {
1426 $call = $frame['class'] . $frame['type'] . $call;
1428 return sprintf( $frameFormat, $file, $line, $call );
1429 }, wfDebugBacktrace() );
1431 return sprintf( $traceFormat, implode( '', $frames ) );
1435 * Get the name of the function which called this function
1436 * wfGetCaller( 1 ) is the function with the wfGetCaller() call (ie. __FUNCTION__)
1437 * wfGetCaller( 2 ) [default] is the caller of the function running wfGetCaller()
1438 * wfGetCaller( 3 ) is the parent of that.
1443 function wfGetCaller( $level = 2 ) {
1444 $backtrace = wfDebugBacktrace( $level +
1 );
1445 if ( isset( $backtrace[$level] ) ) {
1446 return wfFormatStackFrame( $backtrace[$level] );
1453 * Return a string consisting of callers in the stack. Useful sometimes
1454 * for profiling specific points.
1456 * @param int $limit The maximum depth of the stack frame to return, or false for the entire stack.
1459 function wfGetAllCallers( $limit = 3 ) {
1460 $trace = array_reverse( wfDebugBacktrace() );
1461 if ( !$limit ||
$limit > count( $trace ) - 1 ) {
1462 $limit = count( $trace ) - 1;
1464 $trace = array_slice( $trace, -$limit - 1, $limit );
1465 return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1469 * Return a string representation of frame
1471 * @param array $frame
1474 function wfFormatStackFrame( $frame ) {
1475 if ( !isset( $frame['function'] ) ) {
1476 return 'NO_FUNCTION_GIVEN';
1478 return isset( $frame['class'] ) && isset( $frame['type'] ) ?
1479 $frame['class'] . $frame['type'] . $frame['function'] :
1483 /* Some generic result counters, pulled out of SearchEngine */
1488 * @param int $offset
1492 function wfShowingResults( $offset, $limit ) {
1493 return wfMessage( 'showingresults' )->numParams( $limit, $offset +
1 )->parse();
1497 * Whether the client accept gzip encoding
1499 * Uses the Accept-Encoding header to check if the client supports gzip encoding.
1500 * Use this when considering to send a gzip-encoded response to the client.
1502 * @param bool $force Forces another check even if we already have a cached result.
1505 function wfClientAcceptsGzip( $force = false ) {
1506 static $result = null;
1507 if ( $result === null ||
$force ) {
1509 if ( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
1510 # @todo FIXME: We may want to blacklist some broken browsers
1513 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
1514 $_SERVER['HTTP_ACCEPT_ENCODING'],
1518 if ( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
1522 wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
1531 * Escapes the given text so that it may be output using addWikiText()
1532 * without any linking, formatting, etc. making its way through. This
1533 * is achieved by substituting certain characters with HTML entities.
1534 * As required by the callers, "<nowiki>" is not used.
1536 * @param string $text Text to be escaped
1537 * @param-taint $text escapes_html
1540 function wfEscapeWikiText( $text ) {
1541 global $wgEnableMagicLinks;
1542 static $repl = null, $repl2 = null;
1543 if ( $repl === null ||
defined( 'MW_PARSER_TEST' ) ||
defined( 'MW_PHPUNIT_TEST' ) ) {
1544 // Tests depend upon being able to change $wgEnableMagicLinks, so don't cache
1545 // in those situations
1547 '"' => '"', '&' => '&', "'" => ''', '<' => '<',
1548 '=' => '=', '>' => '>', '[' => '[', ']' => ']',
1549 '{' => '{', '|' => '|', '}' => '}', ';' => ';',
1550 "\n#" => "\n#", "\r#" => "\r#",
1551 "\n*" => "\n*", "\r*" => "\r*",
1552 "\n:" => "\n:", "\r:" => "\r:",
1553 "\n " => "\n ", "\r " => "\r ",
1554 "\n\n" => "\n ", "\r\n" => " \n",
1555 "\n\r" => "\n ", "\r\r" => "\r ",
1556 "\n\t" => "\n	", "\r\t" => "\r	", // "\n\t\n" is treated like "\n\n"
1557 "\n----" => "\n----", "\r----" => "\r----",
1558 '__' => '__', '://' => '://',
1561 $magicLinks = array_keys( array_filter( $wgEnableMagicLinks ) );
1562 // We have to catch everything "\s" matches in PCRE
1563 foreach ( $magicLinks as $magic ) {
1564 $repl["$magic "] = "$magic ";
1565 $repl["$magic\t"] = "$magic	";
1566 $repl["$magic\r"] = "$magic ";
1567 $repl["$magic\n"] = "$magic ";
1568 $repl["$magic\f"] = "$magic";
1571 // And handle protocols that don't use "://"
1572 global $wgUrlProtocols;
1574 foreach ( $wgUrlProtocols as $prot ) {
1575 if ( substr( $prot, -1 ) === ':' ) {
1576 $repl2[] = preg_quote( substr( $prot, 0, -1 ), '/' );
1579 $repl2 = $repl2 ?
'/\b(' . implode( '|', $repl2 ) . '):/i' : '/^(?!)/';
1581 $text = substr( strtr( "\n$text", $repl ), 1 );
1582 $text = preg_replace( $repl2, '$1:', $text );
1587 * Sets dest to source and returns the original value of dest
1588 * If source is NULL, it just returns the value, it doesn't set the variable
1589 * If force is true, it will set the value even if source is NULL
1591 * @param mixed &$dest
1592 * @param mixed $source
1593 * @param bool $force
1596 function wfSetVar( &$dest, $source, $force = false ) {
1598 if ( !is_null( $source ) ||
$force ) {
1605 * As for wfSetVar except setting a bit
1609 * @param bool $state
1613 function wfSetBit( &$dest, $bit, $state = true ) {
1614 $temp = (bool)( $dest & $bit );
1615 if ( !is_null( $state ) ) {
1626 * A wrapper around the PHP function var_export().
1627 * Either print it or add it to the regular output ($wgOut).
1629 * @param mixed $var A PHP variable to dump.
1631 function wfVarDump( $var ) {
1633 $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
1634 if ( headers_sent() ||
!isset( $wgOut ) ||
!is_object( $wgOut ) ) {
1637 $wgOut->addHTML( $s );
1642 * Provide a simple HTTP error.
1644 * @param int|string $code
1645 * @param string $label
1646 * @param string $desc
1648 function wfHttpError( $code, $label, $desc ) {
1650 HttpStatus
::header( $code );
1653 $wgOut->sendCacheControl();
1656 MediaWiki\HeaderCallback
::warnIfHeadersSent();
1657 header( 'Content-type: text/html; charset=utf-8' );
1658 print '<!DOCTYPE html>' .
1659 '<html><head><title>' .
1660 htmlspecialchars( $label ) .
1661 '</title></head><body><h1>' .
1662 htmlspecialchars( $label ) .
1664 nl2br( htmlspecialchars( $desc ) ) .
1665 "</p></body></html>\n";
1669 * Clear away any user-level output buffers, discarding contents.
1671 * Suitable for 'starting afresh', for instance when streaming
1672 * relatively large amounts of data without buffering, or wanting to
1673 * output image files without ob_gzhandler's compression.
1675 * The optional $resetGzipEncoding parameter controls suppression of
1676 * the Content-Encoding header sent by ob_gzhandler; by default it
1677 * is left. See comments for wfClearOutputBuffers() for why it would
1680 * Note that some PHP configuration options may add output buffer
1681 * layers which cannot be removed; these are left in place.
1683 * @param bool $resetGzipEncoding
1685 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
1686 if ( $resetGzipEncoding ) {
1687 // Suppress Content-Encoding and Content-Length
1688 // headers from OutputHandler::handle.
1689 global $wgDisableOutputCompression;
1690 $wgDisableOutputCompression = true;
1692 while ( $status = ob_get_status() ) {
1693 if ( isset( $status['flags'] ) ) {
1694 $flags = PHP_OUTPUT_HANDLER_CLEANABLE | PHP_OUTPUT_HANDLER_REMOVABLE
;
1695 $deleteable = ( $status['flags'] & $flags ) === $flags;
1696 } elseif ( isset( $status['del'] ) ) {
1697 $deleteable = $status['del'];
1699 // Guess that any PHP-internal setting can't be removed.
1700 $deleteable = $status['type'] !== 0; /* PHP_OUTPUT_HANDLER_INTERNAL */
1702 if ( !$deleteable ) {
1703 // Give up, and hope the result doesn't break
1707 if ( $status['name'] === 'MediaWikiTestCase::wfResetOutputBuffersBarrier' ) {
1708 // Unit testing barrier to prevent this function from breaking PHPUnit.
1711 if ( !ob_end_clean() ) {
1712 // Could not remove output buffer handler; abort now
1713 // to avoid getting in some kind of infinite loop.
1716 if ( $resetGzipEncoding && $status['name'] == 'ob_gzhandler' ) {
1717 // Reset the 'Content-Encoding' field set by this handler
1718 // so we can start fresh.
1719 header_remove( 'Content-Encoding' );
1726 * More legible than passing a 'false' parameter to wfResetOutputBuffers():
1728 * Clear away output buffers, but keep the Content-Encoding header
1729 * produced by ob_gzhandler, if any.
1731 * This should be used for HTTP 304 responses, where you need to
1732 * preserve the Content-Encoding header of the real result, but
1733 * also need to suppress the output of ob_gzhandler to keep to spec
1734 * and avoid breaking Firefox in rare cases where the headers and
1735 * body are broken over two packets.
1737 function wfClearOutputBuffers() {
1738 wfResetOutputBuffers( false );
1742 * Converts an Accept-* header into an array mapping string values to quality
1745 * @param string $accept
1746 * @param string $def Default
1747 * @return float[] Associative array of string => float pairs
1749 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
1750 # No arg means accept anything (per HTTP spec)
1752 return [ $def => 1.0 ];
1757 $parts = explode( ',', $accept );
1759 foreach ( $parts as $part ) {
1760 # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
1761 $values = explode( ';', trim( $part ) );
1763 if ( count( $values ) == 1 ) {
1764 $prefs[$values[0]] = 1.0;
1765 } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
1766 $prefs[$values[0]] = floatval( $match[1] );
1774 * Checks if a given MIME type matches any of the keys in the given
1775 * array. Basic wildcards are accepted in the array keys.
1777 * Returns the matching MIME type (or wildcard) if a match, otherwise
1780 * @param string $type
1781 * @param array $avail
1785 function mimeTypeMatch( $type, $avail ) {
1786 if ( array_key_exists( $type, $avail ) ) {
1789 $mainType = explode( '/', $type )[0];
1790 if ( array_key_exists( "$mainType/*", $avail ) ) {
1791 return "$mainType/*";
1792 } elseif ( array_key_exists( '*/*', $avail ) ) {
1801 * Returns the 'best' match between a client's requested internet media types
1802 * and the server's list of available types. Each list should be an associative
1803 * array of type to preference (preference is a float between 0.0 and 1.0).
1804 * Wildcards in the types are acceptable.
1806 * @param array $cprefs Client's acceptable type list
1807 * @param array $sprefs Server's offered types
1810 * @todo FIXME: Doesn't handle params like 'text/plain; charset=UTF-8'
1811 * XXX: generalize to negotiate other stuff
1813 function wfNegotiateType( $cprefs, $sprefs ) {
1816 foreach ( array_keys( $sprefs ) as $type ) {
1817 $subType = explode( '/', $type )[1];
1818 if ( $subType != '*' ) {
1819 $ckey = mimeTypeMatch( $type, $cprefs );
1821 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1826 foreach ( array_keys( $cprefs ) as $type ) {
1827 $subType = explode( '/', $type )[1];
1828 if ( $subType != '*' && !array_key_exists( $type, $sprefs ) ) {
1829 $skey = mimeTypeMatch( $type, $sprefs );
1831 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1839 foreach ( array_keys( $combine ) as $type ) {
1840 if ( $combine[$type] > $bestq ) {
1842 $bestq = $combine[$type];
1850 * Get a timestamp string in one of various formats
1852 * @param mixed $outputtype A timestamp in one of the supported formats, the
1853 * function will autodetect which format is supplied and act accordingly.
1854 * @param mixed $ts Optional timestamp to convert, default 0 for the current time
1855 * @return string|bool String / false The same date in the format specified in $outputtype or false
1857 function wfTimestamp( $outputtype = TS_UNIX
, $ts = 0 ) {
1858 $ret = MWTimestamp
::convert( $outputtype, $ts );
1859 if ( $ret === false ) {
1860 wfDebug( "wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n" );
1866 * Return a formatted timestamp, or null if input is null.
1867 * For dealing with nullable timestamp columns in the database.
1869 * @param int $outputtype
1870 * @param string|null $ts
1873 function wfTimestampOrNull( $outputtype = TS_UNIX
, $ts = null ) {
1874 if ( is_null( $ts ) ) {
1877 return wfTimestamp( $outputtype, $ts );
1882 * Convenience function; returns MediaWiki timestamp for the present time.
1884 * @return string TS_MW timestamp
1886 function wfTimestampNow() {
1887 return MWTimestamp
::now( TS_MW
);
1891 * Check if the operating system is Windows
1893 * @return bool True if it's Windows, false otherwise.
1895 function wfIsWindows() {
1896 static $isWindows = null;
1897 if ( $isWindows === null ) {
1898 $isWindows = strtoupper( substr( PHP_OS
, 0, 3 ) ) === 'WIN';
1904 * Check if we are running under HHVM
1908 function wfIsHHVM() {
1909 return defined( 'HHVM_VERSION' );
1913 * Check if we are running from the commandline
1918 function wfIsCLI() {
1919 return PHP_SAPI
=== 'cli' || PHP_SAPI
=== 'phpdbg';
1923 * Tries to get the system directory for temporary files. First
1924 * $wgTmpDirectory is checked, and then the TMPDIR, TMP, and TEMP
1925 * environment variables are then checked in sequence, then
1926 * sys_get_temp_dir(), then upload_tmp_dir from php.ini.
1928 * NOTE: When possible, use instead the tmpfile() function to create
1929 * temporary files to avoid race conditions on file creation, etc.
1933 function wfTempDir() {
1934 global $wgTmpDirectory;
1936 if ( $wgTmpDirectory !== false ) {
1937 return $wgTmpDirectory;
1940 return TempFSFile
::getUsableTempDirectory();
1944 * Make directory, and make all parent directories if they don't exist
1946 * @param string $dir Full path to directory to create
1947 * @param int|null $mode Chmod value to use, default is $wgDirectoryMode
1948 * @param string|null $caller Optional caller param for debugging.
1949 * @throws MWException
1952 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
1953 global $wgDirectoryMode;
1955 if ( FileBackend
::isStoragePath( $dir ) ) { // sanity
1956 throw new MWException( __FUNCTION__
. " given storage path '$dir'." );
1959 if ( !is_null( $caller ) ) {
1960 wfDebug( "$caller: called wfMkdirParents($dir)\n" );
1963 if ( strval( $dir ) === '' ||
is_dir( $dir ) ) {
1967 $dir = str_replace( [ '\\', '/' ], DIRECTORY_SEPARATOR
, $dir );
1969 if ( is_null( $mode ) ) {
1970 $mode = $wgDirectoryMode;
1973 // Turn off the normal warning, we're doing our own below
1974 AtEase
::suppressWarnings();
1975 $ok = mkdir( $dir, $mode, true ); // PHP5 <3
1976 AtEase
::restoreWarnings();
1979 // directory may have been created on another request since we last checked
1980 if ( is_dir( $dir ) ) {
1984 // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
1985 wfLogWarning( sprintf( "failed to mkdir \"%s\" mode 0%o", $dir, $mode ) );
1991 * Remove a directory and all its content.
1992 * Does not hide error.
1993 * @param string $dir
1995 function wfRecursiveRemoveDir( $dir ) {
1996 wfDebug( __FUNCTION__
. "( $dir )\n" );
1997 // taken from https://www.php.net/manual/en/function.rmdir.php#98622
1998 if ( is_dir( $dir ) ) {
1999 $objects = scandir( $dir );
2000 foreach ( $objects as $object ) {
2001 if ( $object != "." && $object != ".." ) {
2002 if ( filetype( $dir . '/' . $object ) == "dir" ) {
2003 wfRecursiveRemoveDir( $dir . '/' . $object );
2005 unlink( $dir . '/' . $object );
2015 * @param int $nr The number to format
2016 * @param int $acc The number of digits after the decimal point, default 2
2017 * @param bool $round Whether or not to round the value, default true
2020 function wfPercent( $nr, $acc = 2, $round = true ) {
2021 $ret = sprintf( "%.${acc}f", $nr );
2022 return $round ?
round( $ret, $acc ) . '%' : "$ret%";
2026 * Safety wrapper around ini_get() for boolean settings.
2027 * The values returned from ini_get() are pre-normalized for settings
2028 * set via php.ini or php_flag/php_admin_flag... but *not*
2029 * for those set via php_value/php_admin_value.
2031 * It's fairly common for people to use php_value instead of php_flag,
2032 * which can leave you with an 'off' setting giving a false positive
2033 * for code that just takes the ini_get() return value as a boolean.
2035 * To make things extra interesting, setting via php_value accepts
2036 * "true" and "yes" as true, but php.ini and php_flag consider them false. :)
2037 * Unrecognized values go false... again opposite PHP's own coercion
2038 * from string to bool.
2040 * Luckily, 'properly' set settings will always come back as '0' or '1',
2041 * so we only have to worry about them and the 'improper' settings.
2043 * I frickin' hate PHP... :P
2045 * @param string $setting
2048 function wfIniGetBool( $setting ) {
2049 return wfStringToBool( ini_get( $setting ) );
2053 * Convert string value to boolean, when the following are interpreted as true:
2057 * - Any number, except 0
2058 * All other strings are interpreted as false.
2060 * @param string $val
2064 function wfStringToBool( $val ) {
2065 $val = strtolower( $val );
2066 // 'on' and 'true' can't have whitespace around them, but '1' can.
2070 ||
preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2074 * Version of escapeshellarg() that works better on Windows.
2076 * Originally, this fixed the incorrect use of single quotes on Windows
2077 * (https://bugs.php.net/bug.php?id=26285) and the locale problems on Linux in
2078 * PHP 5.2.6+ (bug backported to earlier distro releases of PHP).
2080 * @param string|string[] ...$args strings to escape and glue together,
2081 * or a single array of strings parameter
2083 * @deprecated since 1.30 use MediaWiki\Shell\Shell::escape()
2085 function wfEscapeShellArg( ...$args ) {
2086 return Shell
::escape( ...$args );
2090 * Execute a shell command, with time and memory limits mirrored from the PHP
2091 * configuration if supported.
2093 * @param string|string[] $cmd If string, a properly shell-escaped command line,
2094 * or an array of unescaped arguments, in which case each value will be escaped
2095 * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
2096 * @param null|mixed &$retval Optional, will receive the program's exit code.
2097 * (non-zero is usually failure). If there is an error from
2098 * read, select, or proc_open(), this will be set to -1.
2099 * @param array $environ Optional environment variables which should be
2100 * added to the executed command environment.
2101 * @param array $limits Optional array with limits(filesize, memory, time, walltime)
2102 * this overwrites the global wgMaxShell* limits.
2103 * @param array $options Array of options:
2104 * - duplicateStderr: Set this to true to duplicate stderr to stdout,
2105 * including errors from limit.sh
2106 * - profileMethod: By default this function will profile based on the calling
2107 * method. Set this to a string for an alternative method to profile from
2109 * @return string Collected stdout as a string
2110 * @deprecated since 1.30 use class MediaWiki\Shell\Shell
2112 function wfShellExec( $cmd, &$retval = null, $environ = [],
2113 $limits = [], $options = []
2115 if ( Shell
::isDisabled() ) {
2117 // Backwards compatibility be upon us...
2118 return 'Unable to run external programs, proc_open() is disabled.';
2121 if ( is_array( $cmd ) ) {
2122 $cmd = Shell
::escape( $cmd );
2125 $includeStderr = isset( $options['duplicateStderr'] ) && $options['duplicateStderr'];
2126 $profileMethod = $options['profileMethod'] ??
wfGetCaller();
2129 $result = Shell
::command( [] )
2130 ->unsafeParams( (array)$cmd )
2131 ->environment( $environ )
2133 ->includeStderr( $includeStderr )
2134 ->profileMethod( $profileMethod )
2136 ->restrict( Shell
::RESTRICT_NONE
)
2138 } catch ( ProcOpenError
$ex ) {
2143 $retval = $result->getExitCode();
2145 return $result->getStdout();
2149 * Execute a shell command, returning both stdout and stderr. Convenience
2150 * function, as all the arguments to wfShellExec can become unwieldy.
2152 * @note This also includes errors from limit.sh, e.g. if $wgMaxShellFileSize is exceeded.
2153 * @param string|string[] $cmd If string, a properly shell-escaped command line,
2154 * or an array of unescaped arguments, in which case each value will be escaped
2155 * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
2156 * @param null|mixed &$retval Optional, will receive the program's exit code.
2157 * (non-zero is usually failure)
2158 * @param array $environ Optional environment variables which should be
2159 * added to the executed command environment.
2160 * @param array $limits Optional array with limits(filesize, memory, time, walltime)
2161 * this overwrites the global wgMaxShell* limits.
2162 * @return string Collected stdout and stderr as a string
2163 * @deprecated since 1.30 use class MediaWiki\Shell\Shell
2165 function wfShellExecWithStderr( $cmd, &$retval = null, $environ = [], $limits = [] ) {
2166 return wfShellExec( $cmd, $retval, $environ, $limits,
2167 [ 'duplicateStderr' => true, 'profileMethod' => wfGetCaller() ] );
2171 * Generate a shell-escaped command line string to run a MediaWiki cli script.
2172 * Note that $parameters should be a flat array and an option with an argument
2173 * should consist of two consecutive items in the array (do not use "--option value").
2175 * @deprecated since 1.31, use Shell::makeScriptCommand()
2177 * @param string $script MediaWiki cli script path
2178 * @param array $parameters Arguments and options to the script
2179 * @param array $options Associative array of options:
2180 * 'php': The path to the php executable
2181 * 'wrapper': Path to a PHP wrapper to handle the maintenance script
2184 function wfShellWikiCmd( $script, array $parameters = [], array $options = [] ) {
2186 // Give site config file a chance to run the script in a wrapper.
2187 // The caller may likely want to call wfBasename() on $script.
2188 Hooks
::run( 'wfShellWikiCmd', [ &$script, &$parameters, &$options ] );
2189 $cmd = [ $options['php'] ??
$wgPhpCli ];
2190 if ( isset( $options['wrapper'] ) ) {
2191 $cmd[] = $options['wrapper'];
2194 // Escape each parameter for shell
2195 return Shell
::escape( array_merge( $cmd, $parameters ) );
2199 * wfMerge attempts to merge differences between three texts.
2200 * Returns true for a clean merge and false for failure or a conflict.
2202 * @param string $old
2203 * @param string $mine
2204 * @param string $yours
2205 * @param string &$result
2206 * @param string|null &$mergeAttemptResult
2209 function wfMerge( $old, $mine, $yours, &$result, &$mergeAttemptResult = null ) {
2212 # This check may also protect against code injection in
2213 # case of broken installations.
2214 AtEase
::suppressWarnings();
2215 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
2216 AtEase
::restoreWarnings();
2218 if ( !$haveDiff3 ) {
2219 wfDebug( "diff3 not found\n" );
2223 # Make temporary files
2225 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2226 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
2227 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
2229 # NOTE: diff3 issues a warning to stderr if any of the files does not end with
2230 # a newline character. To avoid this, we normalize the trailing whitespace before
2231 # creating the diff.
2233 fwrite( $oldtextFile, rtrim( $old ) . "\n" );
2234 fclose( $oldtextFile );
2235 fwrite( $mytextFile, rtrim( $mine ) . "\n" );
2236 fclose( $mytextFile );
2237 fwrite( $yourtextFile, rtrim( $yours ) . "\n" );
2238 fclose( $yourtextFile );
2240 # Check for a conflict
2241 $cmd = Shell
::escape( $wgDiff3, '-a', '--overlap-only', $mytextName,
2242 $oldtextName, $yourtextName );
2243 $handle = popen( $cmd, 'r' );
2245 $mergeAttemptResult = '';
2247 $data = fread( $handle, 8192 );
2248 if ( strlen( $data ) == 0 ) {
2251 $mergeAttemptResult .= $data;
2255 $conflict = $mergeAttemptResult !== '';
2258 $cmd = Shell
::escape( $wgDiff3, '-a', '-e', '--merge', $mytextName,
2259 $oldtextName, $yourtextName );
2260 $handle = popen( $cmd, 'r' );
2263 $data = fread( $handle, 8192 );
2264 if ( strlen( $data ) == 0 ) {
2270 unlink( $mytextName );
2271 unlink( $oldtextName );
2272 unlink( $yourtextName );
2274 if ( $result === '' && $old !== '' && !$conflict ) {
2275 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
2282 * Returns unified plain-text diff of two texts.
2283 * "Useful" for machine processing of diffs.
2285 * @deprecated since 1.25, use DiffEngine/UnifiedDiffFormatter directly
2287 * @param string $before The text before the changes.
2288 * @param string $after The text after the changes.
2289 * @param string $params Command-line options for the diff command.
2290 * @return string Unified diff of $before and $after
2292 function wfDiff( $before, $after, $params = '-u' ) {
2293 if ( $before == $after ) {
2298 AtEase
::suppressWarnings();
2299 $haveDiff = $wgDiff && file_exists( $wgDiff );
2300 AtEase
::restoreWarnings();
2302 # This check may also protect against code injection in
2303 # case of broken installations.
2305 wfDebug( "diff executable not found\n" );
2306 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
2307 $format = new UnifiedDiffFormatter();
2308 return $format->format( $diffs );
2311 # Make temporary files
2313 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2314 $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
2316 fwrite( $oldtextFile, $before );
2317 fclose( $oldtextFile );
2318 fwrite( $newtextFile, $after );
2319 fclose( $newtextFile );
2321 // Get the diff of the two files
2322 $cmd = "$wgDiff " . $params . ' ' . Shell
::escape( $oldtextName, $newtextName );
2324 $h = popen( $cmd, 'r' );
2326 unlink( $oldtextName );
2327 unlink( $newtextName );
2328 throw new Exception( __METHOD__
. '(): popen() failed' );
2334 $data = fread( $h, 8192 );
2335 if ( strlen( $data ) == 0 ) {
2343 unlink( $oldtextName );
2344 unlink( $newtextName );
2346 // Kill the --- and +++ lines. They're not useful.
2347 $diff_lines = explode( "\n", $diff );
2348 if ( isset( $diff_lines[0] ) && strpos( $diff_lines[0], '---' ) === 0 ) {
2349 unset( $diff_lines[0] );
2351 if ( isset( $diff_lines[1] ) && strpos( $diff_lines[1], '+++' ) === 0 ) {
2352 unset( $diff_lines[1] );
2355 $diff = implode( "\n", $diff_lines );
2361 * Return the final portion of a pathname.
2362 * Reimplemented because PHP5's "basename()" is buggy with multibyte text.
2363 * https://bugs.php.net/bug.php?id=33898
2365 * PHP's basename() only considers '\' a pathchar on Windows and Netware.
2366 * We'll consider it so always, as we don't want '\s' in our Unix paths either.
2368 * @param string $path
2369 * @param string $suffix String to remove if present
2372 function wfBaseName( $path, $suffix = '' ) {
2373 if ( $suffix == '' ) {
2376 $encSuffix = '(?:' . preg_quote( $suffix, '#' ) . ')?';
2380 if ( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
2388 * Generate a relative path name to the given file.
2389 * May explode on non-matching case-insensitive paths,
2390 * funky symlinks, etc.
2392 * @param string $path Absolute destination path including target filename
2393 * @param string $from Absolute source path, directory only
2396 function wfRelativePath( $path, $from ) {
2397 // Normalize mixed input on Windows...
2398 $path = str_replace( '/', DIRECTORY_SEPARATOR
, $path );
2399 $from = str_replace( '/', DIRECTORY_SEPARATOR
, $from );
2401 // Trim trailing slashes -- fix for drive root
2402 $path = rtrim( $path, DIRECTORY_SEPARATOR
);
2403 $from = rtrim( $from, DIRECTORY_SEPARATOR
);
2405 $pieces = explode( DIRECTORY_SEPARATOR
, dirname( $path ) );
2406 $against = explode( DIRECTORY_SEPARATOR
, $from );
2408 if ( $pieces[0] !== $against[0] ) {
2409 // Non-matching Windows drive letters?
2410 // Return a full path.
2414 // Trim off common prefix
2415 while ( count( $pieces ) && count( $against )
2416 && $pieces[0] == $against[0] ) {
2417 array_shift( $pieces );
2418 array_shift( $against );
2421 // relative dots to bump us to the parent
2422 while ( count( $against ) ) {
2423 array_unshift( $pieces, '..' );
2424 array_shift( $against );
2427 array_push( $pieces, wfBaseName( $path ) );
2429 return implode( DIRECTORY_SEPARATOR
, $pieces );
2433 * Initialise php session
2435 * @deprecated since 1.27, use MediaWiki\Session\SessionManager instead.
2436 * Generally, "using" SessionManager will be calling ->getSessionById() or
2437 * ::getGlobalSession() (depending on whether you were passing $sessionId
2438 * here), then calling $session->persist().
2439 * @param bool|string $sessionId
2441 function wfSetupSession( $sessionId = false ) {
2442 wfDeprecated( __FUNCTION__
, '1.27' );
2445 session_id( $sessionId );
2448 $session = SessionManager
::getGlobalSession();
2449 $session->persist();
2451 if ( session_id() !== $session->getId() ) {
2452 session_id( $session->getId() );
2454 AtEase
::quietCall( 'session_start' );
2458 * Get an object from the precompiled serialized directory
2460 * @param string $name
2461 * @return mixed The variable on success, false on failure
2463 function wfGetPrecompiledData( $name ) {
2466 $file = "$IP/serialized/$name";
2467 if ( file_exists( $file ) ) {
2468 $blob = file_get_contents( $file );
2470 return unserialize( $blob );
2477 * Make a cache key for the local wiki.
2479 * @deprecated since 1.30 Call makeKey on a BagOStuff instance
2480 * @param string ...$args
2483 function wfMemcKey( ...$args ) {
2484 return ObjectCache
::getLocalClusterInstance()->makeKey( ...$args );
2488 * Make a cache key for a foreign DB.
2490 * Must match what wfMemcKey() would produce in context of the foreign wiki.
2493 * @param string $prefix
2494 * @param string ...$args
2497 function wfForeignMemcKey( $db, $prefix, ...$args ) {
2498 $keyspace = $prefix ?
"$db-$prefix" : $db;
2499 return ObjectCache
::getLocalClusterInstance()->makeKeyInternal( $keyspace, $args );
2503 * Make a cache key with database-agnostic prefix.
2505 * Doesn't have a wiki-specific namespace. Uses a generic 'global' prefix
2506 * instead. Must have a prefix as otherwise keys that use a database name
2507 * in the first segment will clash with wfMemcKey/wfForeignMemcKey.
2509 * @deprecated since 1.30 Call makeGlobalKey on a BagOStuff instance
2511 * @param string ...$args
2514 function wfGlobalCacheKey( ...$args ) {
2515 return ObjectCache
::getLocalClusterInstance()->makeGlobalKey( ...$args );
2519 * Get an ASCII string identifying this wiki
2520 * This is used as a prefix in memcached keys
2524 function wfWikiID() {
2525 global $wgDBprefix, $wgDBname;
2526 if ( $wgDBprefix ) {
2527 return "$wgDBname-$wgDBprefix";
2534 * Get a Database object.
2536 * @param int $db Index of the connection to get. May be DB_MASTER for the
2537 * master (for write queries), DB_REPLICA for potentially lagged read
2538 * queries, or an integer >= 0 for a particular server.
2540 * @param string|string[] $groups Query groups. An array of group names that this query
2541 * belongs to. May contain a single string if the query is only
2544 * @param string|bool $wiki The wiki ID, or false for the current wiki
2546 * Note: multiple calls to wfGetDB(DB_REPLICA) during the course of one request
2547 * will always return the same object, unless the underlying connection or load
2548 * balancer is manually destroyed.
2550 * Note 2: use $this->getDB() in maintenance scripts that may be invoked by
2551 * updater to ensure that a proper database is being updated.
2553 * @todo Replace calls to wfGetDB with calls to LoadBalancer::getConnection()
2554 * on an injected instance of LoadBalancer.
2556 * @return \Wikimedia\Rdbms\Database
2558 function wfGetDB( $db, $groups = [], $wiki = false ) {
2559 return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
2563 * Get a load balancer object.
2565 * @deprecated since 1.27, use MediaWikiServices::getInstance()->getDBLoadBalancer()
2566 * or MediaWikiServices::getInstance()->getDBLoadBalancerFactory() instead.
2568 * @param string|bool $wiki Wiki ID, or false for the current wiki
2569 * @return \Wikimedia\Rdbms\LoadBalancer
2571 function wfGetLB( $wiki = false ) {
2572 if ( $wiki === false ) {
2573 return MediaWikiServices
::getInstance()->getDBLoadBalancer();
2575 $factory = MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
2576 return $factory->getMainLB( $wiki );
2582 * @deprecated since 1.34, use MediaWikiServices
2583 * @param string|LinkTarget $title String or LinkTarget object
2584 * @param array $options Associative array of options (see RepoGroup::findFile)
2585 * @return File|bool File, or false if the file does not exist
2587 function wfFindFile( $title, $options = [] ) {
2588 return MediaWikiServices
::getInstance()->getRepoGroup()->findFile( $title, $options );
2592 * Get an object referring to a locally registered file.
2593 * Returns a valid placeholder object if the file does not exist.
2595 * @deprecated since 1.34, use MediaWikiServices
2596 * @param Title|string $title
2597 * @return LocalFile|null A File, or null if passed an invalid Title
2599 function wfLocalFile( $title ) {
2600 return MediaWikiServices
::getInstance()->getRepoGroup()->getLocalRepo()->newFile( $title );
2604 * Should low-performance queries be disabled?
2607 * @codeCoverageIgnore
2609 function wfQueriesMustScale() {
2610 global $wgMiserMode;
2612 ||
( SiteStats
::pages() > 100000
2613 && SiteStats
::edits() > 1000000
2614 && SiteStats
::users() > 10000 );
2618 * Get the path to a specified script file, respecting file
2619 * extensions; this is a wrapper around $wgScriptPath etc.
2620 * except for 'index' and 'load' which use $wgScript/$wgLoadScript
2622 * @param string $script Script filename, sans extension
2625 function wfScript( $script = 'index' ) {
2626 global $wgScriptPath, $wgScript, $wgLoadScript;
2627 if ( $script === 'index' ) {
2629 } elseif ( $script === 'load' ) {
2630 return $wgLoadScript;
2632 return "{$wgScriptPath}/{$script}.php";
2637 * Get the script URL.
2639 * @return string Script URL
2641 function wfGetScriptUrl() {
2642 if ( isset( $_SERVER['SCRIPT_NAME'] ) ) {
2643 /* as it was called, minus the query string.
2645 * Some sites use Apache rewrite rules to handle subdomains,
2646 * and have PHP set up in a weird way that causes PHP_SELF
2647 * to contain the rewritten URL instead of the one that the
2648 * outside world sees.
2650 * If in this mode, use SCRIPT_URL instead, which mod_rewrite
2651 * provides containing the "before" URL.
2653 return $_SERVER['SCRIPT_NAME'];
2655 return $_SERVER['URL'];
2660 * Convenience function converts boolean values into "true"
2661 * or "false" (string) values
2663 * @param bool $value
2666 function wfBoolToStr( $value ) {
2667 return $value ?
'true' : 'false';
2671 * Get a platform-independent path to the null file, e.g. /dev/null
2675 function wfGetNull() {
2676 return wfIsWindows() ?
'NUL' : '/dev/null';
2680 * Waits for the replica DBs to catch up to the master position
2682 * Use this when updating very large numbers of rows, as in maintenance scripts,
2683 * to avoid causing too much lag. Of course, this is a no-op if there are no replica DBs.
2685 * By default this waits on the main DB cluster of the current wiki.
2686 * If $cluster is set to "*" it will wait on all DB clusters, including
2687 * external ones. If the lag being waiting on is caused by the code that
2688 * does this check, it makes since to use $ifWritesSince, particularly if
2689 * cluster is "*", to avoid excess overhead.
2691 * Never call this function after a big DB write that is still in a transaction.
2692 * This only makes sense after the possible lag inducing changes were committed.
2694 * @param float|null $ifWritesSince Only wait if writes were done since this UNIX timestamp
2695 * @param string|bool $wiki Wiki identifier accepted by wfGetLB
2696 * @param string|bool $cluster Cluster name accepted by LBFactory. Default: false.
2697 * @param int|null $timeout Max wait time. Default: 60 seconds (cli), 1 second (web)
2698 * @return bool Success (able to connect and no timeouts reached)
2699 * @deprecated since 1.27 Use LBFactory::waitForReplication
2701 function wfWaitForSlaves(
2702 $ifWritesSince = null, $wiki = false, $cluster = false, $timeout = null
2704 $lbFactory = MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
2706 if ( $cluster === '*' ) {
2709 } elseif ( $wiki === false ) {
2710 $domain = $lbFactory->getLocalDomainID();
2716 'domain' => $domain,
2717 'cluster' => $cluster,
2718 // B/C: first argument used to be "max seconds of lag"; ignore such values
2719 'ifWritesSince' => ( $ifWritesSince > 1e9
) ?
$ifWritesSince : null
2721 if ( $timeout !== null ) {
2722 $opts['timeout'] = $timeout;
2725 return $lbFactory->waitForReplication( $opts );
2729 * Replace all invalid characters with '-'.
2730 * Additional characters can be defined in $wgIllegalFileChars (see T22489).
2731 * By default, $wgIllegalFileChars includes ':', '/', '\'.
2733 * @param string $name Filename to process
2736 function wfStripIllegalFilenameChars( $name ) {
2737 global $wgIllegalFileChars;
2738 $illegalFileChars = $wgIllegalFileChars ?
"|[" . $wgIllegalFileChars . "]" : '';
2739 $name = preg_replace(
2740 "/[^" . Title
::legalChars() . "]" . $illegalFileChars . "/",
2744 // $wgIllegalFileChars may not include '/' and '\', so we still need to do this
2745 $name = wfBaseName( $name );
2750 * Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit
2752 * @return int Resulting value of the memory limit.
2754 function wfMemoryLimit() {
2755 global $wgMemoryLimit;
2756 $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
2757 if ( $memlimit != -1 ) {
2758 $conflimit = wfShorthandToInteger( $wgMemoryLimit );
2759 if ( $conflimit == -1 ) {
2760 wfDebug( "Removing PHP's memory limit\n" );
2761 Wikimedia\
suppressWarnings();
2762 ini_set( 'memory_limit', $conflimit );
2763 Wikimedia\restoreWarnings
();
2765 } elseif ( $conflimit > $memlimit ) {
2766 wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
2767 Wikimedia\
suppressWarnings();
2768 ini_set( 'memory_limit', $conflimit );
2769 Wikimedia\restoreWarnings
();
2777 * Set PHP's time limit to the larger of php.ini or $wgTransactionalTimeLimit
2779 * @return int Prior time limit
2782 function wfTransactionalTimeLimit() {
2783 global $wgTransactionalTimeLimit;
2785 $timeLimit = ini_get( 'max_execution_time' );
2786 // Note that CLI scripts use 0
2787 if ( $timeLimit > 0 && $wgTransactionalTimeLimit > $timeLimit ) {
2788 set_time_limit( $wgTransactionalTimeLimit );
2791 ignore_user_abort( true ); // ignore client disconnects
2797 * Converts shorthand byte notation to integer form
2799 * @param string $string
2800 * @param int $default Returned if $string is empty
2803 function wfShorthandToInteger( $string = '', $default = -1 ) {
2804 $string = trim( $string );
2805 if ( $string === '' ) {
2808 $last = $string[strlen( $string ) - 1];
2809 $val = intval( $string );
2814 // break intentionally missing
2818 // break intentionally missing
2828 * Get a specific cache object.
2830 * @deprecated since 1.32, use ObjectCache::getInstance() instead
2831 * @param int|string $cacheType A CACHE_* constants, or other key in $wgObjectCaches
2834 function wfGetCache( $cacheType ) {
2835 return ObjectCache
::getInstance( $cacheType );
2839 * Get the main cache object
2841 * @deprecated since 1.32, use ObjectCache::getLocalClusterInstance() instead
2844 function wfGetMainCache() {
2845 return ObjectCache
::getLocalClusterInstance();
2849 * Get the cache object used by the message cache
2853 function wfGetMessageCacheStorage() {
2854 global $wgMessageCacheType;
2855 return ObjectCache
::getInstance( $wgMessageCacheType );
2859 * Wrapper around php's unpack.
2861 * @param string $format The format string (See php's docs)
2862 * @param string $data A binary string of binary data
2863 * @param int|bool $length The minimum length of $data or false. This is to
2864 * prevent reading beyond the end of $data. false to disable the check.
2866 * Also be careful when using this function to read unsigned 32 bit integer
2867 * because php might make it negative.
2869 * @throws MWException If $data not long enough, or if unpack fails
2870 * @return array Associative array of the extracted data
2872 function wfUnpack( $format, $data, $length = false ) {
2873 if ( $length !== false ) {
2874 $realLen = strlen( $data );
2875 if ( $realLen < $length ) {
2876 throw new MWException( "Tried to use wfUnpack on a "
2877 . "string of length $realLen, but needed one "
2878 . "of at least length $length."
2883 Wikimedia\
suppressWarnings();
2884 $result = unpack( $format, $data );
2885 Wikimedia\restoreWarnings
();
2887 if ( $result === false ) {
2888 // If it cannot extract the packed data.
2889 throw new MWException( "unpack could not unpack binary data" );
2895 * Determine if an image exists on the 'bad image list'.
2897 * The format of MediaWiki:Bad_image_list is as follows:
2898 * * Only list items (lines starting with "*") are considered
2899 * * The first link on a line must be a link to a bad image
2900 * * Any subsequent links on the same line are considered to be exceptions,
2901 * i.e. articles where the image may occur inline.
2903 * @param string $name The image name to check
2904 * @param Title|bool $contextTitle The page on which the image occurs, if known
2905 * @param string|null $blacklist Wikitext of a file blacklist
2908 function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
2909 # Handle redirects; callers almost always hit wfFindFile() anyway,
2910 # so just use that method because it has a fast process cache.
2911 $file = MediaWikiServices
::getInstance()->getRepoGroup()->findFile( $name ); // get the final name
2912 $name = $file ?
$file->getTitle()->getDBkey() : $name;
2914 # Run the extension hook
2916 if ( !Hooks
::run( 'BadImage', [ $name, &$bad ] ) ) {
2920 $cache = ObjectCache
::getLocalServerInstance( 'hash' );
2921 $key = $cache->makeKey(
2922 'bad-image-list', ( $blacklist === null ) ?
'default' : md5( $blacklist )
2924 $badImages = $cache->get( $key );
2926 if ( $badImages === false ) { // cache miss
2927 if ( $blacklist === null ) {
2928 $blacklist = wfMessage( 'bad_image_list' )->inContentLanguage()->plain(); // site list
2930 # Build the list now
2932 $lines = explode( "\n", $blacklist );
2933 foreach ( $lines as $line ) {
2935 if ( substr( $line, 0, 1 ) !== '*' ) {
2941 if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
2946 $imageDBkey = false;
2947 foreach ( $m[1] as $i => $titleText ) {
2948 $title = Title
::newFromText( $titleText );
2949 if ( !is_null( $title ) ) {
2951 $imageDBkey = $title->getDBkey();
2953 $exceptions[$title->getPrefixedDBkey()] = true;
2958 if ( $imageDBkey !== false ) {
2959 $badImages[$imageDBkey] = $exceptions;
2962 $cache->set( $key, $badImages, 60 );
2965 $contextKey = $contextTitle ?
$contextTitle->getPrefixedDBkey() : false;
2966 $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
2972 * Determine whether the client at a given source IP is likely to be able to
2973 * access the wiki via HTTPS.
2975 * @param string $ip The IPv4/6 address in the normal human-readable form
2978 function wfCanIPUseHTTPS( $ip ) {
2980 Hooks
::run( 'CanIPUseHTTPS', [ $ip, &$canDo ] );
2981 return (bool)$canDo;
2985 * Determine input string is represents as infinity
2987 * @param string $str The string to determine
2991 function wfIsInfinity( $str ) {
2992 // These are hardcoded elsewhere in MediaWiki (e.g. mediawiki.special.block.js).
2993 $infinityValues = [ 'infinite', 'indefinite', 'infinity', 'never' ];
2994 return in_array( $str, $infinityValues );
2998 * Returns true if these thumbnail parameters match one that MediaWiki
2999 * requests from file description pages and/or parser output.
3001 * $params is considered non-standard if they involve a non-standard
3002 * width or any non-default parameters aside from width and page number.
3003 * The number of possible files with standard parameters is far less than
3004 * that of all combinations; rate-limiting for them can thus be more generious.
3007 * @param array $params
3009 * @since 1.24 Moved from thumb.php to GlobalFunctions in 1.25
3011 function wfThumbIsStandard( File
$file, array $params ) {
3012 global $wgThumbLimits, $wgImageLimits, $wgResponsiveImages;
3014 $multipliers = [ 1 ];
3015 if ( $wgResponsiveImages ) {
3016 // These available sizes are hardcoded currently elsewhere in MediaWiki.
3017 // @see Linker::processResponsiveImages
3018 $multipliers[] = 1.5;
3022 $handler = $file->getHandler();
3023 if ( !$handler ||
!isset( $params['width'] ) ) {
3028 if ( isset( $params['page'] ) ) {
3029 $basicParams['page'] = $params['page'];
3034 // Expand limits to account for multipliers
3035 foreach ( $multipliers as $multiplier ) {
3036 $thumbLimits = array_merge( $thumbLimits, array_map(
3037 function ( $width ) use ( $multiplier ) {
3038 return round( $width * $multiplier );
3041 $imageLimits = array_merge( $imageLimits, array_map(
3042 function ( $pair ) use ( $multiplier ) {
3044 round( $pair[0] * $multiplier ),
3045 round( $pair[1] * $multiplier ),
3051 // Check if the width matches one of $wgThumbLimits
3052 if ( in_array( $params['width'], $thumbLimits ) ) {
3053 $normalParams = $basicParams +
[ 'width' => $params['width'] ];
3054 // Append any default values to the map (e.g. "lossy", "lossless", ...)
3055 $handler->normaliseParams( $file, $normalParams );
3057 // If not, then check if the width matchs one of $wgImageLimits
3059 foreach ( $imageLimits as $pair ) {
3060 $normalParams = $basicParams +
[ 'width' => $pair[0], 'height' => $pair[1] ];
3061 // Decide whether the thumbnail should be scaled on width or height.
3062 // Also append any default values to the map (e.g. "lossy", "lossless", ...)
3063 $handler->normaliseParams( $file, $normalParams );
3064 // Check if this standard thumbnail size maps to the given width
3065 if ( $normalParams['width'] == $params['width'] ) {
3071 return false; // not standard for description pages
3075 // Check that the given values for non-page, non-width, params are just defaults
3076 foreach ( $params as $key => $value ) {
3077 if ( !isset( $normalParams[$key] ) ||
$normalParams[$key] != $value ) {
3086 * Merges two (possibly) 2 dimensional arrays into the target array ($baseArray).
3088 * Values that exist in both values will be combined with += (all values of the array
3089 * of $newValues will be added to the values of the array of $baseArray, while values,
3090 * that exists in both, the value of $baseArray will be used).
3092 * @param array $baseArray The array where you want to add the values of $newValues to
3093 * @param array $newValues An array with new values
3094 * @return array The combined array
3097 function wfArrayPlus2d( array $baseArray, array $newValues ) {
3098 // First merge items that are in both arrays
3099 foreach ( $baseArray as $name => &$groupVal ) {
3100 if ( isset( $newValues[$name] ) ) {
3101 $groupVal +
= $newValues[$name];
3104 // Now add items that didn't exist yet
3105 $baseArray +
= $newValues;
3111 * Get system resource usage of current request context.
3112 * Invokes the getrusage(2) system call, requesting RUSAGE_SELF if on PHP5
3113 * or RUSAGE_THREAD if on HHVM. Returns false if getrusage is not available.
3116 * @return array|bool Resource usage data or false if no data available.
3118 function wfGetRusage() {
3119 if ( !function_exists( 'getrusage' ) ) {
3121 } elseif ( defined( 'HHVM_VERSION' ) && PHP_OS
=== 'Linux' ) {
3122 return getrusage( 2 /* RUSAGE_THREAD */ );
3124 return getrusage( 0 /* RUSAGE_SELF */ );