3 * Global functions used everywhere.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 if ( !defined( 'MEDIAWIKI' ) ) {
24 die( "This file is part of MediaWiki, it is not a valid entry point" );
27 use MediaWiki\Logger\LoggerFactory
;
28 use MediaWiki\ProcOpenError
;
29 use MediaWiki\Session\SessionManager
;
30 use MediaWiki\MediaWikiServices
;
31 use MediaWiki\Shell\Shell
;
32 use Wikimedia\ScopedCallback
;
33 use Wikimedia\WrappedString
;
38 * This queues an extension to be loaded through
39 * the ExtensionRegistry system.
41 * @param string $ext Name of the extension to load
42 * @param string|null $path Absolute path of where to find the extension.json file
45 function wfLoadExtension( $ext, $path = null ) {
47 global $wgExtensionDirectory;
48 $path = "$wgExtensionDirectory/$ext/extension.json";
50 ExtensionRegistry
::getInstance()->queue( $path );
54 * Load multiple extensions at once
56 * Same as wfLoadExtension, but more efficient if you
57 * are loading multiple extensions.
59 * If you want to specify custom paths, you should interact with
60 * ExtensionRegistry directly.
62 * @see wfLoadExtension
63 * @param string[] $exts Array of extension names to load
66 function wfLoadExtensions( array $exts ) {
67 global $wgExtensionDirectory;
68 $registry = ExtensionRegistry
::getInstance();
69 foreach ( $exts as $ext ) {
70 $registry->queue( "$wgExtensionDirectory/$ext/extension.json" );
77 * @see wfLoadExtension
78 * @param string $skin Name of the extension to load
79 * @param string|null $path Absolute path of where to find the skin.json file
82 function wfLoadSkin( $skin, $path = null ) {
84 global $wgStyleDirectory;
85 $path = "$wgStyleDirectory/$skin/skin.json";
87 ExtensionRegistry
::getInstance()->queue( $path );
91 * Load multiple skins at once
93 * @see wfLoadExtensions
94 * @param string[] $skins Array of extension names to load
97 function wfLoadSkins( array $skins ) {
98 global $wgStyleDirectory;
99 $registry = ExtensionRegistry
::getInstance();
100 foreach ( $skins as $skin ) {
101 $registry->queue( "$wgStyleDirectory/$skin/skin.json" );
106 * Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
111 function wfArrayDiff2( $a, $b ) {
112 return array_udiff( $a, $b, 'wfArrayDiff2_cmp' );
116 * @param array|string $a
117 * @param array|string $b
120 function wfArrayDiff2_cmp( $a, $b ) {
121 if ( is_string( $a ) && is_string( $b ) ) {
122 return strcmp( $a, $b );
123 } elseif ( count( $a ) !== count( $b ) ) {
124 return count( $a ) <=> count( $b );
128 while ( key( $a ) !== null && key( $b ) !== null ) {
129 $valueA = current( $a );
130 $valueB = current( $b );
131 $cmp = strcmp( $valueA, $valueB );
143 * @deprecated since 1.32, use array_filter() with ARRAY_FILTER_USE_BOTH directly
146 * @param callable $callback Will be called with the array value and key (in that order) and
147 * should return a bool which will determine whether the array element is kept.
150 function wfArrayFilter( array $arr, callable
$callback ) {
151 return array_filter( $arr, $callback, ARRAY_FILTER_USE_BOTH
);
155 * @deprecated since 1.32, use array_filter() with ARRAY_FILTER_USE_KEY directly
158 * @param callable $callback Will be called with the array key and should return a bool which
159 * will determine whether the array element is kept.
162 function wfArrayFilterByKey( array $arr, callable
$callback ) {
163 return array_filter( $arr, $callback, ARRAY_FILTER_USE_KEY
);
167 * Appends to second array if $value differs from that in $default
169 * @param string|int $key
170 * @param mixed $value
171 * @param mixed $default
172 * @param array &$changed Array to alter
173 * @throws MWException
175 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
176 if ( is_null( $changed ) ) {
177 throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' );
179 if ( $default[$key] !== $value ) {
180 $changed[$key] = $value;
185 * Merge arrays in the style of getUserPermissionsErrors, with duplicate removal
187 * wfMergeErrorArrays(
200 * @param array $array1,...
203 function wfMergeErrorArrays( /*...*/ ) {
204 $args = func_get_args();
206 foreach ( $args as $errors ) {
207 foreach ( $errors as $params ) {
208 $originalParams = $params;
209 if ( $params[0] instanceof MessageSpecifier
) {
211 $params = array_merge( [ $msg->getKey() ], $msg->getParams() );
213 # @todo FIXME: Sometimes get nested arrays for $params,
214 # which leads to E_NOTICEs
215 $spec = implode( "\t", $params );
216 $out[$spec] = $originalParams;
219 return array_values( $out );
223 * Insert array into another array after the specified *KEY*
225 * @param array $array The array.
226 * @param array $insert The array to insert.
227 * @param mixed $after The key to insert after
230 function wfArrayInsertAfter( array $array, array $insert, $after ) {
231 // Find the offset of the element to insert after.
232 $keys = array_keys( $array );
233 $offsetByKey = array_flip( $keys );
235 $offset = $offsetByKey[$after];
237 // Insert at the specified offset
238 $before = array_slice( $array, 0, $offset +
1, true );
239 $after = array_slice( $array, $offset +
1, count( $array ) - $offset, true );
241 $output = $before +
$insert +
$after;
247 * Recursively converts the parameter (an object) to an array with the same data
249 * @param object|array $objOrArray
250 * @param bool $recursive
253 function wfObjectToArray( $objOrArray, $recursive = true ) {
255 if ( is_object( $objOrArray ) ) {
256 $objOrArray = get_object_vars( $objOrArray );
258 foreach ( $objOrArray as $key => $value ) {
259 if ( $recursive && ( is_object( $value ) ||
is_array( $value ) ) ) {
260 $value = wfObjectToArray( $value );
263 $array[$key] = $value;
270 * Get a random decimal value between 0 and 1, in a way
271 * not likely to give duplicate values for any realistic
272 * number of articles.
274 * @note This is designed for use in relation to Special:RandomPage
275 * and the page_random database field.
279 function wfRandom() {
280 // The maximum random value is "only" 2^31-1, so get two random
281 // values to reduce the chance of dupes
282 $max = mt_getrandmax() +
1;
283 $rand = number_format( ( mt_rand() * $max +
mt_rand() ) / $max / $max, 12, '.', '' );
288 * Get a random string containing a number of pseudo-random hex characters.
290 * @note This is not secure, if you are trying to generate some sort
291 * of token please use MWCryptRand instead.
293 * @param int $length The length of the string to generate
297 function wfRandomString( $length = 32 ) {
299 for ( $n = 0; $n < $length; $n +
= 7 ) {
300 $str .= sprintf( '%07x', mt_rand() & 0xfffffff );
302 return substr( $str, 0, $length );
306 * We want some things to be included as literal characters in our title URLs
307 * for prettiness, which urlencode encodes by default. According to RFC 1738,
308 * all of the following should be safe:
312 * RFC 1738 says ~ is unsafe, however RFC 3986 considers it an unreserved
313 * character which should not be encoded. More importantly, google chrome
314 * always converts %7E back to ~, and converting it in this function can
315 * cause a redirect loop (T105265).
317 * But + is not safe because it's used to indicate a space; &= are only safe in
318 * paths and not in queries (and we don't distinguish here); ' seems kind of
319 * scary; and urlencode() doesn't touch -_. to begin with. Plus, although /
320 * is reserved, we don't care. So the list we unescape is:
324 * However, IIS7 redirects fail when the url contains a colon (see T24709),
325 * so no fancy : for IIS7.
327 * %2F in the page titles seems to fatally break for some reason.
332 function wfUrlencode( $s ) {
335 if ( is_null( $s ) ) {
340 if ( is_null( $needle ) ) {
341 $needle = [ '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F', '%7E' ];
342 if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) ||
343 ( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false )
349 $s = urlencode( $s );
352 [ ';', '@', '$', '!', '*', '(', ')', ',', '/', '~', ':' ],
360 * This function takes one or two arrays as input, and returns a CGI-style string, e.g.
361 * "days=7&limit=100". Options in the first array override options in the second.
362 * Options set to null or false will not be output.
364 * @param array $array1 ( String|Array )
365 * @param array|null $array2 ( String|Array )
366 * @param string $prefix
369 function wfArrayToCgi( $array1, $array2 = null, $prefix = '' ) {
370 if ( !is_null( $array2 ) ) {
371 $array1 = $array1 +
$array2;
375 foreach ( $array1 as $key => $value ) {
376 if ( !is_null( $value ) && $value !== false ) {
380 if ( $prefix !== '' ) {
381 $key = $prefix . "[$key]";
383 if ( is_array( $value ) ) {
385 foreach ( $value as $k => $v ) {
386 $cgi .= $firstTime ?
'' : '&';
387 if ( is_array( $v ) ) {
388 $cgi .= wfArrayToCgi( $v, null, $key . "[$k]" );
390 $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v );
395 if ( is_object( $value ) ) {
396 $value = $value->__toString();
398 $cgi .= urlencode( $key ) . '=' . urlencode( $value );
406 * This is the logical opposite of wfArrayToCgi(): it accepts a query string as
407 * its argument and returns the same string in array form. This allows compatibility
408 * with legacy functions that accept raw query strings instead of nice
409 * arrays. Of course, keys and values are urldecode()d.
411 * @param string $query Query string
412 * @return string[] Array version of input
414 function wfCgiToArray( $query ) {
415 if ( isset( $query[0] ) && $query[0] == '?' ) {
416 $query = substr( $query, 1 );
418 $bits = explode( '&', $query );
420 foreach ( $bits as $bit ) {
424 if ( strpos( $bit, '=' ) === false ) {
425 // Pieces like &qwerty become 'qwerty' => '' (at least this is what php does)
429 list( $key, $value ) = explode( '=', $bit );
431 $key = urldecode( $key );
432 $value = urldecode( $value );
433 if ( strpos( $key, '[' ) !== false ) {
434 $keys = array_reverse( explode( '[', $key ) );
435 $key = array_pop( $keys );
437 foreach ( $keys as $k ) {
438 $k = substr( $k, 0, -1 );
439 $temp = [ $k => $temp ];
441 if ( isset( $ret[$key] ) ) {
442 $ret[$key] = array_merge( $ret[$key], $temp );
454 * Append a query string to an existing URL, which may or may not already
455 * have query string parameters already. If so, they will be combined.
458 * @param string|string[] $query String or associative array
461 function wfAppendQuery( $url, $query ) {
462 if ( is_array( $query ) ) {
463 $query = wfArrayToCgi( $query );
465 if ( $query != '' ) {
466 // Remove the fragment, if there is one
468 $hashPos = strpos( $url, '#' );
469 if ( $hashPos !== false ) {
470 $fragment = substr( $url, $hashPos );
471 $url = substr( $url, 0, $hashPos );
475 if ( false === strpos( $url, '?' ) ) {
482 // Put the fragment back
483 if ( $fragment !== false ) {
491 * Expand a potentially local URL to a fully-qualified URL. Assumes $wgServer
494 * The meaning of the PROTO_* constants is as follows:
495 * PROTO_HTTP: Output a URL starting with http://
496 * PROTO_HTTPS: Output a URL starting with https://
497 * PROTO_RELATIVE: Output a URL starting with // (protocol-relative URL)
498 * PROTO_CURRENT: Output a URL starting with either http:// or https:// , depending
499 * on which protocol was used for the current incoming request
500 * PROTO_CANONICAL: For URLs without a domain, like /w/index.php , use $wgCanonicalServer.
501 * For protocol-relative URLs, use the protocol of $wgCanonicalServer
502 * PROTO_INTERNAL: Like PROTO_CANONICAL, but uses $wgInternalServer instead of $wgCanonicalServer
504 * @todo this won't work with current-path-relative URLs
505 * like "subdir/foo.html", etc.
507 * @param string $url Either fully-qualified or a local path + query
508 * @param string|int|null $defaultProto One of the PROTO_* constants. Determines the
509 * protocol to use if $url or $wgServer is protocol-relative
510 * @return string|false Fully-qualified URL, current-path-relative URL or false if
511 * no valid URL can be constructed
513 function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT
) {
514 global $wgServer, $wgCanonicalServer, $wgInternalServer, $wgRequest,
516 if ( $defaultProto === PROTO_CANONICAL
) {
517 $serverUrl = $wgCanonicalServer;
518 } elseif ( $defaultProto === PROTO_INTERNAL
&& $wgInternalServer !== false ) {
519 // Make $wgInternalServer fall back to $wgServer if not set
520 $serverUrl = $wgInternalServer;
522 $serverUrl = $wgServer;
523 if ( $defaultProto === PROTO_CURRENT
) {
524 $defaultProto = $wgRequest->getProtocol() . '://';
528 // Analyze $serverUrl to obtain its protocol
529 $bits = wfParseUrl( $serverUrl );
530 $serverHasProto = $bits && $bits['scheme'] != '';
532 if ( $defaultProto === PROTO_CANONICAL ||
$defaultProto === PROTO_INTERNAL
) {
533 if ( $serverHasProto ) {
534 $defaultProto = $bits['scheme'] . '://';
536 // $wgCanonicalServer or $wgInternalServer doesn't have a protocol.
537 // This really isn't supposed to happen. Fall back to HTTP in this
539 $defaultProto = PROTO_HTTP
;
543 $defaultProtoWithoutSlashes = substr( $defaultProto, 0, -2 );
545 if ( substr( $url, 0, 2 ) == '//' ) {
546 $url = $defaultProtoWithoutSlashes . $url;
547 } elseif ( substr( $url, 0, 1 ) == '/' ) {
548 // If $serverUrl is protocol-relative, prepend $defaultProtoWithoutSlashes,
549 // otherwise leave it alone.
550 if ( $serverHasProto ) {
551 $url = $serverUrl . $url;
553 // If an HTTPS URL is synthesized from a protocol-relative $wgServer, allow the
554 // user to override the port number (T67184)
555 if ( $defaultProto === PROTO_HTTPS
&& $wgHttpsPort != 443 ) {
556 if ( isset( $bits['port'] ) ) {
557 throw new Exception( 'A protocol-relative $wgServer may not contain a port number' );
559 $url = $defaultProtoWithoutSlashes . $serverUrl . ':' . $wgHttpsPort . $url;
561 $url = $defaultProtoWithoutSlashes . $serverUrl . $url;
566 $bits = wfParseUrl( $url );
568 if ( $bits && isset( $bits['path'] ) ) {
569 $bits['path'] = wfRemoveDotSegments( $bits['path'] );
570 return wfAssembleUrl( $bits );
574 } elseif ( substr( $url, 0, 1 ) != '/' ) {
575 # URL is a relative path
576 return wfRemoveDotSegments( $url );
579 # Expanded URL is not valid.
584 * Get the wiki's "server", i.e. the protocol and host part of the URL, with a
585 * protocol specified using a PROTO_* constant as in wfExpandUrl()
588 * @param string|int|null $proto One of the PROTO_* constants.
589 * @return string The URL
591 function wfGetServerUrl( $proto ) {
592 $url = wfExpandUrl( '/', $proto );
593 return substr( $url, 0, -1 );
597 * This function will reassemble a URL parsed with wfParseURL. This is useful
598 * if you need to edit part of a URL and put it back together.
600 * This is the basic structure used (brackets contain keys for $urlParts):
601 * [scheme][delimiter][user]:[pass]@[host]:[port][path]?[query]#[fragment]
603 * @todo Need to integrate this into wfExpandUrl (see T34168)
606 * @param array $urlParts URL parts, as output from wfParseUrl
607 * @return string URL assembled from its component parts
609 function wfAssembleUrl( $urlParts ) {
612 if ( isset( $urlParts['delimiter'] ) ) {
613 if ( isset( $urlParts['scheme'] ) ) {
614 $result .= $urlParts['scheme'];
617 $result .= $urlParts['delimiter'];
620 if ( isset( $urlParts['host'] ) ) {
621 if ( isset( $urlParts['user'] ) ) {
622 $result .= $urlParts['user'];
623 if ( isset( $urlParts['pass'] ) ) {
624 $result .= ':' . $urlParts['pass'];
629 $result .= $urlParts['host'];
631 if ( isset( $urlParts['port'] ) ) {
632 $result .= ':' . $urlParts['port'];
636 if ( isset( $urlParts['path'] ) ) {
637 $result .= $urlParts['path'];
640 if ( isset( $urlParts['query'] ) ) {
641 $result .= '?' . $urlParts['query'];
644 if ( isset( $urlParts['fragment'] ) ) {
645 $result .= '#' . $urlParts['fragment'];
652 * Remove all dot-segments in the provided URL path. For example,
653 * '/a/./b/../c/' becomes '/a/c/'. For details on the algorithm, please see
654 * RFC3986 section 5.2.4.
656 * @todo Need to integrate this into wfExpandUrl (see T34168)
660 * @param string $urlPath URL path, potentially containing dot-segments
661 * @return string URL path with all dot-segments removed
663 function wfRemoveDotSegments( $urlPath ) {
666 $inputLength = strlen( $urlPath );
668 while ( $inputOffset < $inputLength ) {
669 $prefixLengthOne = substr( $urlPath, $inputOffset, 1 );
670 $prefixLengthTwo = substr( $urlPath, $inputOffset, 2 );
671 $prefixLengthThree = substr( $urlPath, $inputOffset, 3 );
672 $prefixLengthFour = substr( $urlPath, $inputOffset, 4 );
675 if ( $prefixLengthTwo == './' ) {
676 # Step A, remove leading "./"
678 } elseif ( $prefixLengthThree == '../' ) {
679 # Step A, remove leading "../"
681 } elseif ( ( $prefixLengthTwo == '/.' ) && ( $inputOffset +
2 == $inputLength ) ) {
682 # Step B, replace leading "/.$" with "/"
684 $urlPath[$inputOffset] = '/';
685 } elseif ( $prefixLengthThree == '/./' ) {
686 # Step B, replace leading "/./" with "/"
688 } elseif ( $prefixLengthThree == '/..' && ( $inputOffset +
3 == $inputLength ) ) {
689 # Step C, replace leading "/..$" with "/" and
690 # remove last path component in output
692 $urlPath[$inputOffset] = '/';
694 } elseif ( $prefixLengthFour == '/../' ) {
695 # Step C, replace leading "/../" with "/" and
696 # remove last path component in output
699 } elseif ( ( $prefixLengthOne == '.' ) && ( $inputOffset +
1 == $inputLength ) ) {
700 # Step D, remove "^.$"
702 } elseif ( ( $prefixLengthTwo == '..' ) && ( $inputOffset +
2 == $inputLength ) ) {
703 # Step D, remove "^..$"
706 # Step E, move leading path segment to output
707 if ( $prefixLengthOne == '/' ) {
708 $slashPos = strpos( $urlPath, '/', $inputOffset +
1 );
710 $slashPos = strpos( $urlPath, '/', $inputOffset );
712 if ( $slashPos === false ) {
713 $output .= substr( $urlPath, $inputOffset );
714 $inputOffset = $inputLength;
716 $output .= substr( $urlPath, $inputOffset, $slashPos - $inputOffset );
717 $inputOffset +
= $slashPos - $inputOffset;
722 $slashPos = strrpos( $output, '/' );
723 if ( $slashPos === false ) {
726 $output = substr( $output, 0, $slashPos );
735 * Returns a regular expression of url protocols
737 * @param bool $includeProtocolRelative If false, remove '//' from the returned protocol list.
738 * DO NOT USE this directly, use wfUrlProtocolsWithoutProtRel() instead
741 function wfUrlProtocols( $includeProtocolRelative = true ) {
742 global $wgUrlProtocols;
744 // Cache return values separately based on $includeProtocolRelative
745 static $withProtRel = null, $withoutProtRel = null;
746 $cachedValue = $includeProtocolRelative ?
$withProtRel : $withoutProtRel;
747 if ( !is_null( $cachedValue ) ) {
751 // Support old-style $wgUrlProtocols strings, for backwards compatibility
752 // with LocalSettings files from 1.5
753 if ( is_array( $wgUrlProtocols ) ) {
755 foreach ( $wgUrlProtocols as $protocol ) {
756 // Filter out '//' if !$includeProtocolRelative
757 if ( $includeProtocolRelative ||
$protocol !== '//' ) {
758 $protocols[] = preg_quote( $protocol, '/' );
762 $retval = implode( '|', $protocols );
764 // Ignore $includeProtocolRelative in this case
765 // This case exists for pre-1.6 compatibility, and we can safely assume
766 // that '//' won't appear in a pre-1.6 config because protocol-relative
767 // URLs weren't supported until 1.18
768 $retval = $wgUrlProtocols;
771 // Cache return value
772 if ( $includeProtocolRelative ) {
773 $withProtRel = $retval;
775 $withoutProtRel = $retval;
781 * Like wfUrlProtocols(), but excludes '//' from the protocol list. Use this if
782 * you need a regex that matches all URL protocols but does not match protocol-
786 function wfUrlProtocolsWithoutProtRel() {
787 return wfUrlProtocols( false );
791 * parse_url() work-alike, but non-broken. Differences:
793 * 1) Does not raise warnings on bad URLs (just returns false).
794 * 2) Handles protocols that don't use :// (e.g., mailto: and news:, as well as
795 * protocol-relative URLs) correctly.
796 * 3) Adds a "delimiter" element to the array (see (2)).
797 * 4) Verifies that the protocol is on the $wgUrlProtocols whitelist.
798 * 5) Rejects some invalid URLs that parse_url doesn't, e.g. the empty string or URLs starting with
799 * a line feed character.
801 * @param string $url A URL to parse
802 * @return string[]|bool Bits of the URL in an associative array, or false on failure.
804 * - scheme: URI scheme (protocol), e.g. 'http', 'mailto'. Lowercase, always present, but can
805 * be an empty string for protocol-relative URLs.
806 * - delimiter: either '://', ':' or '//'. Always present.
807 * - host: domain name / IP. Always present, but could be an empty string, e.g. for file: URLs.
808 * - user: user name, e.g. for HTTP Basic auth URLs such as http://user:pass@example.com/
809 * Missing when there is no username.
810 * - pass: password, same as above.
811 * - path: path including the leading /. Will be missing when empty (e.g. 'http://example.com')
812 * - query: query string (as a string; see wfCgiToArray() for parsing it), can be missing.
813 * - fragment: the part after #, can be missing.
815 function wfParseUrl( $url ) {
816 global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
818 // Protocol-relative URLs are handled really badly by parse_url(). It's so
819 // bad that the easiest way to handle them is to just prepend 'http:' and
820 // strip the protocol out later.
821 $wasRelative = substr( $url, 0, 2 ) == '//';
822 if ( $wasRelative ) {
825 Wikimedia\
suppressWarnings();
826 $bits = parse_url( $url );
827 Wikimedia\restoreWarnings
();
828 // parse_url() returns an array without scheme for some invalid URLs, e.g.
829 // parse_url("%0Ahttp://example.com") == [ 'host' => '%0Ahttp', 'path' => 'example.com' ]
830 if ( !$bits ||
!isset( $bits['scheme'] ) ) {
834 // parse_url() incorrectly handles schemes case-sensitively. Convert it to lowercase.
835 $bits['scheme'] = strtolower( $bits['scheme'] );
837 // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
838 if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
839 $bits['delimiter'] = '://';
840 } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
841 $bits['delimiter'] = ':';
842 // parse_url detects for news: and mailto: the host part of an url as path
843 // We have to correct this wrong detection
844 if ( isset( $bits['path'] ) ) {
845 $bits['host'] = $bits['path'];
852 /* Provide an empty host for eg. file:/// urls (see T30627) */
853 if ( !isset( $bits['host'] ) ) {
857 if ( isset( $bits['path'] ) ) {
858 /* parse_url loses the third / for file:///c:/ urls (but not on variants) */
859 if ( substr( $bits['path'], 0, 1 ) !== '/' ) {
860 $bits['path'] = '/' . $bits['path'];
867 // If the URL was protocol-relative, fix scheme and delimiter
868 if ( $wasRelative ) {
869 $bits['scheme'] = '';
870 $bits['delimiter'] = '//';
876 * Take a URL, make sure it's expanded to fully qualified, and replace any
877 * encoded non-ASCII Unicode characters with their UTF-8 original forms
878 * for more compact display and legibility for local audiences.
880 * @todo handle punycode domains too
885 function wfExpandIRI( $url ) {
886 return preg_replace_callback(
887 '/((?:%[89A-F][0-9A-F])+)/i',
888 function ( array $matches ) {
889 return urldecode( $matches[1] );
896 * Make URL indexes, appropriate for the el_index field of externallinks.
901 function wfMakeUrlIndexes( $url ) {
902 $bits = wfParseUrl( $url );
904 // Reverse the labels in the hostname, convert to lower case
905 // For emails reverse domainpart only
906 if ( $bits['scheme'] == 'mailto' ) {
907 $mailparts = explode( '@', $bits['host'], 2 );
908 if ( count( $mailparts ) === 2 ) {
909 $domainpart = strtolower( implode( '.', array_reverse( explode( '.', $mailparts[1] ) ) ) );
911 // No domain specified, don't mangle it
914 $reversedHost = $domainpart . '@' . $mailparts[0];
916 $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) );
918 // Add an extra dot to the end
919 // Why? Is it in wrong place in mailto links?
920 if ( substr( $reversedHost, -1, 1 ) !== '.' ) {
921 $reversedHost .= '.';
923 // Reconstruct the pseudo-URL
924 $prot = $bits['scheme'];
925 $index = $prot . $bits['delimiter'] . $reversedHost;
926 // Leave out user and password. Add the port, path, query and fragment
927 if ( isset( $bits['port'] ) ) {
928 $index .= ':' . $bits['port'];
930 if ( isset( $bits['path'] ) ) {
931 $index .= $bits['path'];
935 if ( isset( $bits['query'] ) ) {
936 $index .= '?' . $bits['query'];
938 if ( isset( $bits['fragment'] ) ) {
939 $index .= '#' . $bits['fragment'];
943 return [ "http:$index", "https:$index" ];
950 * Check whether a given URL has a domain that occurs in a given set of domains
952 * @param array $domains Array of domains (strings)
953 * @return bool True if the host part of $url ends in one of the strings in $domains
955 function wfMatchesDomainList( $url, $domains ) {
956 $bits = wfParseUrl( $url );
957 if ( is_array( $bits ) && isset( $bits['host'] ) ) {
958 $host = '.' . $bits['host'];
959 foreach ( (array)$domains as $domain ) {
960 $domain = '.' . $domain;
961 if ( substr( $host, -strlen( $domain ) ) === $domain ) {
970 * Sends a line to the debug log if enabled or, optionally, to a comment in output.
971 * In normal operation this is a NOP.
973 * Controlling globals:
974 * $wgDebugLogFile - points to the log file
975 * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
976 * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
978 * @since 1.25 support for additional context data
980 * @param string $text
981 * @param string|bool $dest Destination of the message:
982 * - 'all': both to the log and HTML (debug toolbar or HTML comments)
983 * - 'private': excluded from HTML output
984 * For backward compatibility, it can also take a boolean:
985 * - true: same as 'all'
986 * - false: same as 'private'
987 * @param array $context Additional logging context data
989 function wfDebug( $text, $dest = 'all', array $context = [] ) {
990 global $wgDebugRawPage, $wgDebugLogPrefix;
991 global $wgDebugTimestamps;
993 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
997 $text = trim( $text );
999 if ( $wgDebugTimestamps ) {
1000 $context['seconds_elapsed'] = sprintf(
1002 microtime( true ) - $_SERVER['REQUEST_TIME_FLOAT']
1004 $context['memory_used'] = sprintf(
1006 ( memory_get_usage( true ) / ( 1024 * 1024 ) )
1010 if ( $wgDebugLogPrefix !== '' ) {
1011 $context['prefix'] = $wgDebugLogPrefix;
1013 $context['private'] = ( $dest === false ||
$dest === 'private' );
1015 $logger = LoggerFactory
::getInstance( 'wfDebug' );
1016 $logger->debug( $text, $context );
1020 * Returns true if debug logging should be suppressed if $wgDebugRawPage = false
1023 function wfIsDebugRawPage() {
1025 if ( $cache !== null ) {
1028 // Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
1029 // phpcs:ignore MediaWiki.Usage.SuperGlobalsUsage.SuperGlobals
1030 if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
1032 isset( $_SERVER['SCRIPT_NAME'] )
1033 && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
1044 * Send a line giving PHP memory usage.
1046 * @param bool $exact Print exact byte values instead of kibibytes (default: false)
1048 function wfDebugMem( $exact = false ) {
1049 $mem = memory_get_usage();
1051 $mem = floor( $mem / 1024 ) . ' KiB';
1055 wfDebug( "Memory usage: $mem\n" );
1059 * Send a line to a supplementary debug log file, if configured, or main debug
1062 * To configure a supplementary log file, set $wgDebugLogGroups[$logGroup] to
1063 * a string filename or an associative array mapping 'destination' to the
1064 * desired filename. The associative array may also contain a 'sample' key
1065 * with an integer value, specifying a sampling factor. Sampled log events
1066 * will be emitted with a 1 in N random chance.
1068 * @since 1.23 support for sampling log messages via $wgDebugLogGroups.
1069 * @since 1.25 support for additional context data
1070 * @since 1.25 sample behavior dependent on configured $wgMWLoggerDefaultSpi
1072 * @param string $logGroup
1073 * @param string $text
1074 * @param string|bool $dest Destination of the message:
1075 * - 'all': both to the log and HTML (debug toolbar or HTML comments)
1076 * - 'private': only to the specific log if set in $wgDebugLogGroups and
1077 * discarded otherwise
1078 * For backward compatibility, it can also take a boolean:
1079 * - true: same as 'all'
1080 * - false: same as 'private'
1081 * @param array $context Additional logging context data
1083 function wfDebugLog(
1084 $logGroup, $text, $dest = 'all', array $context = []
1086 $text = trim( $text );
1088 $logger = LoggerFactory
::getInstance( $logGroup );
1089 $context['private'] = ( $dest === false ||
$dest === 'private' );
1090 $logger->info( $text, $context );
1094 * Log for database errors
1096 * @since 1.25 support for additional context data
1098 * @param string $text Database error message.
1099 * @param array $context Additional logging context data
1101 function wfLogDBError( $text, array $context = [] ) {
1102 $logger = LoggerFactory
::getInstance( 'wfLogDBError' );
1103 $logger->error( trim( $text ), $context );
1107 * Throws a warning that $function is deprecated
1109 * @param string $function
1110 * @param string|bool $version Version of MediaWiki that the function
1111 * was deprecated in (Added in 1.19).
1112 * @param string|bool $component Added in 1.19.
1113 * @param int $callerOffset How far up the call stack is the original
1114 * caller. 2 = function that called the function that called
1115 * wfDeprecated (Added in 1.20)
1119 function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) {
1120 MWDebug
::deprecated( $function, $version, $component, $callerOffset +
1 );
1124 * Send a warning either to the debug log or in a PHP error depending on
1125 * $wgDevelopmentWarnings. To log warnings in production, use wfLogWarning() instead.
1127 * @param string $msg Message to send
1128 * @param int $callerOffset Number of items to go back in the backtrace to
1129 * find the correct caller (1 = function calling wfWarn, ...)
1130 * @param int $level PHP error level; defaults to E_USER_NOTICE;
1131 * only used when $wgDevelopmentWarnings is true
1133 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE
) {
1134 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'auto' );
1138 * Send a warning as a PHP error and the debug log. This is intended for logging
1139 * warnings in production. For logging development warnings, use WfWarn instead.
1141 * @param string $msg Message to send
1142 * @param int $callerOffset Number of items to go back in the backtrace to
1143 * find the correct caller (1 = function calling wfLogWarning, ...)
1144 * @param int $level PHP error level; defaults to E_USER_WARNING
1146 function wfLogWarning( $msg, $callerOffset = 1, $level = E_USER_WARNING
) {
1147 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'production' );
1152 * @todo Move logic to MediaWiki.php
1154 function wfLogProfilingData() {
1155 global $wgDebugLogGroups, $wgDebugRawPage;
1157 $context = RequestContext
::getMain();
1158 $request = $context->getRequest();
1160 $profiler = Profiler
::instance();
1161 $profiler->setContext( $context );
1162 $profiler->logData();
1164 // Send out any buffered statsd metrics as needed
1165 MediaWiki
::emitBufferedStatsdData(
1166 MediaWikiServices
::getInstance()->getStatsdDataFactory(),
1167 $context->getConfig()
1170 // Profiling must actually be enabled...
1171 if ( $profiler instanceof ProfilerStub
) {
1175 if ( isset( $wgDebugLogGroups['profileoutput'] )
1176 && $wgDebugLogGroups['profileoutput'] === false
1178 // Explicitly disabled
1181 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1185 $ctx = [ 'elapsed' => $request->getElapsedTime() ];
1186 if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1187 $ctx['forwarded_for'] = $_SERVER['HTTP_X_FORWARDED_FOR'];
1189 if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1190 $ctx['client_ip'] = $_SERVER['HTTP_CLIENT_IP'];
1192 if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1193 $ctx['from'] = $_SERVER['HTTP_FROM'];
1195 if ( isset( $ctx['forwarded_for'] ) ||
1196 isset( $ctx['client_ip'] ) ||
1197 isset( $ctx['from'] ) ) {
1198 $ctx['proxy'] = $_SERVER['REMOTE_ADDR'];
1201 // Don't load $wgUser at this late stage just for statistics purposes
1202 // @todo FIXME: We can detect some anons even if it is not loaded.
1203 // See User::getId()
1204 $user = $context->getUser();
1205 $ctx['anon'] = $user->isItemLoaded( 'id' ) && $user->isAnon();
1207 // Command line script uses a FauxRequest object which does not have
1208 // any knowledge about an URL and throw an exception instead.
1210 $ctx['url'] = urldecode( $request->getRequestURL() );
1211 } catch ( Exception
$ignored ) {
1215 $ctx['output'] = $profiler->getOutput();
1217 $log = LoggerFactory
::getInstance( 'profileoutput' );
1218 $log->info( "Elapsed: {elapsed}; URL: <{url}>\n{output}", $ctx );
1222 * Increment a statistics counter
1224 * @param string $key
1228 function wfIncrStats( $key, $count = 1 ) {
1229 $stats = MediaWikiServices
::getInstance()->getStatsdDataFactory();
1230 $stats->updateCount( $key, $count );
1234 * Check whether the wiki is in read-only mode.
1238 function wfReadOnly() {
1239 return MediaWikiServices
::getInstance()->getReadOnlyMode()
1244 * Check if the site is in read-only mode and return the message if so
1246 * This checks wfConfiguredReadOnlyReason() and the main load balancer
1247 * for replica DB lag. This may result in DB connection being made.
1249 * @return string|bool String when in read-only mode; false otherwise
1251 function wfReadOnlyReason() {
1252 return MediaWikiServices
::getInstance()->getReadOnlyMode()
1257 * Get the value of $wgReadOnly or the contents of $wgReadOnlyFile.
1259 * @return string|bool String when in read-only mode; false otherwise
1262 function wfConfiguredReadOnlyReason() {
1263 return MediaWikiServices
::getInstance()->getConfiguredReadOnlyMode()
1268 * Return a Language object from $langcode
1270 * @param Language|string|bool $langcode Either:
1271 * - a Language object
1272 * - code of the language to get the message for, if it is
1273 * a valid code create a language for that language, if
1274 * it is a string but not a valid code then make a basic
1276 * - a boolean: if it's false then use the global object for
1277 * the current user's language (as a fallback for the old parameter
1278 * functionality), or if it is true then use global object
1279 * for the wiki's content language.
1282 function wfGetLangObj( $langcode = false ) {
1283 # Identify which language to get or create a language object for.
1284 # Using is_object here due to Stub objects.
1285 if ( is_object( $langcode ) ) {
1286 # Great, we already have the object (hopefully)!
1290 global $wgLanguageCode;
1291 if ( $langcode === true ||
$langcode === $wgLanguageCode ) {
1292 # $langcode is the language code of the wikis content language object.
1293 # or it is a boolean and value is true
1294 return MediaWikiServices
::getInstance()->getContentLanguage();
1298 if ( $langcode === false ||
$langcode === $wgLang->getCode() ) {
1299 # $langcode is the language code of user language object.
1300 # or it was a boolean and value is false
1304 $validCodes = array_keys( Language
::fetchLanguageNames() );
1305 if ( in_array( $langcode, $validCodes ) ) {
1306 # $langcode corresponds to a valid language.
1307 return Language
::factory( $langcode );
1310 # $langcode is a string, but not a valid language code; use content language.
1311 wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1312 return MediaWikiServices
::getInstance()->getContentLanguage();
1316 * This is the function for getting translated interface messages.
1318 * @see Message class for documentation how to use them.
1319 * @see https://www.mediawiki.org/wiki/Manual:Messages_API
1321 * This function replaces all old wfMsg* functions.
1323 * @param string|string[]|MessageSpecifier $key Message key, or array of keys, or a MessageSpecifier
1324 * @param string|string[] ...$params Normal message parameters
1329 * @see Message::__construct
1331 function wfMessage( $key, ...$params ) {
1332 $message = new Message( $key );
1334 // We call Message::params() to reduce code duplication
1336 $message->params( ...$params );
1343 * This function accepts multiple message keys and returns a message instance
1344 * for the first message which is non-empty. If all messages are empty then an
1345 * instance of the first message key is returned.
1347 * @param string ...$keys Message keys
1352 * @see Message::newFallbackSequence
1354 function wfMessageFallback( ...$keys ) {
1355 return Message
::newFallbackSequence( ...$keys );
1359 * Replace message parameter keys on the given formatted output.
1361 * @param string $message
1362 * @param array $args
1366 function wfMsgReplaceArgs( $message, $args ) {
1367 # Fix windows line-endings
1368 # Some messages are split with explode("\n", $msg)
1369 $message = str_replace( "\r", '', $message );
1371 // Replace arguments
1372 if ( is_array( $args ) && $args ) {
1373 if ( is_array( $args[0] ) ) {
1374 $args = array_values( $args[0] );
1376 $replacementKeys = [];
1377 foreach ( $args as $n => $param ) {
1378 $replacementKeys['$' . ( $n +
1 )] = $param;
1380 $message = strtr( $message, $replacementKeys );
1387 * Fetch server name for use in error reporting etc.
1388 * Use real server name if available, so we know which machine
1389 * in a server farm generated the current page.
1393 function wfHostname() {
1395 if ( is_null( $host ) ) {
1396 # Hostname overriding
1397 global $wgOverrideHostname;
1398 if ( $wgOverrideHostname !== false ) {
1399 # Set static and skip any detection
1400 $host = $wgOverrideHostname;
1404 if ( function_exists( 'posix_uname' ) ) {
1405 // This function not present on Windows
1406 $uname = posix_uname();
1410 if ( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1411 $host = $uname['nodename'];
1412 } elseif ( getenv( 'COMPUTERNAME' ) ) {
1413 # Windows computer name
1414 $host = getenv( 'COMPUTERNAME' );
1416 # This may be a virtual server.
1417 $host = $_SERVER['SERVER_NAME'];
1424 * Returns a script tag that stores the amount of time it took MediaWiki to
1425 * handle the request in milliseconds as 'wgBackendResponseTime'.
1427 * If $wgShowHostnames is true, the script will also set 'wgHostname' to the
1428 * hostname of the server handling the request.
1430 * @param string|null $nonce Value from OutputPage::getCSPNonce
1431 * @return string|WrappedString HTML
1433 function wfReportTime( $nonce = null ) {
1434 global $wgShowHostnames;
1436 $elapsed = ( microtime( true ) - $_SERVER['REQUEST_TIME_FLOAT'] );
1437 // seconds to milliseconds
1438 $responseTime = round( $elapsed * 1000 );
1439 $reportVars = [ 'wgBackendResponseTime' => $responseTime ];
1440 if ( $wgShowHostnames ) {
1441 $reportVars['wgHostname'] = wfHostname();
1443 return Skin
::makeVariablesScript( $reportVars, $nonce );
1447 * Safety wrapper for debug_backtrace().
1449 * Will return an empty array if debug_backtrace is disabled, otherwise
1450 * the output from debug_backtrace() (trimmed).
1452 * @param int $limit This parameter can be used to limit the number of stack frames returned
1454 * @return array Array of backtrace information
1456 function wfDebugBacktrace( $limit = 0 ) {
1457 static $disabled = null;
1459 if ( is_null( $disabled ) ) {
1460 $disabled = !function_exists( 'debug_backtrace' );
1462 wfDebug( "debug_backtrace() is disabled\n" );
1470 return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT
, $limit +
1 ), 1 );
1472 return array_slice( debug_backtrace(), 1 );
1477 * Get a debug backtrace as a string
1479 * @param bool|null $raw If true, the return value is plain text. If false, HTML.
1480 * Defaults to $wgCommandLineMode if unset.
1482 * @since 1.25 Supports $raw parameter.
1484 function wfBacktrace( $raw = null ) {
1485 global $wgCommandLineMode;
1487 if ( $raw === null ) {
1488 $raw = $wgCommandLineMode;
1492 $frameFormat = "%s line %s calls %s()\n";
1493 $traceFormat = "%s";
1495 $frameFormat = "<li>%s line %s calls %s()</li>\n";
1496 $traceFormat = "<ul>\n%s</ul>\n";
1499 $frames = array_map( function ( $frame ) use ( $frameFormat ) {
1500 $file = !empty( $frame['file'] ) ?
basename( $frame['file'] ) : '-';
1501 $line = $frame['line'] ??
'-';
1502 $call = $frame['function'];
1503 if ( !empty( $frame['class'] ) ) {
1504 $call = $frame['class'] . $frame['type'] . $call;
1506 return sprintf( $frameFormat, $file, $line, $call );
1507 }, wfDebugBacktrace() );
1509 return sprintf( $traceFormat, implode( '', $frames ) );
1513 * Get the name of the function which called this function
1514 * wfGetCaller( 1 ) is the function with the wfGetCaller() call (ie. __FUNCTION__)
1515 * wfGetCaller( 2 ) [default] is the caller of the function running wfGetCaller()
1516 * wfGetCaller( 3 ) is the parent of that.
1521 function wfGetCaller( $level = 2 ) {
1522 $backtrace = wfDebugBacktrace( $level +
1 );
1523 if ( isset( $backtrace[$level] ) ) {
1524 return wfFormatStackFrame( $backtrace[$level] );
1531 * Return a string consisting of callers in the stack. Useful sometimes
1532 * for profiling specific points.
1534 * @param int $limit The maximum depth of the stack frame to return, or false for the entire stack.
1537 function wfGetAllCallers( $limit = 3 ) {
1538 $trace = array_reverse( wfDebugBacktrace() );
1539 if ( !$limit ||
$limit > count( $trace ) - 1 ) {
1540 $limit = count( $trace ) - 1;
1542 $trace = array_slice( $trace, -$limit - 1, $limit );
1543 return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1547 * Return a string representation of frame
1549 * @param array $frame
1552 function wfFormatStackFrame( $frame ) {
1553 if ( !isset( $frame['function'] ) ) {
1554 return 'NO_FUNCTION_GIVEN';
1556 return isset( $frame['class'] ) && isset( $frame['type'] ) ?
1557 $frame['class'] . $frame['type'] . $frame['function'] :
1561 /* Some generic result counters, pulled out of SearchEngine */
1566 * @param int $offset
1570 function wfShowingResults( $offset, $limit ) {
1571 return wfMessage( 'showingresults' )->numParams( $limit, $offset +
1 )->parse();
1575 * Whether the client accept gzip encoding
1577 * Uses the Accept-Encoding header to check if the client supports gzip encoding.
1578 * Use this when considering to send a gzip-encoded response to the client.
1580 * @param bool $force Forces another check even if we already have a cached result.
1583 function wfClientAcceptsGzip( $force = false ) {
1584 static $result = null;
1585 if ( $result === null ||
$force ) {
1587 if ( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
1588 # @todo FIXME: We may want to blacklist some broken browsers
1591 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
1592 $_SERVER['HTTP_ACCEPT_ENCODING'],
1596 if ( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
1600 wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
1609 * Escapes the given text so that it may be output using addWikiText()
1610 * without any linking, formatting, etc. making its way through. This
1611 * is achieved by substituting certain characters with HTML entities.
1612 * As required by the callers, "<nowiki>" is not used.
1614 * @param string $text Text to be escaped
1615 * @param-taint $text escapes_html
1618 function wfEscapeWikiText( $text ) {
1619 global $wgEnableMagicLinks;
1620 static $repl = null, $repl2 = null;
1621 if ( $repl === null ||
defined( 'MW_PARSER_TEST' ) ||
defined( 'MW_PHPUNIT_TEST' ) ) {
1622 // Tests depend upon being able to change $wgEnableMagicLinks, so don't cache
1623 // in those situations
1625 '"' => '"', '&' => '&', "'" => ''', '<' => '<',
1626 '=' => '=', '>' => '>', '[' => '[', ']' => ']',
1627 '{' => '{', '|' => '|', '}' => '}', ';' => ';',
1628 "\n#" => "\n#", "\r#" => "\r#",
1629 "\n*" => "\n*", "\r*" => "\r*",
1630 "\n:" => "\n:", "\r:" => "\r:",
1631 "\n " => "\n ", "\r " => "\r ",
1632 "\n\n" => "\n ", "\r\n" => " \n",
1633 "\n\r" => "\n ", "\r\r" => "\r ",
1634 "\n\t" => "\n	", "\r\t" => "\r	", // "\n\t\n" is treated like "\n\n"
1635 "\n----" => "\n----", "\r----" => "\r----",
1636 '__' => '__', '://' => '://',
1639 $magicLinks = array_keys( array_filter( $wgEnableMagicLinks ) );
1640 // We have to catch everything "\s" matches in PCRE
1641 foreach ( $magicLinks as $magic ) {
1642 $repl["$magic "] = "$magic ";
1643 $repl["$magic\t"] = "$magic	";
1644 $repl["$magic\r"] = "$magic ";
1645 $repl["$magic\n"] = "$magic ";
1646 $repl["$magic\f"] = "$magic";
1649 // And handle protocols that don't use "://"
1650 global $wgUrlProtocols;
1652 foreach ( $wgUrlProtocols as $prot ) {
1653 if ( substr( $prot, -1 ) === ':' ) {
1654 $repl2[] = preg_quote( substr( $prot, 0, -1 ), '/' );
1657 $repl2 = $repl2 ?
'/\b(' . implode( '|', $repl2 ) . '):/i' : '/^(?!)/';
1659 $text = substr( strtr( "\n$text", $repl ), 1 );
1660 $text = preg_replace( $repl2, '$1:', $text );
1665 * Sets dest to source and returns the original value of dest
1666 * If source is NULL, it just returns the value, it doesn't set the variable
1667 * If force is true, it will set the value even if source is NULL
1669 * @param mixed &$dest
1670 * @param mixed $source
1671 * @param bool $force
1674 function wfSetVar( &$dest, $source, $force = false ) {
1676 if ( !is_null( $source ) ||
$force ) {
1683 * As for wfSetVar except setting a bit
1687 * @param bool $state
1691 function wfSetBit( &$dest, $bit, $state = true ) {
1692 $temp = (bool)( $dest & $bit );
1693 if ( !is_null( $state ) ) {
1704 * A wrapper around the PHP function var_export().
1705 * Either print it or add it to the regular output ($wgOut).
1707 * @param mixed $var A PHP variable to dump.
1709 function wfVarDump( $var ) {
1711 $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
1712 if ( headers_sent() ||
!isset( $wgOut ) ||
!is_object( $wgOut ) ) {
1715 $wgOut->addHTML( $s );
1720 * Provide a simple HTTP error.
1722 * @param int|string $code
1723 * @param string $label
1724 * @param string $desc
1726 function wfHttpError( $code, $label, $desc ) {
1728 HttpStatus
::header( $code );
1731 $wgOut->sendCacheControl();
1734 MediaWiki\HeaderCallback
::warnIfHeadersSent();
1735 header( 'Content-type: text/html; charset=utf-8' );
1736 print '<!DOCTYPE html>' .
1737 '<html><head><title>' .
1738 htmlspecialchars( $label ) .
1739 '</title></head><body><h1>' .
1740 htmlspecialchars( $label ) .
1742 nl2br( htmlspecialchars( $desc ) ) .
1743 "</p></body></html>\n";
1747 * Clear away any user-level output buffers, discarding contents.
1749 * Suitable for 'starting afresh', for instance when streaming
1750 * relatively large amounts of data without buffering, or wanting to
1751 * output image files without ob_gzhandler's compression.
1753 * The optional $resetGzipEncoding parameter controls suppression of
1754 * the Content-Encoding header sent by ob_gzhandler; by default it
1755 * is left. See comments for wfClearOutputBuffers() for why it would
1758 * Note that some PHP configuration options may add output buffer
1759 * layers which cannot be removed; these are left in place.
1761 * @param bool $resetGzipEncoding
1763 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
1764 if ( $resetGzipEncoding ) {
1765 // Suppress Content-Encoding and Content-Length
1766 // headers from OutputHandler::handle.
1767 global $wgDisableOutputCompression;
1768 $wgDisableOutputCompression = true;
1770 while ( $status = ob_get_status() ) {
1771 if ( isset( $status['flags'] ) ) {
1772 $flags = PHP_OUTPUT_HANDLER_CLEANABLE | PHP_OUTPUT_HANDLER_REMOVABLE
;
1773 $deleteable = ( $status['flags'] & $flags ) === $flags;
1774 } elseif ( isset( $status['del'] ) ) {
1775 $deleteable = $status['del'];
1777 // Guess that any PHP-internal setting can't be removed.
1778 $deleteable = $status['type'] !== 0; /* PHP_OUTPUT_HANDLER_INTERNAL */
1780 if ( !$deleteable ) {
1781 // Give up, and hope the result doesn't break
1785 if ( $status['name'] === 'MediaWikiTestCase::wfResetOutputBuffersBarrier' ) {
1786 // Unit testing barrier to prevent this function from breaking PHPUnit.
1789 if ( !ob_end_clean() ) {
1790 // Could not remove output buffer handler; abort now
1791 // to avoid getting in some kind of infinite loop.
1794 if ( $resetGzipEncoding ) {
1795 if ( $status['name'] == 'ob_gzhandler' ) {
1796 // Reset the 'Content-Encoding' field set by this handler
1797 // so we can start fresh.
1798 header_remove( 'Content-Encoding' );
1806 * More legible than passing a 'false' parameter to wfResetOutputBuffers():
1808 * Clear away output buffers, but keep the Content-Encoding header
1809 * produced by ob_gzhandler, if any.
1811 * This should be used for HTTP 304 responses, where you need to
1812 * preserve the Content-Encoding header of the real result, but
1813 * also need to suppress the output of ob_gzhandler to keep to spec
1814 * and avoid breaking Firefox in rare cases where the headers and
1815 * body are broken over two packets.
1817 function wfClearOutputBuffers() {
1818 wfResetOutputBuffers( false );
1822 * Converts an Accept-* header into an array mapping string values to quality
1825 * @param string $accept
1826 * @param string $def Default
1827 * @return float[] Associative array of string => float pairs
1829 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
1830 # No arg means accept anything (per HTTP spec)
1832 return [ $def => 1.0 ];
1837 $parts = explode( ',', $accept );
1839 foreach ( $parts as $part ) {
1840 # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
1841 $values = explode( ';', trim( $part ) );
1843 if ( count( $values ) == 1 ) {
1844 $prefs[$values[0]] = 1.0;
1845 } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
1846 $prefs[$values[0]] = floatval( $match[1] );
1854 * Checks if a given MIME type matches any of the keys in the given
1855 * array. Basic wildcards are accepted in the array keys.
1857 * Returns the matching MIME type (or wildcard) if a match, otherwise
1860 * @param string $type
1861 * @param array $avail
1865 function mimeTypeMatch( $type, $avail ) {
1866 if ( array_key_exists( $type, $avail ) ) {
1869 $mainType = explode( '/', $type )[0];
1870 if ( array_key_exists( "$mainType/*", $avail ) ) {
1871 return "$mainType/*";
1872 } elseif ( array_key_exists( '*/*', $avail ) ) {
1881 * Returns the 'best' match between a client's requested internet media types
1882 * and the server's list of available types. Each list should be an associative
1883 * array of type to preference (preference is a float between 0.0 and 1.0).
1884 * Wildcards in the types are acceptable.
1886 * @param array $cprefs Client's acceptable type list
1887 * @param array $sprefs Server's offered types
1890 * @todo FIXME: Doesn't handle params like 'text/plain; charset=UTF-8'
1891 * XXX: generalize to negotiate other stuff
1893 function wfNegotiateType( $cprefs, $sprefs ) {
1896 foreach ( array_keys( $sprefs ) as $type ) {
1897 $subType = explode( '/', $type )[1];
1898 if ( $subType != '*' ) {
1899 $ckey = mimeTypeMatch( $type, $cprefs );
1901 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1906 foreach ( array_keys( $cprefs ) as $type ) {
1907 $subType = explode( '/', $type )[1];
1908 if ( $subType != '*' && !array_key_exists( $type, $sprefs ) ) {
1909 $skey = mimeTypeMatch( $type, $sprefs );
1911 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1919 foreach ( array_keys( $combine ) as $type ) {
1920 if ( $combine[$type] > $bestq ) {
1922 $bestq = $combine[$type];
1930 * Reference-counted warning suppression
1932 * @deprecated since 1.26, use Wikimedia\suppressWarnings() directly
1935 function wfSuppressWarnings( $end = false ) {
1936 Wikimedia\
suppressWarnings( $end );
1940 * @deprecated since 1.26, use Wikimedia\restoreWarnings() directly
1941 * Restore error level to previous value
1943 function wfRestoreWarnings() {
1944 Wikimedia\restoreWarnings
();
1948 * Get a timestamp string in one of various formats
1950 * @param mixed $outputtype A timestamp in one of the supported formats, the
1951 * function will autodetect which format is supplied and act accordingly.
1952 * @param mixed $ts Optional timestamp to convert, default 0 for the current time
1953 * @return string|bool String / false The same date in the format specified in $outputtype or false
1955 function wfTimestamp( $outputtype = TS_UNIX
, $ts = 0 ) {
1956 $ret = MWTimestamp
::convert( $outputtype, $ts );
1957 if ( $ret === false ) {
1958 wfDebug( "wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n" );
1964 * Return a formatted timestamp, or null if input is null.
1965 * For dealing with nullable timestamp columns in the database.
1967 * @param int $outputtype
1968 * @param string|null $ts
1971 function wfTimestampOrNull( $outputtype = TS_UNIX
, $ts = null ) {
1972 if ( is_null( $ts ) ) {
1975 return wfTimestamp( $outputtype, $ts );
1980 * Convenience function; returns MediaWiki timestamp for the present time.
1984 function wfTimestampNow() {
1986 return MWTimestamp
::now( TS_MW
);
1990 * Check if the operating system is Windows
1992 * @return bool True if it's Windows, false otherwise.
1994 function wfIsWindows() {
1995 static $isWindows = null;
1996 if ( $isWindows === null ) {
1997 $isWindows = strtoupper( substr( PHP_OS
, 0, 3 ) ) === 'WIN';
2003 * Check if we are running under HHVM
2007 function wfIsHHVM() {
2008 return defined( 'HHVM_VERSION' );
2012 * Check if we are running from the commandline
2017 function wfIsCLI() {
2018 return PHP_SAPI
=== 'cli' || PHP_SAPI
=== 'phpdbg';
2022 * Tries to get the system directory for temporary files. First
2023 * $wgTmpDirectory is checked, and then the TMPDIR, TMP, and TEMP
2024 * environment variables are then checked in sequence, then
2025 * sys_get_temp_dir(), then upload_tmp_dir from php.ini.
2027 * NOTE: When possible, use instead the tmpfile() function to create
2028 * temporary files to avoid race conditions on file creation, etc.
2032 function wfTempDir() {
2033 global $wgTmpDirectory;
2035 if ( $wgTmpDirectory !== false ) {
2036 return $wgTmpDirectory;
2039 return TempFSFile
::getUsableTempDirectory();
2043 * Make directory, and make all parent directories if they don't exist
2045 * @param string $dir Full path to directory to create
2046 * @param int|null $mode Chmod value to use, default is $wgDirectoryMode
2047 * @param string|null $caller Optional caller param for debugging.
2048 * @throws MWException
2051 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2052 global $wgDirectoryMode;
2054 if ( FileBackend
::isStoragePath( $dir ) ) { // sanity
2055 throw new MWException( __FUNCTION__
. " given storage path '$dir'." );
2058 if ( !is_null( $caller ) ) {
2059 wfDebug( "$caller: called wfMkdirParents($dir)\n" );
2062 if ( strval( $dir ) === '' ||
is_dir( $dir ) ) {
2066 $dir = str_replace( [ '\\', '/' ], DIRECTORY_SEPARATOR
, $dir );
2068 if ( is_null( $mode ) ) {
2069 $mode = $wgDirectoryMode;
2072 // Turn off the normal warning, we're doing our own below
2073 Wikimedia\
suppressWarnings();
2074 $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2075 Wikimedia\restoreWarnings
();
2078 // directory may have been created on another request since we last checked
2079 if ( is_dir( $dir ) ) {
2083 // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2084 wfLogWarning( sprintf( "failed to mkdir \"%s\" mode 0%o", $dir, $mode ) );
2090 * Remove a directory and all its content.
2091 * Does not hide error.
2092 * @param string $dir
2094 function wfRecursiveRemoveDir( $dir ) {
2095 wfDebug( __FUNCTION__
. "( $dir )\n" );
2096 // taken from https://secure.php.net/manual/en/function.rmdir.php#98622
2097 if ( is_dir( $dir ) ) {
2098 $objects = scandir( $dir );
2099 foreach ( $objects as $object ) {
2100 if ( $object != "." && $object != ".." ) {
2101 if ( filetype( $dir . '/' . $object ) == "dir" ) {
2102 wfRecursiveRemoveDir( $dir . '/' . $object );
2104 unlink( $dir . '/' . $object );
2114 * @param int $nr The number to format
2115 * @param int $acc The number of digits after the decimal point, default 2
2116 * @param bool $round Whether or not to round the value, default true
2119 function wfPercent( $nr, $acc = 2, $round = true ) {
2120 $ret = sprintf( "%.${acc}f", $nr );
2121 return $round ?
round( $ret, $acc ) . '%' : "$ret%";
2125 * Safety wrapper around ini_get() for boolean settings.
2126 * The values returned from ini_get() are pre-normalized for settings
2127 * set via php.ini or php_flag/php_admin_flag... but *not*
2128 * for those set via php_value/php_admin_value.
2130 * It's fairly common for people to use php_value instead of php_flag,
2131 * which can leave you with an 'off' setting giving a false positive
2132 * for code that just takes the ini_get() return value as a boolean.
2134 * To make things extra interesting, setting via php_value accepts
2135 * "true" and "yes" as true, but php.ini and php_flag consider them false. :)
2136 * Unrecognized values go false... again opposite PHP's own coercion
2137 * from string to bool.
2139 * Luckily, 'properly' set settings will always come back as '0' or '1',
2140 * so we only have to worry about them and the 'improper' settings.
2142 * I frickin' hate PHP... :P
2144 * @param string $setting
2147 function wfIniGetBool( $setting ) {
2148 return wfStringToBool( ini_get( $setting ) );
2152 * Convert string value to boolean, when the following are interpreted as true:
2156 * - Any number, except 0
2157 * All other strings are interpreted as false.
2159 * @param string $val
2163 function wfStringToBool( $val ) {
2164 $val = strtolower( $val );
2165 // 'on' and 'true' can't have whitespace around them, but '1' can.
2169 ||
preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2173 * Version of escapeshellarg() that works better on Windows.
2175 * Originally, this fixed the incorrect use of single quotes on Windows
2176 * (https://bugs.php.net/bug.php?id=26285) and the locale problems on Linux in
2177 * PHP 5.2.6+ (bug backported to earlier distro releases of PHP).
2179 * @param string $args,... strings to escape and glue together,
2180 * or a single array of strings parameter
2182 * @deprecated since 1.30 use MediaWiki\Shell::escape()
2184 function wfEscapeShellArg( /*...*/ ) {
2185 return Shell
::escape( ...func_get_args() );
2189 * Execute a shell command, with time and memory limits mirrored from the PHP
2190 * configuration if supported.
2192 * @param string|string[] $cmd If string, a properly shell-escaped command line,
2193 * or an array of unescaped arguments, in which case each value will be escaped
2194 * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
2195 * @param null|mixed &$retval Optional, will receive the program's exit code.
2196 * (non-zero is usually failure). If there is an error from
2197 * read, select, or proc_open(), this will be set to -1.
2198 * @param array $environ Optional environment variables which should be
2199 * added to the executed command environment.
2200 * @param array $limits Optional array with limits(filesize, memory, time, walltime)
2201 * this overwrites the global wgMaxShell* limits.
2202 * @param array $options Array of options:
2203 * - duplicateStderr: Set this to true to duplicate stderr to stdout,
2204 * including errors from limit.sh
2205 * - profileMethod: By default this function will profile based on the calling
2206 * method. Set this to a string for an alternative method to profile from
2208 * @return string Collected stdout as a string
2209 * @deprecated since 1.30 use class MediaWiki\Shell\Shell
2211 function wfShellExec( $cmd, &$retval = null, $environ = [],
2212 $limits = [], $options = []
2214 if ( Shell
::isDisabled() ) {
2216 // Backwards compatibility be upon us...
2217 return 'Unable to run external programs, proc_open() is disabled.';
2220 if ( is_array( $cmd ) ) {
2221 $cmd = Shell
::escape( $cmd );
2224 $includeStderr = isset( $options['duplicateStderr'] ) && $options['duplicateStderr'];
2225 $profileMethod = $options['profileMethod'] ??
wfGetCaller();
2228 $result = Shell
::command( [] )
2229 ->unsafeParams( (array)$cmd )
2230 ->environment( $environ )
2232 ->includeStderr( $includeStderr )
2233 ->profileMethod( $profileMethod )
2235 ->restrict( Shell
::RESTRICT_NONE
)
2237 } catch ( ProcOpenError
$ex ) {
2242 $retval = $result->getExitCode();
2244 return $result->getStdout();
2248 * Execute a shell command, returning both stdout and stderr. Convenience
2249 * function, as all the arguments to wfShellExec can become unwieldy.
2251 * @note This also includes errors from limit.sh, e.g. if $wgMaxShellFileSize is exceeded.
2252 * @param string|string[] $cmd If string, a properly shell-escaped command line,
2253 * or an array of unescaped arguments, in which case each value will be escaped
2254 * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
2255 * @param null|mixed &$retval Optional, will receive the program's exit code.
2256 * (non-zero is usually failure)
2257 * @param array $environ Optional environment variables which should be
2258 * added to the executed command environment.
2259 * @param array $limits Optional array with limits(filesize, memory, time, walltime)
2260 * this overwrites the global wgMaxShell* limits.
2261 * @return string Collected stdout and stderr as a string
2262 * @deprecated since 1.30 use class MediaWiki\Shell\Shell
2264 function wfShellExecWithStderr( $cmd, &$retval = null, $environ = [], $limits = [] ) {
2265 return wfShellExec( $cmd, $retval, $environ, $limits,
2266 [ 'duplicateStderr' => true, 'profileMethod' => wfGetCaller() ] );
2270 * Generate a shell-escaped command line string to run a MediaWiki cli script.
2271 * Note that $parameters should be a flat array and an option with an argument
2272 * should consist of two consecutive items in the array (do not use "--option value").
2274 * @deprecated since 1.31, use Shell::makeScriptCommand()
2276 * @param string $script MediaWiki cli script path
2277 * @param array $parameters Arguments and options to the script
2278 * @param array $options Associative array of options:
2279 * 'php': The path to the php executable
2280 * 'wrapper': Path to a PHP wrapper to handle the maintenance script
2283 function wfShellWikiCmd( $script, array $parameters = [], array $options = [] ) {
2285 // Give site config file a chance to run the script in a wrapper.
2286 // The caller may likely want to call wfBasename() on $script.
2287 Hooks
::run( 'wfShellWikiCmd', [ &$script, &$parameters, &$options ] );
2288 $cmd = [ $options['php'] ??
$wgPhpCli ];
2289 if ( isset( $options['wrapper'] ) ) {
2290 $cmd[] = $options['wrapper'];
2293 // Escape each parameter for shell
2294 return Shell
::escape( array_merge( $cmd, $parameters ) );
2298 * wfMerge attempts to merge differences between three texts.
2299 * Returns true for a clean merge and false for failure or a conflict.
2301 * @param string $old
2302 * @param string $mine
2303 * @param string $yours
2304 * @param string &$result
2305 * @param string|null &$mergeAttemptResult
2308 function wfMerge( $old, $mine, $yours, &$result, &$mergeAttemptResult = null ) {
2311 # This check may also protect against code injection in
2312 # case of broken installations.
2313 Wikimedia\
suppressWarnings();
2314 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
2315 Wikimedia\restoreWarnings
();
2317 if ( !$haveDiff3 ) {
2318 wfDebug( "diff3 not found\n" );
2322 # Make temporary files
2324 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2325 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
2326 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
2328 # NOTE: diff3 issues a warning to stderr if any of the files does not end with
2329 # a newline character. To avoid this, we normalize the trailing whitespace before
2330 # creating the diff.
2332 fwrite( $oldtextFile, rtrim( $old ) . "\n" );
2333 fclose( $oldtextFile );
2334 fwrite( $mytextFile, rtrim( $mine ) . "\n" );
2335 fclose( $mytextFile );
2336 fwrite( $yourtextFile, rtrim( $yours ) . "\n" );
2337 fclose( $yourtextFile );
2339 # Check for a conflict
2340 $cmd = Shell
::escape( $wgDiff3, '-a', '--overlap-only', $mytextName,
2341 $oldtextName, $yourtextName );
2342 $handle = popen( $cmd, 'r' );
2344 $mergeAttemptResult = '';
2346 $data = fread( $handle, 8192 );
2347 if ( strlen( $data ) == 0 ) {
2350 $mergeAttemptResult .= $data;
2354 $conflict = $mergeAttemptResult !== '';
2357 $cmd = Shell
::escape( $wgDiff3, '-a', '-e', '--merge', $mytextName,
2358 $oldtextName, $yourtextName );
2359 $handle = popen( $cmd, 'r' );
2362 $data = fread( $handle, 8192 );
2363 if ( strlen( $data ) == 0 ) {
2369 unlink( $mytextName );
2370 unlink( $oldtextName );
2371 unlink( $yourtextName );
2373 if ( $result === '' && $old !== '' && !$conflict ) {
2374 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
2381 * Returns unified plain-text diff of two texts.
2382 * "Useful" for machine processing of diffs.
2384 * @deprecated since 1.25, use DiffEngine/UnifiedDiffFormatter directly
2386 * @param string $before The text before the changes.
2387 * @param string $after The text after the changes.
2388 * @param string $params Command-line options for the diff command.
2389 * @return string Unified diff of $before and $after
2391 function wfDiff( $before, $after, $params = '-u' ) {
2392 if ( $before == $after ) {
2397 Wikimedia\
suppressWarnings();
2398 $haveDiff = $wgDiff && file_exists( $wgDiff );
2399 Wikimedia\restoreWarnings
();
2401 # This check may also protect against code injection in
2402 # case of broken installations.
2404 wfDebug( "diff executable not found\n" );
2405 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
2406 $format = new UnifiedDiffFormatter();
2407 return $format->format( $diffs );
2410 # Make temporary files
2412 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2413 $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
2415 fwrite( $oldtextFile, $before );
2416 fclose( $oldtextFile );
2417 fwrite( $newtextFile, $after );
2418 fclose( $newtextFile );
2420 // Get the diff of the two files
2421 $cmd = "$wgDiff " . $params . ' ' . Shell
::escape( $oldtextName, $newtextName );
2423 $h = popen( $cmd, 'r' );
2425 unlink( $oldtextName );
2426 unlink( $newtextName );
2427 throw new Exception( __METHOD__
. '(): popen() failed' );
2433 $data = fread( $h, 8192 );
2434 if ( strlen( $data ) == 0 ) {
2442 unlink( $oldtextName );
2443 unlink( $newtextName );
2445 // Kill the --- and +++ lines. They're not useful.
2446 $diff_lines = explode( "\n", $diff );
2447 if ( isset( $diff_lines[0] ) && strpos( $diff_lines[0], '---' ) === 0 ) {
2448 unset( $diff_lines[0] );
2450 if ( isset( $diff_lines[1] ) && strpos( $diff_lines[1], '+++' ) === 0 ) {
2451 unset( $diff_lines[1] );
2454 $diff = implode( "\n", $diff_lines );
2460 * This function works like "use VERSION" in Perl, the program will die with a
2461 * backtrace if the current version of PHP is less than the version provided
2463 * This is useful for extensions which due to their nature are not kept in sync
2464 * with releases, and might depend on other versions of PHP than the main code
2466 * Note: PHP might die due to parsing errors in some cases before it ever
2467 * manages to call this function, such is life
2469 * @see perldoc -f use
2471 * @param string|int|float $req_ver The version to check, can be a string, an integer, or a float
2473 * @deprecated since 1.30
2475 * @throws MWException
2477 function wfUsePHP( $req_ver ) {
2478 wfDeprecated( __FUNCTION__
, '1.30' );
2479 $php_ver = PHP_VERSION
;
2481 if ( version_compare( $php_ver, (string)$req_ver, '<' ) ) {
2482 throw new MWException( "PHP $req_ver required--this is only $php_ver" );
2487 * Return the final portion of a pathname.
2488 * Reimplemented because PHP5's "basename()" is buggy with multibyte text.
2489 * https://bugs.php.net/bug.php?id=33898
2491 * PHP's basename() only considers '\' a pathchar on Windows and Netware.
2492 * We'll consider it so always, as we don't want '\s' in our Unix paths either.
2494 * @param string $path
2495 * @param string $suffix String to remove if present
2498 function wfBaseName( $path, $suffix = '' ) {
2499 if ( $suffix == '' ) {
2502 $encSuffix = '(?:' . preg_quote( $suffix, '#' ) . ')?';
2506 if ( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
2514 * Generate a relative path name to the given file.
2515 * May explode on non-matching case-insensitive paths,
2516 * funky symlinks, etc.
2518 * @param string $path Absolute destination path including target filename
2519 * @param string $from Absolute source path, directory only
2522 function wfRelativePath( $path, $from ) {
2523 // Normalize mixed input on Windows...
2524 $path = str_replace( '/', DIRECTORY_SEPARATOR
, $path );
2525 $from = str_replace( '/', DIRECTORY_SEPARATOR
, $from );
2527 // Trim trailing slashes -- fix for drive root
2528 $path = rtrim( $path, DIRECTORY_SEPARATOR
);
2529 $from = rtrim( $from, DIRECTORY_SEPARATOR
);
2531 $pieces = explode( DIRECTORY_SEPARATOR
, dirname( $path ) );
2532 $against = explode( DIRECTORY_SEPARATOR
, $from );
2534 if ( $pieces[0] !== $against[0] ) {
2535 // Non-matching Windows drive letters?
2536 // Return a full path.
2540 // Trim off common prefix
2541 while ( count( $pieces ) && count( $against )
2542 && $pieces[0] == $against[0] ) {
2543 array_shift( $pieces );
2544 array_shift( $against );
2547 // relative dots to bump us to the parent
2548 while ( count( $against ) ) {
2549 array_unshift( $pieces, '..' );
2550 array_shift( $against );
2553 array_push( $pieces, wfBaseName( $path ) );
2555 return implode( DIRECTORY_SEPARATOR
, $pieces );
2559 * Reset the session id
2561 * @deprecated since 1.27, use MediaWiki\Session\SessionManager instead
2564 function wfResetSessionID() {
2565 wfDeprecated( __FUNCTION__
, '1.27' );
2566 $session = SessionManager
::getGlobalSession();
2567 $delay = $session->delaySave();
2569 $session->resetId();
2571 // Make sure a session is started, since that's what the old
2572 // wfResetSessionID() did.
2573 if ( session_id() !== $session->getId() ) {
2574 wfSetupSession( $session->getId() );
2577 ScopedCallback
::consume( $delay );
2581 * Initialise php session
2583 * @deprecated since 1.27, use MediaWiki\Session\SessionManager instead.
2584 * Generally, "using" SessionManager will be calling ->getSessionById() or
2585 * ::getGlobalSession() (depending on whether you were passing $sessionId
2586 * here), then calling $session->persist().
2587 * @param bool|string $sessionId
2589 function wfSetupSession( $sessionId = false ) {
2590 wfDeprecated( __FUNCTION__
, '1.27' );
2593 session_id( $sessionId );
2596 $session = SessionManager
::getGlobalSession();
2597 $session->persist();
2599 if ( session_id() !== $session->getId() ) {
2600 session_id( $session->getId() );
2602 Wikimedia\
quietCall( 'session_start' );
2606 * Get an object from the precompiled serialized directory
2608 * @param string $name
2609 * @return mixed The variable on success, false on failure
2611 function wfGetPrecompiledData( $name ) {
2614 $file = "$IP/serialized/$name";
2615 if ( file_exists( $file ) ) {
2616 $blob = file_get_contents( $file );
2618 return unserialize( $blob );
2625 * Make a cache key for the local wiki.
2627 * @deprecated since 1.30 Call makeKey on a BagOStuff instance
2628 * @param string $args,...
2631 function wfMemcKey( /*...*/ ) {
2632 return ObjectCache
::getLocalClusterInstance()->makeKey( ...func_get_args() );
2636 * Make a cache key for a foreign DB.
2638 * Must match what wfMemcKey() would produce in context of the foreign wiki.
2641 * @param string $prefix
2642 * @param string $args,...
2645 function wfForeignMemcKey( $db, $prefix /*...*/ ) {
2646 $args = array_slice( func_get_args(), 2 );
2647 $keyspace = $prefix ?
"$db-$prefix" : $db;
2648 return ObjectCache
::getLocalClusterInstance()->makeKeyInternal( $keyspace, $args );
2652 * Make a cache key with database-agnostic prefix.
2654 * Doesn't have a wiki-specific namespace. Uses a generic 'global' prefix
2655 * instead. Must have a prefix as otherwise keys that use a database name
2656 * in the first segment will clash with wfMemcKey/wfForeignMemcKey.
2658 * @deprecated since 1.30 Call makeGlobalKey on a BagOStuff instance
2660 * @param string $args,...
2663 function wfGlobalCacheKey( /*...*/ ) {
2664 return ObjectCache
::getLocalClusterInstance()->makeGlobalKey( ...func_get_args() );
2668 * Get an ASCII string identifying this wiki
2669 * This is used as a prefix in memcached keys
2673 function wfWikiID() {
2674 global $wgDBprefix, $wgDBname;
2675 if ( $wgDBprefix ) {
2676 return "$wgDBname-$wgDBprefix";
2683 * Split a wiki ID into DB name and table prefix
2685 * @param string $wiki
2689 function wfSplitWikiID( $wiki ) {
2690 $bits = explode( '-', $wiki, 2 );
2691 if ( count( $bits ) < 2 ) {
2698 * Get a Database object.
2700 * @param int $db Index of the connection to get. May be DB_MASTER for the
2701 * master (for write queries), DB_REPLICA for potentially lagged read
2702 * queries, or an integer >= 0 for a particular server.
2704 * @param string|string[] $groups Query groups. An array of group names that this query
2705 * belongs to. May contain a single string if the query is only
2708 * @param string|bool $wiki The wiki ID, or false for the current wiki
2710 * Note: multiple calls to wfGetDB(DB_REPLICA) during the course of one request
2711 * will always return the same object, unless the underlying connection or load
2712 * balancer is manually destroyed.
2714 * Note 2: use $this->getDB() in maintenance scripts that may be invoked by
2715 * updater to ensure that a proper database is being updated.
2717 * @todo Replace calls to wfGetDB with calls to LoadBalancer::getConnection()
2718 * on an injected instance of LoadBalancer.
2720 * @return \Wikimedia\Rdbms\Database
2722 function wfGetDB( $db, $groups = [], $wiki = false ) {
2723 return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
2727 * Get a load balancer object.
2729 * @deprecated since 1.27, use MediaWikiServices::getDBLoadBalancer()
2730 * or MediaWikiServices::getDBLoadBalancerFactory() instead.
2732 * @param string|bool $wiki Wiki ID, or false for the current wiki
2733 * @return \Wikimedia\Rdbms\LoadBalancer
2735 function wfGetLB( $wiki = false ) {
2736 if ( $wiki === false ) {
2737 return MediaWikiServices
::getInstance()->getDBLoadBalancer();
2739 $factory = MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
2740 return $factory->getMainLB( $wiki );
2745 * Get the load balancer factory object
2747 * @deprecated since 1.27, use MediaWikiServices::getDBLoadBalancerFactory() instead.
2749 * @return \Wikimedia\Rdbms\LBFactory
2751 function wfGetLBFactory() {
2752 return MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
2757 * Shortcut for RepoGroup::singleton()->findFile()
2759 * @param string|Title $title String or Title object
2760 * @param array $options Associative array of options (see RepoGroup::findFile)
2761 * @return File|bool File, or false if the file does not exist
2763 function wfFindFile( $title, $options = [] ) {
2764 return RepoGroup
::singleton()->findFile( $title, $options );
2768 * Get an object referring to a locally registered file.
2769 * Returns a valid placeholder object if the file does not exist.
2771 * @param Title|string $title
2772 * @return LocalFile|null A File, or null if passed an invalid Title
2774 function wfLocalFile( $title ) {
2775 return RepoGroup
::singleton()->getLocalRepo()->newFile( $title );
2779 * Should low-performance queries be disabled?
2782 * @codeCoverageIgnore
2784 function wfQueriesMustScale() {
2785 global $wgMiserMode;
2787 ||
( SiteStats
::pages() > 100000
2788 && SiteStats
::edits() > 1000000
2789 && SiteStats
::users() > 10000 );
2793 * Get the path to a specified script file, respecting file
2794 * extensions; this is a wrapper around $wgScriptPath etc.
2795 * except for 'index' and 'load' which use $wgScript/$wgLoadScript
2797 * @param string $script Script filename, sans extension
2800 function wfScript( $script = 'index' ) {
2801 global $wgScriptPath, $wgScript, $wgLoadScript;
2802 if ( $script === 'index' ) {
2804 } elseif ( $script === 'load' ) {
2805 return $wgLoadScript;
2807 return "{$wgScriptPath}/{$script}.php";
2812 * Get the script URL.
2814 * @return string Script URL
2816 function wfGetScriptUrl() {
2817 if ( isset( $_SERVER['SCRIPT_NAME'] ) ) {
2818 /* as it was called, minus the query string.
2820 * Some sites use Apache rewrite rules to handle subdomains,
2821 * and have PHP set up in a weird way that causes PHP_SELF
2822 * to contain the rewritten URL instead of the one that the
2823 * outside world sees.
2825 * If in this mode, use SCRIPT_URL instead, which mod_rewrite
2826 * provides containing the "before" URL.
2828 return $_SERVER['SCRIPT_NAME'];
2830 return $_SERVER['URL'];
2835 * Convenience function converts boolean values into "true"
2836 * or "false" (string) values
2838 * @param bool $value
2841 function wfBoolToStr( $value ) {
2842 return $value ?
'true' : 'false';
2846 * Get a platform-independent path to the null file, e.g. /dev/null
2850 function wfGetNull() {
2851 return wfIsWindows() ?
'NUL' : '/dev/null';
2855 * Waits for the replica DBs to catch up to the master position
2857 * Use this when updating very large numbers of rows, as in maintenance scripts,
2858 * to avoid causing too much lag. Of course, this is a no-op if there are no replica DBs.
2860 * By default this waits on the main DB cluster of the current wiki.
2861 * If $cluster is set to "*" it will wait on all DB clusters, including
2862 * external ones. If the lag being waiting on is caused by the code that
2863 * does this check, it makes since to use $ifWritesSince, particularly if
2864 * cluster is "*", to avoid excess overhead.
2866 * Never call this function after a big DB write that is still in a transaction.
2867 * This only makes sense after the possible lag inducing changes were committed.
2869 * @param float|null $ifWritesSince Only wait if writes were done since this UNIX timestamp
2870 * @param string|bool $wiki Wiki identifier accepted by wfGetLB
2871 * @param string|bool $cluster Cluster name accepted by LBFactory. Default: false.
2872 * @param int|null $timeout Max wait time. Default: 60 seconds (cli), 1 second (web)
2873 * @return bool Success (able to connect and no timeouts reached)
2874 * @deprecated since 1.27 Use LBFactory::waitForReplication
2876 function wfWaitForSlaves(
2877 $ifWritesSince = null, $wiki = false, $cluster = false, $timeout = null
2879 if ( $cluster === '*' ) {
2882 } elseif ( $wiki === false ) {
2888 'cluster' => $cluster,
2889 // B/C: first argument used to be "max seconds of lag"; ignore such values
2890 'ifWritesSince' => ( $ifWritesSince > 1e9
) ?
$ifWritesSince : null
2892 if ( $timeout !== null ) {
2893 $opts['timeout'] = $timeout;
2896 $lbFactory = MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
2897 return $lbFactory->waitForReplication( $opts );
2901 * Count down from $seconds to zero on the terminal, with a one-second pause
2902 * between showing each number. For use in command-line scripts.
2904 * @deprecated since 1.31, use Maintenance::countDown()
2906 * @codeCoverageIgnore
2907 * @param int $seconds
2909 function wfCountDown( $seconds ) {
2910 wfDeprecated( __FUNCTION__
, '1.31' );
2911 for ( $i = $seconds; $i >= 0; $i-- ) {
2912 if ( $i != $seconds ) {
2913 echo str_repeat( "\x08", strlen( $i +
1 ) );
2925 * Replace all invalid characters with '-'.
2926 * Additional characters can be defined in $wgIllegalFileChars (see T22489).
2927 * By default, $wgIllegalFileChars includes ':', '/', '\'.
2929 * @param string $name Filename to process
2932 function wfStripIllegalFilenameChars( $name ) {
2933 global $wgIllegalFileChars;
2934 $illegalFileChars = $wgIllegalFileChars ?
"|[" . $wgIllegalFileChars . "]" : '';
2935 $name = preg_replace(
2936 "/[^" . Title
::legalChars() . "]" . $illegalFileChars . "/",
2940 // $wgIllegalFileChars may not include '/' and '\', so we still need to do this
2941 $name = wfBaseName( $name );
2946 * Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit
2948 * @return int Resulting value of the memory limit.
2950 function wfMemoryLimit() {
2951 global $wgMemoryLimit;
2952 $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
2953 if ( $memlimit != -1 ) {
2954 $conflimit = wfShorthandToInteger( $wgMemoryLimit );
2955 if ( $conflimit == -1 ) {
2956 wfDebug( "Removing PHP's memory limit\n" );
2957 Wikimedia\
suppressWarnings();
2958 ini_set( 'memory_limit', $conflimit );
2959 Wikimedia\restoreWarnings
();
2961 } elseif ( $conflimit > $memlimit ) {
2962 wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
2963 Wikimedia\
suppressWarnings();
2964 ini_set( 'memory_limit', $conflimit );
2965 Wikimedia\restoreWarnings
();
2973 * Set PHP's time limit to the larger of php.ini or $wgTransactionalTimeLimit
2975 * @return int Prior time limit
2978 function wfTransactionalTimeLimit() {
2979 global $wgTransactionalTimeLimit;
2981 $timeLimit = ini_get( 'max_execution_time' );
2982 // Note that CLI scripts use 0
2983 if ( $timeLimit > 0 && $wgTransactionalTimeLimit > $timeLimit ) {
2984 set_time_limit( $wgTransactionalTimeLimit );
2987 ignore_user_abort( true ); // ignore client disconnects
2993 * Converts shorthand byte notation to integer form
2995 * @param string $string
2996 * @param int $default Returned if $string is empty
2999 function wfShorthandToInteger( $string = '', $default = -1 ) {
3000 $string = trim( $string );
3001 if ( $string === '' ) {
3004 $last = $string[strlen( $string ) - 1];
3005 $val = intval( $string );
3010 // break intentionally missing
3014 // break intentionally missing
3024 * Get the normalised IETF language tag
3025 * See unit test for examples.
3026 * See mediawiki.language.bcp47 for the JavaScript implementation.
3028 * @deprecated since 1.31, use LanguageCode::bcp47() directly.
3030 * @param string $code The language code.
3031 * @return string The language code which complying with BCP 47 standards.
3033 function wfBCP47( $code ) {
3034 wfDeprecated( __METHOD__
, '1.31' );
3035 return LanguageCode
::bcp47( $code );
3039 * Get a specific cache object.
3041 * @deprecated since 1.32, use ObjectCache::getInstance() instead
3042 * @param int|string $cacheType A CACHE_* constants, or other key in $wgObjectCaches
3045 function wfGetCache( $cacheType ) {
3046 return ObjectCache
::getInstance( $cacheType );
3050 * Get the main cache object
3052 * @deprecated since 1.32, use ObjectCache::getLocalClusterInstance() instead
3055 function wfGetMainCache() {
3056 return ObjectCache
::getLocalClusterInstance();
3060 * Get the cache object used by the message cache
3064 function wfGetMessageCacheStorage() {
3065 global $wgMessageCacheType;
3066 return ObjectCache
::getInstance( $wgMessageCacheType );
3070 * Call hook functions defined in $wgHooks
3072 * @param string $event Event name
3073 * @param array $args Parameters passed to hook functions
3074 * @param string|null $deprecatedVersion Optionally mark hook as deprecated with version number
3076 * @return bool True if no handler aborted the hook
3077 * @deprecated since 1.25 - use Hooks::run
3079 function wfRunHooks( $event, array $args = [], $deprecatedVersion = null ) {
3080 wfDeprecated( __METHOD__
, '1.25' );
3081 return Hooks
::run( $event, $args, $deprecatedVersion );
3085 * Wrapper around php's unpack.
3087 * @param string $format The format string (See php's docs)
3088 * @param string $data A binary string of binary data
3089 * @param int|bool $length The minimum length of $data or false. This is to
3090 * prevent reading beyond the end of $data. false to disable the check.
3092 * Also be careful when using this function to read unsigned 32 bit integer
3093 * because php might make it negative.
3095 * @throws MWException If $data not long enough, or if unpack fails
3096 * @return array Associative array of the extracted data
3098 function wfUnpack( $format, $data, $length = false ) {
3099 if ( $length !== false ) {
3100 $realLen = strlen( $data );
3101 if ( $realLen < $length ) {
3102 throw new MWException( "Tried to use wfUnpack on a "
3103 . "string of length $realLen, but needed one "
3104 . "of at least length $length."
3109 Wikimedia\
suppressWarnings();
3110 $result = unpack( $format, $data );
3111 Wikimedia\restoreWarnings
();
3113 if ( $result === false ) {
3114 // If it cannot extract the packed data.
3115 throw new MWException( "unpack could not unpack binary data" );
3121 * Determine if an image exists on the 'bad image list'.
3123 * The format of MediaWiki:Bad_image_list is as follows:
3124 * * Only list items (lines starting with "*") are considered
3125 * * The first link on a line must be a link to a bad image
3126 * * Any subsequent links on the same line are considered to be exceptions,
3127 * i.e. articles where the image may occur inline.
3129 * @param string $name The image name to check
3130 * @param Title|bool $contextTitle The page on which the image occurs, if known
3131 * @param string|null $blacklist Wikitext of a file blacklist
3134 function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
3135 # Handle redirects; callers almost always hit wfFindFile() anyway,
3136 # so just use that method because it has a fast process cache.
3137 $file = wfFindFile( $name ); // get the final name
3138 $name = $file ?
$file->getTitle()->getDBkey() : $name;
3140 # Run the extension hook
3142 if ( !Hooks
::run( 'BadImage', [ $name, &$bad ] ) ) {
3146 $cache = ObjectCache
::getLocalServerInstance( 'hash' );
3147 $key = $cache->makeKey(
3148 'bad-image-list', ( $blacklist === null ) ?
'default' : md5( $blacklist )
3150 $badImages = $cache->get( $key );
3152 if ( $badImages === false ) { // cache miss
3153 if ( $blacklist === null ) {
3154 $blacklist = wfMessage( 'bad_image_list' )->inContentLanguage()->plain(); // site list
3156 # Build the list now
3158 $lines = explode( "\n", $blacklist );
3159 foreach ( $lines as $line ) {
3161 if ( substr( $line, 0, 1 ) !== '*' ) {
3167 if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
3172 $imageDBkey = false;
3173 foreach ( $m[1] as $i => $titleText ) {
3174 $title = Title
::newFromText( $titleText );
3175 if ( !is_null( $title ) ) {
3177 $imageDBkey = $title->getDBkey();
3179 $exceptions[$title->getPrefixedDBkey()] = true;
3184 if ( $imageDBkey !== false ) {
3185 $badImages[$imageDBkey] = $exceptions;
3188 $cache->set( $key, $badImages, 60 );
3191 $contextKey = $contextTitle ?
$contextTitle->getPrefixedDBkey() : false;
3192 $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
3198 * Determine whether the client at a given source IP is likely to be able to
3199 * access the wiki via HTTPS.
3201 * @param string $ip The IPv4/6 address in the normal human-readable form
3204 function wfCanIPUseHTTPS( $ip ) {
3206 Hooks
::run( 'CanIPUseHTTPS', [ $ip, &$canDo ] );
3211 * Determine input string is represents as infinity
3213 * @param string $str The string to determine
3217 function wfIsInfinity( $str ) {
3218 // These are hardcoded elsewhere in MediaWiki (e.g. mediawiki.special.block.js).
3219 $infinityValues = [ 'infinite', 'indefinite', 'infinity', 'never' ];
3220 return in_array( $str, $infinityValues );
3224 * Returns true if these thumbnail parameters match one that MediaWiki
3225 * requests from file description pages and/or parser output.
3227 * $params is considered non-standard if they involve a non-standard
3228 * width or any non-default parameters aside from width and page number.
3229 * The number of possible files with standard parameters is far less than
3230 * that of all combinations; rate-limiting for them can thus be more generious.
3233 * @param array $params
3235 * @since 1.24 Moved from thumb.php to GlobalFunctions in 1.25
3237 function wfThumbIsStandard( File
$file, array $params ) {
3238 global $wgThumbLimits, $wgImageLimits, $wgResponsiveImages;
3240 $multipliers = [ 1 ];
3241 if ( $wgResponsiveImages ) {
3242 // These available sizes are hardcoded currently elsewhere in MediaWiki.
3243 // @see Linker::processResponsiveImages
3244 $multipliers[] = 1.5;
3248 $handler = $file->getHandler();
3249 if ( !$handler ||
!isset( $params['width'] ) ) {
3254 if ( isset( $params['page'] ) ) {
3255 $basicParams['page'] = $params['page'];
3260 // Expand limits to account for multipliers
3261 foreach ( $multipliers as $multiplier ) {
3262 $thumbLimits = array_merge( $thumbLimits, array_map(
3263 function ( $width ) use ( $multiplier ) {
3264 return round( $width * $multiplier );
3267 $imageLimits = array_merge( $imageLimits, array_map(
3268 function ( $pair ) use ( $multiplier ) {
3270 round( $pair[0] * $multiplier ),
3271 round( $pair[1] * $multiplier ),
3277 // Check if the width matches one of $wgThumbLimits
3278 if ( in_array( $params['width'], $thumbLimits ) ) {
3279 $normalParams = $basicParams +
[ 'width' => $params['width'] ];
3280 // Append any default values to the map (e.g. "lossy", "lossless", ...)
3281 $handler->normaliseParams( $file, $normalParams );
3283 // If not, then check if the width matchs one of $wgImageLimits
3285 foreach ( $imageLimits as $pair ) {
3286 $normalParams = $basicParams +
[ 'width' => $pair[0], 'height' => $pair[1] ];
3287 // Decide whether the thumbnail should be scaled on width or height.
3288 // Also append any default values to the map (e.g. "lossy", "lossless", ...)
3289 $handler->normaliseParams( $file, $normalParams );
3290 // Check if this standard thumbnail size maps to the given width
3291 if ( $normalParams['width'] == $params['width'] ) {
3297 return false; // not standard for description pages
3301 // Check that the given values for non-page, non-width, params are just defaults
3302 foreach ( $params as $key => $value ) {
3303 if ( !isset( $normalParams[$key] ) ||
$normalParams[$key] != $value ) {
3312 * Merges two (possibly) 2 dimensional arrays into the target array ($baseArray).
3314 * Values that exist in both values will be combined with += (all values of the array
3315 * of $newValues will be added to the values of the array of $baseArray, while values,
3316 * that exists in both, the value of $baseArray will be used).
3318 * @param array $baseArray The array where you want to add the values of $newValues to
3319 * @param array $newValues An array with new values
3320 * @return array The combined array
3323 function wfArrayPlus2d( array $baseArray, array $newValues ) {
3324 // First merge items that are in both arrays
3325 foreach ( $baseArray as $name => &$groupVal ) {
3326 if ( isset( $newValues[$name] ) ) {
3327 $groupVal +
= $newValues[$name];
3330 // Now add items that didn't exist yet
3331 $baseArray +
= $newValues;
3337 * Get system resource usage of current request context.
3338 * Invokes the getrusage(2) system call, requesting RUSAGE_SELF if on PHP5
3339 * or RUSAGE_THREAD if on HHVM. Returns false if getrusage is not available.
3342 * @return array|bool Resource usage data or false if no data available.
3344 function wfGetRusage() {
3345 if ( !function_exists( 'getrusage' ) ) {
3347 } elseif ( defined( 'HHVM_VERSION' ) && PHP_OS
=== 'Linux' ) {
3348 return getrusage( 2 /* RUSAGE_THREAD */ );
3350 return getrusage( 0 /* RUSAGE_SELF */ );