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\Rdbms\DBReplicationWaitError
;
34 use Wikimedia\WrappedString
;
39 * This queues an extension to be loaded through
40 * the ExtensionRegistry system.
42 * @param string $ext Name of the extension to load
43 * @param string|null $path Absolute path of where to find the extension.json file
46 function wfLoadExtension( $ext, $path = null ) {
48 global $wgExtensionDirectory;
49 $path = "$wgExtensionDirectory/$ext/extension.json";
51 ExtensionRegistry
::getInstance()->queue( $path );
55 * Load multiple extensions at once
57 * Same as wfLoadExtension, but more efficient if you
58 * are loading multiple extensions.
60 * If you want to specify custom paths, you should interact with
61 * ExtensionRegistry directly.
63 * @see wfLoadExtension
64 * @param string[] $exts Array of extension names to load
67 function wfLoadExtensions( array $exts ) {
68 global $wgExtensionDirectory;
69 $registry = ExtensionRegistry
::getInstance();
70 foreach ( $exts as $ext ) {
71 $registry->queue( "$wgExtensionDirectory/$ext/extension.json" );
78 * @see wfLoadExtension
79 * @param string $skin Name of the extension to load
80 * @param string|null $path Absolute path of where to find the skin.json file
83 function wfLoadSkin( $skin, $path = null ) {
85 global $wgStyleDirectory;
86 $path = "$wgStyleDirectory/$skin/skin.json";
88 ExtensionRegistry
::getInstance()->queue( $path );
92 * Load multiple skins at once
94 * @see wfLoadExtensions
95 * @param string[] $skins Array of extension names to load
98 function wfLoadSkins( array $skins ) {
99 global $wgStyleDirectory;
100 $registry = ExtensionRegistry
::getInstance();
101 foreach ( $skins as $skin ) {
102 $registry->queue( "$wgStyleDirectory/$skin/skin.json" );
107 * Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
112 function wfArrayDiff2( $a, $b ) {
113 return array_udiff( $a, $b, 'wfArrayDiff2_cmp' );
117 * @param array|string $a
118 * @param array|string $b
121 function wfArrayDiff2_cmp( $a, $b ) {
122 if ( is_string( $a ) && is_string( $b ) ) {
123 return strcmp( $a, $b );
124 } elseif ( count( $a ) !== count( $b ) ) {
125 return count( $a ) <=> count( $b );
129 while ( key( $a ) !== null && key( $b ) !== null ) {
130 $valueA = current( $a );
131 $valueB = current( $b );
132 $cmp = strcmp( $valueA, $valueB );
144 * @deprecated since 1.32, use array_filter() with ARRAY_FILTER_USE_BOTH directly
147 * @param callable $callback Will be called with the array value and key (in that order) and
148 * should return a bool which will determine whether the array element is kept.
151 function wfArrayFilter( array $arr, callable
$callback ) {
152 return array_filter( $arr, $callback, ARRAY_FILTER_USE_BOTH
);
156 * @deprecated since 1.32, use array_filter() with ARRAY_FILTER_USE_KEY directly
159 * @param callable $callback Will be called with the array key and should return a bool which
160 * will determine whether the array element is kept.
163 function wfArrayFilterByKey( array $arr, callable
$callback ) {
164 return array_filter( $arr, $callback, ARRAY_FILTER_USE_KEY
);
168 * Appends to second array if $value differs from that in $default
170 * @param string|int $key
171 * @param mixed $value
172 * @param mixed $default
173 * @param array &$changed Array to alter
174 * @throws MWException
176 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
177 if ( is_null( $changed ) ) {
178 throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' );
180 if ( $default[$key] !== $value ) {
181 $changed[$key] = $value;
186 * Merge arrays in the style of getUserPermissionsErrors, with duplicate removal
188 * wfMergeErrorArrays(
201 * @param array $array1,...
204 function wfMergeErrorArrays( /*...*/ ) {
205 $args = func_get_args();
207 foreach ( $args as $errors ) {
208 foreach ( $errors as $params ) {
209 $originalParams = $params;
210 if ( $params[0] instanceof MessageSpecifier
) {
212 $params = array_merge( [ $msg->getKey() ], $msg->getParams() );
214 # @todo FIXME: Sometimes get nested arrays for $params,
215 # which leads to E_NOTICEs
216 $spec = implode( "\t", $params );
217 $out[$spec] = $originalParams;
220 return array_values( $out );
224 * Insert array into another array after the specified *KEY*
226 * @param array $array The array.
227 * @param array $insert The array to insert.
228 * @param mixed $after The key to insert after
231 function wfArrayInsertAfter( array $array, array $insert, $after ) {
232 // Find the offset of the element to insert after.
233 $keys = array_keys( $array );
234 $offsetByKey = array_flip( $keys );
236 $offset = $offsetByKey[$after];
238 // Insert at the specified offset
239 $before = array_slice( $array, 0, $offset +
1, true );
240 $after = array_slice( $array, $offset +
1, count( $array ) - $offset, true );
242 $output = $before +
$insert +
$after;
248 * Recursively converts the parameter (an object) to an array with the same data
250 * @param object|array $objOrArray
251 * @param bool $recursive
254 function wfObjectToArray( $objOrArray, $recursive = true ) {
256 if ( is_object( $objOrArray ) ) {
257 $objOrArray = get_object_vars( $objOrArray );
259 foreach ( $objOrArray as $key => $value ) {
260 if ( $recursive && ( is_object( $value ) ||
is_array( $value ) ) ) {
261 $value = wfObjectToArray( $value );
264 $array[$key] = $value;
271 * Get a random decimal value between 0 and 1, in a way
272 * not likely to give duplicate values for any realistic
273 * number of articles.
275 * @note This is designed for use in relation to Special:RandomPage
276 * and the page_random database field.
280 function wfRandom() {
281 // The maximum random value is "only" 2^31-1, so get two random
282 // values to reduce the chance of dupes
283 $max = mt_getrandmax() +
1;
284 $rand = number_format( ( mt_rand() * $max +
mt_rand() ) / $max / $max, 12, '.', '' );
289 * Get a random string containing a number of pseudo-random hex characters.
291 * @note This is not secure, if you are trying to generate some sort
292 * of token please use MWCryptRand instead.
294 * @param int $length The length of the string to generate
298 function wfRandomString( $length = 32 ) {
300 for ( $n = 0; $n < $length; $n +
= 7 ) {
301 $str .= sprintf( '%07x', mt_rand() & 0xfffffff );
303 return substr( $str, 0, $length );
307 * We want some things to be included as literal characters in our title URLs
308 * for prettiness, which urlencode encodes by default. According to RFC 1738,
309 * all of the following should be safe:
313 * RFC 1738 says ~ is unsafe, however RFC 3986 considers it an unreserved
314 * character which should not be encoded. More importantly, google chrome
315 * always converts %7E back to ~, and converting it in this function can
316 * cause a redirect loop (T105265).
318 * But + is not safe because it's used to indicate a space; &= are only safe in
319 * paths and not in queries (and we don't distinguish here); ' seems kind of
320 * scary; and urlencode() doesn't touch -_. to begin with. Plus, although /
321 * is reserved, we don't care. So the list we unescape is:
325 * However, IIS7 redirects fail when the url contains a colon (see T24709),
326 * so no fancy : for IIS7.
328 * %2F in the page titles seems to fatally break for some reason.
333 function wfUrlencode( $s ) {
336 if ( is_null( $s ) ) {
341 if ( is_null( $needle ) ) {
342 $needle = [ '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F', '%7E' ];
343 if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) ||
344 ( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false )
350 $s = urlencode( $s );
353 [ ';', '@', '$', '!', '*', '(', ')', ',', '/', '~', ':' ],
361 * This function takes one or two arrays as input, and returns a CGI-style string, e.g.
362 * "days=7&limit=100". Options in the first array override options in the second.
363 * Options set to null or false will not be output.
365 * @param array $array1 ( String|Array )
366 * @param array|null $array2 ( String|Array )
367 * @param string $prefix
370 function wfArrayToCgi( $array1, $array2 = null, $prefix = '' ) {
371 if ( !is_null( $array2 ) ) {
372 $array1 = $array1 +
$array2;
376 foreach ( $array1 as $key => $value ) {
377 if ( !is_null( $value ) && $value !== false ) {
381 if ( $prefix !== '' ) {
382 $key = $prefix . "[$key]";
384 if ( is_array( $value ) ) {
386 foreach ( $value as $k => $v ) {
387 $cgi .= $firstTime ?
'' : '&';
388 if ( is_array( $v ) ) {
389 $cgi .= wfArrayToCgi( $v, null, $key . "[$k]" );
391 $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v );
396 if ( is_object( $value ) ) {
397 $value = $value->__toString();
399 $cgi .= urlencode( $key ) . '=' . urlencode( $value );
407 * This is the logical opposite of wfArrayToCgi(): it accepts a query string as
408 * its argument and returns the same string in array form. This allows compatibility
409 * with legacy functions that accept raw query strings instead of nice
410 * arrays. Of course, keys and values are urldecode()d.
412 * @param string $query Query string
413 * @return string[] Array version of input
415 function wfCgiToArray( $query ) {
416 if ( isset( $query[0] ) && $query[0] == '?' ) {
417 $query = substr( $query, 1 );
419 $bits = explode( '&', $query );
421 foreach ( $bits as $bit ) {
425 if ( strpos( $bit, '=' ) === false ) {
426 // Pieces like &qwerty become 'qwerty' => '' (at least this is what php does)
430 list( $key, $value ) = explode( '=', $bit );
432 $key = urldecode( $key );
433 $value = urldecode( $value );
434 if ( strpos( $key, '[' ) !== false ) {
435 $keys = array_reverse( explode( '[', $key ) );
436 $key = array_pop( $keys );
438 foreach ( $keys as $k ) {
439 $k = substr( $k, 0, -1 );
440 $temp = [ $k => $temp ];
442 if ( isset( $ret[$key] ) ) {
443 $ret[$key] = array_merge( $ret[$key], $temp );
455 * Append a query string to an existing URL, which may or may not already
456 * have query string parameters already. If so, they will be combined.
459 * @param string|string[] $query String or associative array
462 function wfAppendQuery( $url, $query ) {
463 if ( is_array( $query ) ) {
464 $query = wfArrayToCgi( $query );
466 if ( $query != '' ) {
467 // Remove the fragment, if there is one
469 $hashPos = strpos( $url, '#' );
470 if ( $hashPos !== false ) {
471 $fragment = substr( $url, $hashPos );
472 $url = substr( $url, 0, $hashPos );
476 if ( false === strpos( $url, '?' ) ) {
483 // Put the fragment back
484 if ( $fragment !== false ) {
492 * Expand a potentially local URL to a fully-qualified URL. Assumes $wgServer
495 * The meaning of the PROTO_* constants is as follows:
496 * PROTO_HTTP: Output a URL starting with http://
497 * PROTO_HTTPS: Output a URL starting with https://
498 * PROTO_RELATIVE: Output a URL starting with // (protocol-relative URL)
499 * PROTO_CURRENT: Output a URL starting with either http:// or https:// , depending
500 * on which protocol was used for the current incoming request
501 * PROTO_CANONICAL: For URLs without a domain, like /w/index.php , use $wgCanonicalServer.
502 * For protocol-relative URLs, use the protocol of $wgCanonicalServer
503 * PROTO_INTERNAL: Like PROTO_CANONICAL, but uses $wgInternalServer instead of $wgCanonicalServer
505 * @todo this won't work with current-path-relative URLs
506 * like "subdir/foo.html", etc.
508 * @param string $url Either fully-qualified or a local path + query
509 * @param string|int|null $defaultProto One of the PROTO_* constants. Determines the
510 * protocol to use if $url or $wgServer is protocol-relative
511 * @return string|false Fully-qualified URL, current-path-relative URL or false if
512 * no valid URL can be constructed
514 function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT
) {
515 global $wgServer, $wgCanonicalServer, $wgInternalServer, $wgRequest,
517 if ( $defaultProto === PROTO_CANONICAL
) {
518 $serverUrl = $wgCanonicalServer;
519 } elseif ( $defaultProto === PROTO_INTERNAL
&& $wgInternalServer !== false ) {
520 // Make $wgInternalServer fall back to $wgServer if not set
521 $serverUrl = $wgInternalServer;
523 $serverUrl = $wgServer;
524 if ( $defaultProto === PROTO_CURRENT
) {
525 $defaultProto = $wgRequest->getProtocol() . '://';
529 // Analyze $serverUrl to obtain its protocol
530 $bits = wfParseUrl( $serverUrl );
531 $serverHasProto = $bits && $bits['scheme'] != '';
533 if ( $defaultProto === PROTO_CANONICAL ||
$defaultProto === PROTO_INTERNAL
) {
534 if ( $serverHasProto ) {
535 $defaultProto = $bits['scheme'] . '://';
537 // $wgCanonicalServer or $wgInternalServer doesn't have a protocol.
538 // This really isn't supposed to happen. Fall back to HTTP in this
540 $defaultProto = PROTO_HTTP
;
544 $defaultProtoWithoutSlashes = substr( $defaultProto, 0, -2 );
546 if ( substr( $url, 0, 2 ) == '//' ) {
547 $url = $defaultProtoWithoutSlashes . $url;
548 } elseif ( substr( $url, 0, 1 ) == '/' ) {
549 // If $serverUrl is protocol-relative, prepend $defaultProtoWithoutSlashes,
550 // otherwise leave it alone.
551 $url = ( $serverHasProto ?
'' : $defaultProtoWithoutSlashes ) . $serverUrl . $url;
554 $bits = wfParseUrl( $url );
556 // ensure proper port for HTTPS arrives in URL
557 // https://phabricator.wikimedia.org/T67184
558 if ( $defaultProto === PROTO_HTTPS
&& $wgHttpsPort != 443 ) {
559 $bits['port'] = $wgHttpsPort;
562 if ( $bits && isset( $bits['path'] ) ) {
563 $bits['path'] = wfRemoveDotSegments( $bits['path'] );
564 return wfAssembleUrl( $bits );
568 } elseif ( substr( $url, 0, 1 ) != '/' ) {
569 # URL is a relative path
570 return wfRemoveDotSegments( $url );
573 # Expanded URL is not valid.
578 * This function will reassemble a URL parsed with wfParseURL. This is useful
579 * if you need to edit part of a URL and put it back together.
581 * This is the basic structure used (brackets contain keys for $urlParts):
582 * [scheme][delimiter][user]:[pass]@[host]:[port][path]?[query]#[fragment]
584 * @todo Need to integrate this into wfExpandUrl (see T34168)
587 * @param array $urlParts URL parts, as output from wfParseUrl
588 * @return string URL assembled from its component parts
590 function wfAssembleUrl( $urlParts ) {
593 if ( isset( $urlParts['delimiter'] ) ) {
594 if ( isset( $urlParts['scheme'] ) ) {
595 $result .= $urlParts['scheme'];
598 $result .= $urlParts['delimiter'];
601 if ( isset( $urlParts['host'] ) ) {
602 if ( isset( $urlParts['user'] ) ) {
603 $result .= $urlParts['user'];
604 if ( isset( $urlParts['pass'] ) ) {
605 $result .= ':' . $urlParts['pass'];
610 $result .= $urlParts['host'];
612 if ( isset( $urlParts['port'] ) ) {
613 $result .= ':' . $urlParts['port'];
617 if ( isset( $urlParts['path'] ) ) {
618 $result .= $urlParts['path'];
621 if ( isset( $urlParts['query'] ) ) {
622 $result .= '?' . $urlParts['query'];
625 if ( isset( $urlParts['fragment'] ) ) {
626 $result .= '#' . $urlParts['fragment'];
633 * Remove all dot-segments in the provided URL path. For example,
634 * '/a/./b/../c/' becomes '/a/c/'. For details on the algorithm, please see
635 * RFC3986 section 5.2.4.
637 * @todo Need to integrate this into wfExpandUrl (see T34168)
641 * @param string $urlPath URL path, potentially containing dot-segments
642 * @return string URL path with all dot-segments removed
644 function wfRemoveDotSegments( $urlPath ) {
647 $inputLength = strlen( $urlPath );
649 while ( $inputOffset < $inputLength ) {
650 $prefixLengthOne = substr( $urlPath, $inputOffset, 1 );
651 $prefixLengthTwo = substr( $urlPath, $inputOffset, 2 );
652 $prefixLengthThree = substr( $urlPath, $inputOffset, 3 );
653 $prefixLengthFour = substr( $urlPath, $inputOffset, 4 );
656 if ( $prefixLengthTwo == './' ) {
657 # Step A, remove leading "./"
659 } elseif ( $prefixLengthThree == '../' ) {
660 # Step A, remove leading "../"
662 } elseif ( ( $prefixLengthTwo == '/.' ) && ( $inputOffset +
2 == $inputLength ) ) {
663 # Step B, replace leading "/.$" with "/"
665 $urlPath[$inputOffset] = '/';
666 } elseif ( $prefixLengthThree == '/./' ) {
667 # Step B, replace leading "/./" with "/"
669 } elseif ( $prefixLengthThree == '/..' && ( $inputOffset +
3 == $inputLength ) ) {
670 # Step C, replace leading "/..$" with "/" and
671 # remove last path component in output
673 $urlPath[$inputOffset] = '/';
675 } elseif ( $prefixLengthFour == '/../' ) {
676 # Step C, replace leading "/../" with "/" and
677 # remove last path component in output
680 } elseif ( ( $prefixLengthOne == '.' ) && ( $inputOffset +
1 == $inputLength ) ) {
681 # Step D, remove "^.$"
683 } elseif ( ( $prefixLengthTwo == '..' ) && ( $inputOffset +
2 == $inputLength ) ) {
684 # Step D, remove "^..$"
687 # Step E, move leading path segment to output
688 if ( $prefixLengthOne == '/' ) {
689 $slashPos = strpos( $urlPath, '/', $inputOffset +
1 );
691 $slashPos = strpos( $urlPath, '/', $inputOffset );
693 if ( $slashPos === false ) {
694 $output .= substr( $urlPath, $inputOffset );
695 $inputOffset = $inputLength;
697 $output .= substr( $urlPath, $inputOffset, $slashPos - $inputOffset );
698 $inputOffset +
= $slashPos - $inputOffset;
703 $slashPos = strrpos( $output, '/' );
704 if ( $slashPos === false ) {
707 $output = substr( $output, 0, $slashPos );
716 * Returns a regular expression of url protocols
718 * @param bool $includeProtocolRelative If false, remove '//' from the returned protocol list.
719 * DO NOT USE this directly, use wfUrlProtocolsWithoutProtRel() instead
722 function wfUrlProtocols( $includeProtocolRelative = true ) {
723 global $wgUrlProtocols;
725 // Cache return values separately based on $includeProtocolRelative
726 static $withProtRel = null, $withoutProtRel = null;
727 $cachedValue = $includeProtocolRelative ?
$withProtRel : $withoutProtRel;
728 if ( !is_null( $cachedValue ) ) {
732 // Support old-style $wgUrlProtocols strings, for backwards compatibility
733 // with LocalSettings files from 1.5
734 if ( is_array( $wgUrlProtocols ) ) {
736 foreach ( $wgUrlProtocols as $protocol ) {
737 // Filter out '//' if !$includeProtocolRelative
738 if ( $includeProtocolRelative ||
$protocol !== '//' ) {
739 $protocols[] = preg_quote( $protocol, '/' );
743 $retval = implode( '|', $protocols );
745 // Ignore $includeProtocolRelative in this case
746 // This case exists for pre-1.6 compatibility, and we can safely assume
747 // that '//' won't appear in a pre-1.6 config because protocol-relative
748 // URLs weren't supported until 1.18
749 $retval = $wgUrlProtocols;
752 // Cache return value
753 if ( $includeProtocolRelative ) {
754 $withProtRel = $retval;
756 $withoutProtRel = $retval;
762 * Like wfUrlProtocols(), but excludes '//' from the protocol list. Use this if
763 * you need a regex that matches all URL protocols but does not match protocol-
767 function wfUrlProtocolsWithoutProtRel() {
768 return wfUrlProtocols( false );
772 * parse_url() work-alike, but non-broken. Differences:
774 * 1) Does not raise warnings on bad URLs (just returns false).
775 * 2) Handles protocols that don't use :// (e.g., mailto: and news:, as well as
776 * protocol-relative URLs) correctly.
777 * 3) Adds a "delimiter" element to the array (see (2)).
778 * 4) Verifies that the protocol is on the $wgUrlProtocols whitelist.
779 * 5) Rejects some invalid URLs that parse_url doesn't, e.g. the empty string or URLs starting with
780 * a line feed character.
782 * @param string $url A URL to parse
783 * @return string[]|bool Bits of the URL in an associative array, or false on failure.
785 * - scheme: URI scheme (protocol), e.g. 'http', 'mailto'. Lowercase, always present, but can
786 * be an empty string for protocol-relative URLs.
787 * - delimiter: either '://', ':' or '//'. Always present.
788 * - host: domain name / IP. Always present, but could be an empty string, e.g. for file: URLs.
789 * - user: user name, e.g. for HTTP Basic auth URLs such as http://user:pass@example.com/
790 * Missing when there is no username.
791 * - pass: password, same as above.
792 * - path: path including the leading /. Will be missing when empty (e.g. 'http://example.com')
793 * - query: query string (as a string; see wfCgiToArray() for parsing it), can be missing.
794 * - fragment: the part after #, can be missing.
796 function wfParseUrl( $url ) {
797 global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
799 // Protocol-relative URLs are handled really badly by parse_url(). It's so
800 // bad that the easiest way to handle them is to just prepend 'http:' and
801 // strip the protocol out later.
802 $wasRelative = substr( $url, 0, 2 ) == '//';
803 if ( $wasRelative ) {
806 Wikimedia\
suppressWarnings();
807 $bits = parse_url( $url );
808 Wikimedia\restoreWarnings
();
809 // parse_url() returns an array without scheme for some invalid URLs, e.g.
810 // parse_url("%0Ahttp://example.com") == [ 'host' => '%0Ahttp', 'path' => 'example.com' ]
811 if ( !$bits ||
!isset( $bits['scheme'] ) ) {
815 // parse_url() incorrectly handles schemes case-sensitively. Convert it to lowercase.
816 $bits['scheme'] = strtolower( $bits['scheme'] );
818 // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
819 if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
820 $bits['delimiter'] = '://';
821 } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
822 $bits['delimiter'] = ':';
823 // parse_url detects for news: and mailto: the host part of an url as path
824 // We have to correct this wrong detection
825 if ( isset( $bits['path'] ) ) {
826 $bits['host'] = $bits['path'];
833 /* Provide an empty host for eg. file:/// urls (see T30627) */
834 if ( !isset( $bits['host'] ) ) {
838 if ( isset( $bits['path'] ) ) {
839 /* parse_url loses the third / for file:///c:/ urls (but not on variants) */
840 if ( substr( $bits['path'], 0, 1 ) !== '/' ) {
841 $bits['path'] = '/' . $bits['path'];
848 // If the URL was protocol-relative, fix scheme and delimiter
849 if ( $wasRelative ) {
850 $bits['scheme'] = '';
851 $bits['delimiter'] = '//';
857 * Take a URL, make sure it's expanded to fully qualified, and replace any
858 * encoded non-ASCII Unicode characters with their UTF-8 original forms
859 * for more compact display and legibility for local audiences.
861 * @todo handle punycode domains too
866 function wfExpandIRI( $url ) {
867 return preg_replace_callback(
868 '/((?:%[89A-F][0-9A-F])+)/i',
869 'wfExpandIRI_callback',
875 * Private callback for wfExpandIRI
876 * @param array $matches
879 function wfExpandIRI_callback( $matches ) {
880 return urldecode( $matches[1] );
884 * Make URL indexes, appropriate for the el_index field of externallinks.
889 function wfMakeUrlIndexes( $url ) {
890 $bits = wfParseUrl( $url );
892 // Reverse the labels in the hostname, convert to lower case
893 // For emails reverse domainpart only
894 if ( $bits['scheme'] == 'mailto' ) {
895 $mailparts = explode( '@', $bits['host'], 2 );
896 if ( count( $mailparts ) === 2 ) {
897 $domainpart = strtolower( implode( '.', array_reverse( explode( '.', $mailparts[1] ) ) ) );
899 // No domain specified, don't mangle it
902 $reversedHost = $domainpart . '@' . $mailparts[0];
904 $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) );
906 // Add an extra dot to the end
907 // Why? Is it in wrong place in mailto links?
908 if ( substr( $reversedHost, -1, 1 ) !== '.' ) {
909 $reversedHost .= '.';
911 // Reconstruct the pseudo-URL
912 $prot = $bits['scheme'];
913 $index = $prot . $bits['delimiter'] . $reversedHost;
914 // Leave out user and password. Add the port, path, query and fragment
915 if ( isset( $bits['port'] ) ) {
916 $index .= ':' . $bits['port'];
918 if ( isset( $bits['path'] ) ) {
919 $index .= $bits['path'];
923 if ( isset( $bits['query'] ) ) {
924 $index .= '?' . $bits['query'];
926 if ( isset( $bits['fragment'] ) ) {
927 $index .= '#' . $bits['fragment'];
931 return [ "http:$index", "https:$index" ];
938 * Check whether a given URL has a domain that occurs in a given set of domains
940 * @param array $domains Array of domains (strings)
941 * @return bool True if the host part of $url ends in one of the strings in $domains
943 function wfMatchesDomainList( $url, $domains ) {
944 $bits = wfParseUrl( $url );
945 if ( is_array( $bits ) && isset( $bits['host'] ) ) {
946 $host = '.' . $bits['host'];
947 foreach ( (array)$domains as $domain ) {
948 $domain = '.' . $domain;
949 if ( substr( $host, -strlen( $domain ) ) === $domain ) {
958 * Sends a line to the debug log if enabled or, optionally, to a comment in output.
959 * In normal operation this is a NOP.
961 * Controlling globals:
962 * $wgDebugLogFile - points to the log file
963 * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
964 * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
966 * @since 1.25 support for additional context data
968 * @param string $text
969 * @param string|bool $dest Destination of the message:
970 * - 'all': both to the log and HTML (debug toolbar or HTML comments)
971 * - 'private': excluded from HTML output
972 * For backward compatibility, it can also take a boolean:
973 * - true: same as 'all'
974 * - false: same as 'private'
975 * @param array $context Additional logging context data
977 function wfDebug( $text, $dest = 'all', array $context = [] ) {
978 global $wgDebugRawPage, $wgDebugLogPrefix;
979 global $wgDebugTimestamps;
981 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
985 $text = trim( $text );
987 if ( $wgDebugTimestamps ) {
988 $context['seconds_elapsed'] = sprintf(
990 microtime( true ) - $_SERVER['REQUEST_TIME_FLOAT']
992 $context['memory_used'] = sprintf(
994 ( memory_get_usage( true ) / ( 1024 * 1024 ) )
998 if ( $wgDebugLogPrefix !== '' ) {
999 $context['prefix'] = $wgDebugLogPrefix;
1001 $context['private'] = ( $dest === false ||
$dest === 'private' );
1003 $logger = LoggerFactory
::getInstance( 'wfDebug' );
1004 $logger->debug( $text, $context );
1008 * Returns true if debug logging should be suppressed if $wgDebugRawPage = false
1011 function wfIsDebugRawPage() {
1013 if ( $cache !== null ) {
1016 // Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
1017 // phpcs:ignore MediaWiki.Usage.SuperGlobalsUsage.SuperGlobals
1018 if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
1020 isset( $_SERVER['SCRIPT_NAME'] )
1021 && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
1032 * Send a line giving PHP memory usage.
1034 * @param bool $exact Print exact byte values instead of kibibytes (default: false)
1036 function wfDebugMem( $exact = false ) {
1037 $mem = memory_get_usage();
1039 $mem = floor( $mem / 1024 ) . ' KiB';
1043 wfDebug( "Memory usage: $mem\n" );
1047 * Send a line to a supplementary debug log file, if configured, or main debug
1050 * To configure a supplementary log file, set $wgDebugLogGroups[$logGroup] to
1051 * a string filename or an associative array mapping 'destination' to the
1052 * desired filename. The associative array may also contain a 'sample' key
1053 * with an integer value, specifying a sampling factor. Sampled log events
1054 * will be emitted with a 1 in N random chance.
1056 * @since 1.23 support for sampling log messages via $wgDebugLogGroups.
1057 * @since 1.25 support for additional context data
1058 * @since 1.25 sample behavior dependent on configured $wgMWLoggerDefaultSpi
1060 * @param string $logGroup
1061 * @param string $text
1062 * @param string|bool $dest Destination of the message:
1063 * - 'all': both to the log and HTML (debug toolbar or HTML comments)
1064 * - 'private': only to the specific log if set in $wgDebugLogGroups and
1065 * discarded otherwise
1066 * For backward compatibility, it can also take a boolean:
1067 * - true: same as 'all'
1068 * - false: same as 'private'
1069 * @param array $context Additional logging context data
1071 function wfDebugLog(
1072 $logGroup, $text, $dest = 'all', array $context = []
1074 $text = trim( $text );
1076 $logger = LoggerFactory
::getInstance( $logGroup );
1077 $context['private'] = ( $dest === false ||
$dest === 'private' );
1078 $logger->info( $text, $context );
1082 * Log for database errors
1084 * @since 1.25 support for additional context data
1086 * @param string $text Database error message.
1087 * @param array $context Additional logging context data
1089 function wfLogDBError( $text, array $context = [] ) {
1090 $logger = LoggerFactory
::getInstance( 'wfLogDBError' );
1091 $logger->error( trim( $text ), $context );
1095 * Throws a warning that $function is deprecated
1097 * @param string $function
1098 * @param string|bool $version Version of MediaWiki that the function
1099 * was deprecated in (Added in 1.19).
1100 * @param string|bool $component Added in 1.19.
1101 * @param int $callerOffset How far up the call stack is the original
1102 * caller. 2 = function that called the function that called
1103 * wfDeprecated (Added in 1.20)
1107 function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) {
1108 MWDebug
::deprecated( $function, $version, $component, $callerOffset +
1 );
1112 * Send a warning either to the debug log or in a PHP error depending on
1113 * $wgDevelopmentWarnings. To log warnings in production, use wfLogWarning() instead.
1115 * @param string $msg Message to send
1116 * @param int $callerOffset Number of items to go back in the backtrace to
1117 * find the correct caller (1 = function calling wfWarn, ...)
1118 * @param int $level PHP error level; defaults to E_USER_NOTICE;
1119 * only used when $wgDevelopmentWarnings is true
1121 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE
) {
1122 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'auto' );
1126 * Send a warning as a PHP error and the debug log. This is intended for logging
1127 * warnings in production. For logging development warnings, use WfWarn instead.
1129 * @param string $msg Message to send
1130 * @param int $callerOffset Number of items to go back in the backtrace to
1131 * find the correct caller (1 = function calling wfLogWarning, ...)
1132 * @param int $level PHP error level; defaults to E_USER_WARNING
1134 function wfLogWarning( $msg, $callerOffset = 1, $level = E_USER_WARNING
) {
1135 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'production' );
1139 * Log to a file without getting "file size exceeded" signals.
1141 * Can also log to TCP or UDP with the syntax udp://host:port/prefix. This will
1142 * send lines to the specified port, prefixed by the specified prefix and a space.
1143 * @since 1.25 support for additional context data
1145 * @param string $text
1146 * @param string $file Filename
1147 * @param array $context Additional logging context data
1148 * @throws MWException
1149 * @deprecated since 1.25 Use \MediaWiki\Logger\LegacyLogger::emit or UDPTransport
1151 function wfErrorLog( $text, $file, array $context = [] ) {
1152 wfDeprecated( __METHOD__
, '1.25' );
1153 $logger = LoggerFactory
::getInstance( 'wfErrorLog' );
1154 $context['destination'] = $file;
1155 $logger->info( trim( $text ), $context );
1160 * @todo Move logic to MediaWiki.php
1162 function wfLogProfilingData() {
1163 global $wgDebugLogGroups, $wgDebugRawPage;
1165 $context = RequestContext
::getMain();
1166 $request = $context->getRequest();
1168 $profiler = Profiler
::instance();
1169 $profiler->setContext( $context );
1170 $profiler->logData();
1172 // Send out any buffered statsd metrics as needed
1173 MediaWiki
::emitBufferedStatsdData(
1174 MediaWikiServices
::getInstance()->getStatsdDataFactory(),
1175 $context->getConfig()
1178 // Profiling must actually be enabled...
1179 if ( $profiler instanceof ProfilerStub
) {
1183 if ( isset( $wgDebugLogGroups['profileoutput'] )
1184 && $wgDebugLogGroups['profileoutput'] === false
1186 // Explicitly disabled
1189 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1193 $ctx = [ 'elapsed' => $request->getElapsedTime() ];
1194 if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1195 $ctx['forwarded_for'] = $_SERVER['HTTP_X_FORWARDED_FOR'];
1197 if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1198 $ctx['client_ip'] = $_SERVER['HTTP_CLIENT_IP'];
1200 if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1201 $ctx['from'] = $_SERVER['HTTP_FROM'];
1203 if ( isset( $ctx['forwarded_for'] ) ||
1204 isset( $ctx['client_ip'] ) ||
1205 isset( $ctx['from'] ) ) {
1206 $ctx['proxy'] = $_SERVER['REMOTE_ADDR'];
1209 // Don't load $wgUser at this late stage just for statistics purposes
1210 // @todo FIXME: We can detect some anons even if it is not loaded.
1211 // See User::getId()
1212 $user = $context->getUser();
1213 $ctx['anon'] = $user->isItemLoaded( 'id' ) && $user->isAnon();
1215 // Command line script uses a FauxRequest object which does not have
1216 // any knowledge about an URL and throw an exception instead.
1218 $ctx['url'] = urldecode( $request->getRequestURL() );
1219 } catch ( Exception
$ignored ) {
1223 $ctx['output'] = $profiler->getOutput();
1225 $log = LoggerFactory
::getInstance( 'profileoutput' );
1226 $log->info( "Elapsed: {elapsed}; URL: <{url}>\n{output}", $ctx );
1230 * Increment a statistics counter
1232 * @param string $key
1236 function wfIncrStats( $key, $count = 1 ) {
1237 $stats = MediaWikiServices
::getInstance()->getStatsdDataFactory();
1238 $stats->updateCount( $key, $count );
1242 * Check whether the wiki is in read-only mode.
1246 function wfReadOnly() {
1247 return MediaWikiServices
::getInstance()->getReadOnlyMode()
1252 * Check if the site is in read-only mode and return the message if so
1254 * This checks wfConfiguredReadOnlyReason() and the main load balancer
1255 * for replica DB lag. This may result in DB connection being made.
1257 * @return string|bool String when in read-only mode; false otherwise
1259 function wfReadOnlyReason() {
1260 return MediaWikiServices
::getInstance()->getReadOnlyMode()
1265 * Get the value of $wgReadOnly or the contents of $wgReadOnlyFile.
1267 * @return string|bool String when in read-only mode; false otherwise
1270 function wfConfiguredReadOnlyReason() {
1271 return MediaWikiServices
::getInstance()->getConfiguredReadOnlyMode()
1276 * Return a Language object from $langcode
1278 * @param Language|string|bool $langcode Either:
1279 * - a Language object
1280 * - code of the language to get the message for, if it is
1281 * a valid code create a language for that language, if
1282 * it is a string but not a valid code then make a basic
1284 * - a boolean: if it's false then use the global object for
1285 * the current user's language (as a fallback for the old parameter
1286 * functionality), or if it is true then use global object
1287 * for the wiki's content language.
1290 function wfGetLangObj( $langcode = false ) {
1291 # Identify which language to get or create a language object for.
1292 # Using is_object here due to Stub objects.
1293 if ( is_object( $langcode ) ) {
1294 # Great, we already have the object (hopefully)!
1298 global $wgContLang, $wgLanguageCode;
1299 if ( $langcode === true ||
$langcode === $wgLanguageCode ) {
1300 # $langcode is the language code of the wikis content language object.
1301 # or it is a boolean and value is true
1306 if ( $langcode === false ||
$langcode === $wgLang->getCode() ) {
1307 # $langcode is the language code of user language object.
1308 # or it was a boolean and value is false
1312 $validCodes = array_keys( Language
::fetchLanguageNames() );
1313 if ( in_array( $langcode, $validCodes ) ) {
1314 # $langcode corresponds to a valid language.
1315 return Language
::factory( $langcode );
1318 # $langcode is a string, but not a valid language code; use content language.
1319 wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1324 * This is the function for getting translated interface messages.
1326 * @see Message class for documentation how to use them.
1327 * @see https://www.mediawiki.org/wiki/Manual:Messages_API
1329 * This function replaces all old wfMsg* functions.
1331 * @param string|string[]|MessageSpecifier $key Message key, or array of keys, or a MessageSpecifier
1332 * @param string|string[] ...$params Normal message parameters
1337 * @see Message::__construct
1339 function wfMessage( $key, ...$params ) {
1340 $message = new Message( $key );
1342 // We call Message::params() to reduce code duplication
1344 $message->params( ...$params );
1351 * This function accepts multiple message keys and returns a message instance
1352 * for the first message which is non-empty. If all messages are empty then an
1353 * instance of the first message key is returned.
1355 * @param string ...$keys Message keys
1360 * @see Message::newFallbackSequence
1362 function wfMessageFallback( ...$keys ) {
1363 return Message
::newFallbackSequence( ...$keys );
1367 * Replace message parameter keys on the given formatted output.
1369 * @param string $message
1370 * @param array $args
1374 function wfMsgReplaceArgs( $message, $args ) {
1375 # Fix windows line-endings
1376 # Some messages are split with explode("\n", $msg)
1377 $message = str_replace( "\r", '', $message );
1379 // Replace arguments
1380 if ( is_array( $args ) && $args ) {
1381 if ( is_array( $args[0] ) ) {
1382 $args = array_values( $args[0] );
1384 $replacementKeys = [];
1385 foreach ( $args as $n => $param ) {
1386 $replacementKeys['$' . ( $n +
1 )] = $param;
1388 $message = strtr( $message, $replacementKeys );
1395 * Fetch server name for use in error reporting etc.
1396 * Use real server name if available, so we know which machine
1397 * in a server farm generated the current page.
1401 function wfHostname() {
1403 if ( is_null( $host ) ) {
1404 # Hostname overriding
1405 global $wgOverrideHostname;
1406 if ( $wgOverrideHostname !== false ) {
1407 # Set static and skip any detection
1408 $host = $wgOverrideHostname;
1412 if ( function_exists( 'posix_uname' ) ) {
1413 // This function not present on Windows
1414 $uname = posix_uname();
1418 if ( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1419 $host = $uname['nodename'];
1420 } elseif ( getenv( 'COMPUTERNAME' ) ) {
1421 # Windows computer name
1422 $host = getenv( 'COMPUTERNAME' );
1424 # This may be a virtual server.
1425 $host = $_SERVER['SERVER_NAME'];
1432 * Returns a script tag that stores the amount of time it took MediaWiki to
1433 * handle the request in milliseconds as 'wgBackendResponseTime'.
1435 * If $wgShowHostnames is true, the script will also set 'wgHostname' to the
1436 * hostname of the server handling the request.
1438 * @param string|null $nonce Value from OutputPage::getCSPNonce
1439 * @return string|WrappedString HTML
1441 function wfReportTime( $nonce = null ) {
1442 global $wgShowHostnames;
1444 $elapsed = ( microtime( true ) - $_SERVER['REQUEST_TIME_FLOAT'] );
1445 // seconds to milliseconds
1446 $responseTime = round( $elapsed * 1000 );
1447 $reportVars = [ 'wgBackendResponseTime' => $responseTime ];
1448 if ( $wgShowHostnames ) {
1449 $reportVars['wgHostname'] = wfHostname();
1451 return Skin
::makeVariablesScript( $reportVars, $nonce );
1455 * Safety wrapper for debug_backtrace().
1457 * Will return an empty array if debug_backtrace is disabled, otherwise
1458 * the output from debug_backtrace() (trimmed).
1460 * @param int $limit This parameter can be used to limit the number of stack frames returned
1462 * @return array Array of backtrace information
1464 function wfDebugBacktrace( $limit = 0 ) {
1465 static $disabled = null;
1467 if ( is_null( $disabled ) ) {
1468 $disabled = !function_exists( 'debug_backtrace' );
1470 wfDebug( "debug_backtrace() is disabled\n" );
1478 return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT
, $limit +
1 ), 1 );
1480 return array_slice( debug_backtrace(), 1 );
1485 * Get a debug backtrace as a string
1487 * @param bool|null $raw If true, the return value is plain text. If false, HTML.
1488 * Defaults to $wgCommandLineMode if unset.
1490 * @since 1.25 Supports $raw parameter.
1492 function wfBacktrace( $raw = null ) {
1493 global $wgCommandLineMode;
1495 if ( $raw === null ) {
1496 $raw = $wgCommandLineMode;
1500 $frameFormat = "%s line %s calls %s()\n";
1501 $traceFormat = "%s";
1503 $frameFormat = "<li>%s line %s calls %s()</li>\n";
1504 $traceFormat = "<ul>\n%s</ul>\n";
1507 $frames = array_map( function ( $frame ) use ( $frameFormat ) {
1508 $file = !empty( $frame['file'] ) ?
basename( $frame['file'] ) : '-';
1509 $line = $frame['line'] ??
'-';
1510 $call = $frame['function'];
1511 if ( !empty( $frame['class'] ) ) {
1512 $call = $frame['class'] . $frame['type'] . $call;
1514 return sprintf( $frameFormat, $file, $line, $call );
1515 }, wfDebugBacktrace() );
1517 return sprintf( $traceFormat, implode( '', $frames ) );
1521 * Get the name of the function which called this function
1522 * wfGetCaller( 1 ) is the function with the wfGetCaller() call (ie. __FUNCTION__)
1523 * wfGetCaller( 2 ) [default] is the caller of the function running wfGetCaller()
1524 * wfGetCaller( 3 ) is the parent of that.
1529 function wfGetCaller( $level = 2 ) {
1530 $backtrace = wfDebugBacktrace( $level +
1 );
1531 if ( isset( $backtrace[$level] ) ) {
1532 return wfFormatStackFrame( $backtrace[$level] );
1539 * Return a string consisting of callers in the stack. Useful sometimes
1540 * for profiling specific points.
1542 * @param int $limit The maximum depth of the stack frame to return, or false for the entire stack.
1545 function wfGetAllCallers( $limit = 3 ) {
1546 $trace = array_reverse( wfDebugBacktrace() );
1547 if ( !$limit ||
$limit > count( $trace ) - 1 ) {
1548 $limit = count( $trace ) - 1;
1550 $trace = array_slice( $trace, -$limit - 1, $limit );
1551 return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1555 * Return a string representation of frame
1557 * @param array $frame
1560 function wfFormatStackFrame( $frame ) {
1561 if ( !isset( $frame['function'] ) ) {
1562 return 'NO_FUNCTION_GIVEN';
1564 return isset( $frame['class'] ) && isset( $frame['type'] ) ?
1565 $frame['class'] . $frame['type'] . $frame['function'] :
1569 /* Some generic result counters, pulled out of SearchEngine */
1574 * @param int $offset
1578 function wfShowingResults( $offset, $limit ) {
1579 return wfMessage( 'showingresults' )->numParams( $limit, $offset +
1 )->parse();
1583 * Whether the client accept gzip encoding
1585 * Uses the Accept-Encoding header to check if the client supports gzip encoding.
1586 * Use this when considering to send a gzip-encoded response to the client.
1588 * @param bool $force Forces another check even if we already have a cached result.
1591 function wfClientAcceptsGzip( $force = false ) {
1592 static $result = null;
1593 if ( $result === null ||
$force ) {
1595 if ( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
1596 # @todo FIXME: We may want to blacklist some broken browsers
1599 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
1600 $_SERVER['HTTP_ACCEPT_ENCODING'],
1604 if ( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
1608 wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
1617 * Escapes the given text so that it may be output using addWikiText()
1618 * without any linking, formatting, etc. making its way through. This
1619 * is achieved by substituting certain characters with HTML entities.
1620 * As required by the callers, "<nowiki>" is not used.
1622 * @param string $text Text to be escaped
1623 * @param-taint $text escapes_html
1626 function wfEscapeWikiText( $text ) {
1627 global $wgEnableMagicLinks;
1628 static $repl = null, $repl2 = null;
1629 if ( $repl === null ||
defined( 'MW_PARSER_TEST' ) ||
defined( 'MW_PHPUNIT_TEST' ) ) {
1630 // Tests depend upon being able to change $wgEnableMagicLinks, so don't cache
1631 // in those situations
1633 '"' => '"', '&' => '&', "'" => ''', '<' => '<',
1634 '=' => '=', '>' => '>', '[' => '[', ']' => ']',
1635 '{' => '{', '|' => '|', '}' => '}', ';' => ';',
1636 "\n#" => "\n#", "\r#" => "\r#",
1637 "\n*" => "\n*", "\r*" => "\r*",
1638 "\n:" => "\n:", "\r:" => "\r:",
1639 "\n " => "\n ", "\r " => "\r ",
1640 "\n\n" => "\n ", "\r\n" => " \n",
1641 "\n\r" => "\n ", "\r\r" => "\r ",
1642 "\n\t" => "\n	", "\r\t" => "\r	", // "\n\t\n" is treated like "\n\n"
1643 "\n----" => "\n----", "\r----" => "\r----",
1644 '__' => '__', '://' => '://',
1647 $magicLinks = array_keys( array_filter( $wgEnableMagicLinks ) );
1648 // We have to catch everything "\s" matches in PCRE
1649 foreach ( $magicLinks as $magic ) {
1650 $repl["$magic "] = "$magic ";
1651 $repl["$magic\t"] = "$magic	";
1652 $repl["$magic\r"] = "$magic ";
1653 $repl["$magic\n"] = "$magic ";
1654 $repl["$magic\f"] = "$magic";
1657 // And handle protocols that don't use "://"
1658 global $wgUrlProtocols;
1660 foreach ( $wgUrlProtocols as $prot ) {
1661 if ( substr( $prot, -1 ) === ':' ) {
1662 $repl2[] = preg_quote( substr( $prot, 0, -1 ), '/' );
1665 $repl2 = $repl2 ?
'/\b(' . implode( '|', $repl2 ) . '):/i' : '/^(?!)/';
1667 $text = substr( strtr( "\n$text", $repl ), 1 );
1668 $text = preg_replace( $repl2, '$1:', $text );
1673 * Sets dest to source and returns the original value of dest
1674 * If source is NULL, it just returns the value, it doesn't set the variable
1675 * If force is true, it will set the value even if source is NULL
1677 * @param mixed &$dest
1678 * @param mixed $source
1679 * @param bool $force
1682 function wfSetVar( &$dest, $source, $force = false ) {
1684 if ( !is_null( $source ) ||
$force ) {
1691 * As for wfSetVar except setting a bit
1695 * @param bool $state
1699 function wfSetBit( &$dest, $bit, $state = true ) {
1700 $temp = (bool)( $dest & $bit );
1701 if ( !is_null( $state ) ) {
1712 * A wrapper around the PHP function var_export().
1713 * Either print it or add it to the regular output ($wgOut).
1715 * @param mixed $var A PHP variable to dump.
1717 function wfVarDump( $var ) {
1719 $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
1720 if ( headers_sent() ||
!isset( $wgOut ) ||
!is_object( $wgOut ) ) {
1723 $wgOut->addHTML( $s );
1728 * Provide a simple HTTP error.
1730 * @param int|string $code
1731 * @param string $label
1732 * @param string $desc
1734 function wfHttpError( $code, $label, $desc ) {
1736 HttpStatus
::header( $code );
1739 $wgOut->sendCacheControl();
1742 MediaWiki\HeaderCallback
::warnIfHeadersSent();
1743 header( 'Content-type: text/html; charset=utf-8' );
1744 print '<!DOCTYPE html>' .
1745 '<html><head><title>' .
1746 htmlspecialchars( $label ) .
1747 '</title></head><body><h1>' .
1748 htmlspecialchars( $label ) .
1750 nl2br( htmlspecialchars( $desc ) ) .
1751 "</p></body></html>\n";
1755 * Clear away any user-level output buffers, discarding contents.
1757 * Suitable for 'starting afresh', for instance when streaming
1758 * relatively large amounts of data without buffering, or wanting to
1759 * output image files without ob_gzhandler's compression.
1761 * The optional $resetGzipEncoding parameter controls suppression of
1762 * the Content-Encoding header sent by ob_gzhandler; by default it
1763 * is left. See comments for wfClearOutputBuffers() for why it would
1766 * Note that some PHP configuration options may add output buffer
1767 * layers which cannot be removed; these are left in place.
1769 * @param bool $resetGzipEncoding
1771 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
1772 if ( $resetGzipEncoding ) {
1773 // Suppress Content-Encoding and Content-Length
1774 // headers from OutputHandler::handle.
1775 global $wgDisableOutputCompression;
1776 $wgDisableOutputCompression = true;
1778 while ( $status = ob_get_status() ) {
1779 if ( isset( $status['flags'] ) ) {
1780 $flags = PHP_OUTPUT_HANDLER_CLEANABLE | PHP_OUTPUT_HANDLER_REMOVABLE
;
1781 $deleteable = ( $status['flags'] & $flags ) === $flags;
1782 } elseif ( isset( $status['del'] ) ) {
1783 $deleteable = $status['del'];
1785 // Guess that any PHP-internal setting can't be removed.
1786 $deleteable = $status['type'] !== 0; /* PHP_OUTPUT_HANDLER_INTERNAL */
1788 if ( !$deleteable ) {
1789 // Give up, and hope the result doesn't break
1793 if ( $status['name'] === 'MediaWikiTestCase::wfResetOutputBuffersBarrier' ) {
1794 // Unit testing barrier to prevent this function from breaking PHPUnit.
1797 if ( !ob_end_clean() ) {
1798 // Could not remove output buffer handler; abort now
1799 // to avoid getting in some kind of infinite loop.
1802 if ( $resetGzipEncoding ) {
1803 if ( $status['name'] == 'ob_gzhandler' ) {
1804 // Reset the 'Content-Encoding' field set by this handler
1805 // so we can start fresh.
1806 header_remove( 'Content-Encoding' );
1814 * More legible than passing a 'false' parameter to wfResetOutputBuffers():
1816 * Clear away output buffers, but keep the Content-Encoding header
1817 * produced by ob_gzhandler, if any.
1819 * This should be used for HTTP 304 responses, where you need to
1820 * preserve the Content-Encoding header of the real result, but
1821 * also need to suppress the output of ob_gzhandler to keep to spec
1822 * and avoid breaking Firefox in rare cases where the headers and
1823 * body are broken over two packets.
1825 function wfClearOutputBuffers() {
1826 wfResetOutputBuffers( false );
1830 * Converts an Accept-* header into an array mapping string values to quality
1833 * @param string $accept
1834 * @param string $def Default
1835 * @return float[] Associative array of string => float pairs
1837 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
1838 # No arg means accept anything (per HTTP spec)
1840 return [ $def => 1.0 ];
1845 $parts = explode( ',', $accept );
1847 foreach ( $parts as $part ) {
1848 # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
1849 $values = explode( ';', trim( $part ) );
1851 if ( count( $values ) == 1 ) {
1852 $prefs[$values[0]] = 1.0;
1853 } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
1854 $prefs[$values[0]] = floatval( $match[1] );
1862 * Checks if a given MIME type matches any of the keys in the given
1863 * array. Basic wildcards are accepted in the array keys.
1865 * Returns the matching MIME type (or wildcard) if a match, otherwise
1868 * @param string $type
1869 * @param array $avail
1873 function mimeTypeMatch( $type, $avail ) {
1874 if ( array_key_exists( $type, $avail ) ) {
1877 $mainType = explode( '/', $type )[0];
1878 if ( array_key_exists( "$mainType/*", $avail ) ) {
1879 return "$mainType/*";
1880 } elseif ( array_key_exists( '*/*', $avail ) ) {
1889 * Returns the 'best' match between a client's requested internet media types
1890 * and the server's list of available types. Each list should be an associative
1891 * array of type to preference (preference is a float between 0.0 and 1.0).
1892 * Wildcards in the types are acceptable.
1894 * @param array $cprefs Client's acceptable type list
1895 * @param array $sprefs Server's offered types
1898 * @todo FIXME: Doesn't handle params like 'text/plain; charset=UTF-8'
1899 * XXX: generalize to negotiate other stuff
1901 function wfNegotiateType( $cprefs, $sprefs ) {
1904 foreach ( array_keys( $sprefs ) as $type ) {
1905 $subType = explode( '/', $type )[1];
1906 if ( $subType != '*' ) {
1907 $ckey = mimeTypeMatch( $type, $cprefs );
1909 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1914 foreach ( array_keys( $cprefs ) as $type ) {
1915 $subType = explode( '/', $type )[1];
1916 if ( $subType != '*' && !array_key_exists( $type, $sprefs ) ) {
1917 $skey = mimeTypeMatch( $type, $sprefs );
1919 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1927 foreach ( array_keys( $combine ) as $type ) {
1928 if ( $combine[$type] > $bestq ) {
1930 $bestq = $combine[$type];
1938 * Reference-counted warning suppression
1940 * @deprecated since 1.26, use Wikimedia\suppressWarnings() directly
1943 function wfSuppressWarnings( $end = false ) {
1944 Wikimedia\
suppressWarnings( $end );
1948 * @deprecated since 1.26, use Wikimedia\restoreWarnings() directly
1949 * Restore error level to previous value
1951 function wfRestoreWarnings() {
1952 Wikimedia\restoreWarnings
();
1956 * Get a timestamp string in one of various formats
1958 * @param mixed $outputtype A timestamp in one of the supported formats, the
1959 * function will autodetect which format is supplied and act accordingly.
1960 * @param mixed $ts Optional timestamp to convert, default 0 for the current time
1961 * @return string|bool String / false The same date in the format specified in $outputtype or false
1963 function wfTimestamp( $outputtype = TS_UNIX
, $ts = 0 ) {
1964 $ret = MWTimestamp
::convert( $outputtype, $ts );
1965 if ( $ret === false ) {
1966 wfDebug( "wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n" );
1972 * Return a formatted timestamp, or null if input is null.
1973 * For dealing with nullable timestamp columns in the database.
1975 * @param int $outputtype
1976 * @param string|null $ts
1979 function wfTimestampOrNull( $outputtype = TS_UNIX
, $ts = null ) {
1980 if ( is_null( $ts ) ) {
1983 return wfTimestamp( $outputtype, $ts );
1988 * Convenience function; returns MediaWiki timestamp for the present time.
1992 function wfTimestampNow() {
1994 return MWTimestamp
::now( TS_MW
);
1998 * Check if the operating system is Windows
2000 * @return bool True if it's Windows, false otherwise.
2002 function wfIsWindows() {
2003 static $isWindows = null;
2004 if ( $isWindows === null ) {
2005 $isWindows = strtoupper( substr( PHP_OS
, 0, 3 ) ) === 'WIN';
2011 * Check if we are running under HHVM
2015 function wfIsHHVM() {
2016 return defined( 'HHVM_VERSION' );
2020 * Check if we are running from the commandline
2025 function wfIsCLI() {
2026 return PHP_SAPI
=== 'cli' || PHP_SAPI
=== 'phpdbg';
2030 * Tries to get the system directory for temporary files. First
2031 * $wgTmpDirectory is checked, and then the TMPDIR, TMP, and TEMP
2032 * environment variables are then checked in sequence, then
2033 * sys_get_temp_dir(), then upload_tmp_dir from php.ini.
2035 * NOTE: When possible, use instead the tmpfile() function to create
2036 * temporary files to avoid race conditions on file creation, etc.
2040 function wfTempDir() {
2041 global $wgTmpDirectory;
2043 if ( $wgTmpDirectory !== false ) {
2044 return $wgTmpDirectory;
2047 return TempFSFile
::getUsableTempDirectory();
2051 * Make directory, and make all parent directories if they don't exist
2053 * @param string $dir Full path to directory to create
2054 * @param int|null $mode Chmod value to use, default is $wgDirectoryMode
2055 * @param string|null $caller Optional caller param for debugging.
2056 * @throws MWException
2059 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2060 global $wgDirectoryMode;
2062 if ( FileBackend
::isStoragePath( $dir ) ) { // sanity
2063 throw new MWException( __FUNCTION__
. " given storage path '$dir'." );
2066 if ( !is_null( $caller ) ) {
2067 wfDebug( "$caller: called wfMkdirParents($dir)\n" );
2070 if ( strval( $dir ) === '' ||
is_dir( $dir ) ) {
2074 $dir = str_replace( [ '\\', '/' ], DIRECTORY_SEPARATOR
, $dir );
2076 if ( is_null( $mode ) ) {
2077 $mode = $wgDirectoryMode;
2080 // Turn off the normal warning, we're doing our own below
2081 Wikimedia\
suppressWarnings();
2082 $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2083 Wikimedia\restoreWarnings
();
2086 // directory may have been created on another request since we last checked
2087 if ( is_dir( $dir ) ) {
2091 // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2092 wfLogWarning( sprintf( "failed to mkdir \"%s\" mode 0%o", $dir, $mode ) );
2098 * Remove a directory and all its content.
2099 * Does not hide error.
2100 * @param string $dir
2102 function wfRecursiveRemoveDir( $dir ) {
2103 wfDebug( __FUNCTION__
. "( $dir )\n" );
2104 // taken from https://secure.php.net/manual/en/function.rmdir.php#98622
2105 if ( is_dir( $dir ) ) {
2106 $objects = scandir( $dir );
2107 foreach ( $objects as $object ) {
2108 if ( $object != "." && $object != ".." ) {
2109 if ( filetype( $dir . '/' . $object ) == "dir" ) {
2110 wfRecursiveRemoveDir( $dir . '/' . $object );
2112 unlink( $dir . '/' . $object );
2122 * @param int $nr The number to format
2123 * @param int $acc The number of digits after the decimal point, default 2
2124 * @param bool $round Whether or not to round the value, default true
2127 function wfPercent( $nr, $acc = 2, $round = true ) {
2128 $ret = sprintf( "%.${acc}f", $nr );
2129 return $round ?
round( $ret, $acc ) . '%' : "$ret%";
2133 * Safety wrapper around ini_get() for boolean settings.
2134 * The values returned from ini_get() are pre-normalized for settings
2135 * set via php.ini or php_flag/php_admin_flag... but *not*
2136 * for those set via php_value/php_admin_value.
2138 * It's fairly common for people to use php_value instead of php_flag,
2139 * which can leave you with an 'off' setting giving a false positive
2140 * for code that just takes the ini_get() return value as a boolean.
2142 * To make things extra interesting, setting via php_value accepts
2143 * "true" and "yes" as true, but php.ini and php_flag consider them false. :)
2144 * Unrecognized values go false... again opposite PHP's own coercion
2145 * from string to bool.
2147 * Luckily, 'properly' set settings will always come back as '0' or '1',
2148 * so we only have to worry about them and the 'improper' settings.
2150 * I frickin' hate PHP... :P
2152 * @param string $setting
2155 function wfIniGetBool( $setting ) {
2156 return wfStringToBool( ini_get( $setting ) );
2160 * Convert string value to boolean, when the following are interpreted as true:
2164 * - Any number, except 0
2165 * All other strings are interpreted as false.
2167 * @param string $val
2171 function wfStringToBool( $val ) {
2172 $val = strtolower( $val );
2173 // 'on' and 'true' can't have whitespace around them, but '1' can.
2177 ||
preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2181 * Version of escapeshellarg() that works better on Windows.
2183 * Originally, this fixed the incorrect use of single quotes on Windows
2184 * (https://bugs.php.net/bug.php?id=26285) and the locale problems on Linux in
2185 * PHP 5.2.6+ (bug backported to earlier distro releases of PHP).
2187 * @param string $args,... strings to escape and glue together,
2188 * or a single array of strings parameter
2190 * @deprecated since 1.30 use MediaWiki\Shell::escape()
2192 function wfEscapeShellArg( /*...*/ ) {
2193 return Shell
::escape( ...func_get_args() );
2197 * Execute a shell command, with time and memory limits mirrored from the PHP
2198 * configuration if supported.
2200 * @param string|string[] $cmd If string, a properly shell-escaped command line,
2201 * or an array of unescaped arguments, in which case each value will be escaped
2202 * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
2203 * @param null|mixed &$retval Optional, will receive the program's exit code.
2204 * (non-zero is usually failure). If there is an error from
2205 * read, select, or proc_open(), this will be set to -1.
2206 * @param array $environ Optional environment variables which should be
2207 * added to the executed command environment.
2208 * @param array $limits Optional array with limits(filesize, memory, time, walltime)
2209 * this overwrites the global wgMaxShell* limits.
2210 * @param array $options Array of options:
2211 * - duplicateStderr: Set this to true to duplicate stderr to stdout,
2212 * including errors from limit.sh
2213 * - profileMethod: By default this function will profile based on the calling
2214 * method. Set this to a string for an alternative method to profile from
2216 * @return string Collected stdout as a string
2217 * @deprecated since 1.30 use class MediaWiki\Shell\Shell
2219 function wfShellExec( $cmd, &$retval = null, $environ = [],
2220 $limits = [], $options = []
2222 if ( Shell
::isDisabled() ) {
2224 // Backwards compatibility be upon us...
2225 return 'Unable to run external programs, proc_open() is disabled.';
2228 if ( is_array( $cmd ) ) {
2229 $cmd = Shell
::escape( $cmd );
2232 $includeStderr = isset( $options['duplicateStderr'] ) && $options['duplicateStderr'];
2233 $profileMethod = $options['profileMethod'] ??
wfGetCaller();
2236 $result = Shell
::command( [] )
2237 ->unsafeParams( (array)$cmd )
2238 ->environment( $environ )
2240 ->includeStderr( $includeStderr )
2241 ->profileMethod( $profileMethod )
2243 ->restrict( Shell
::RESTRICT_NONE
)
2245 } catch ( ProcOpenError
$ex ) {
2250 $retval = $result->getExitCode();
2252 return $result->getStdout();
2256 * Execute a shell command, returning both stdout and stderr. Convenience
2257 * function, as all the arguments to wfShellExec can become unwieldy.
2259 * @note This also includes errors from limit.sh, e.g. if $wgMaxShellFileSize is exceeded.
2260 * @param string|string[] $cmd If string, a properly shell-escaped command line,
2261 * or an array of unescaped arguments, in which case each value will be escaped
2262 * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
2263 * @param null|mixed &$retval Optional, will receive the program's exit code.
2264 * (non-zero is usually failure)
2265 * @param array $environ Optional environment variables which should be
2266 * added to the executed command environment.
2267 * @param array $limits Optional array with limits(filesize, memory, time, walltime)
2268 * this overwrites the global wgMaxShell* limits.
2269 * @return string Collected stdout and stderr as a string
2270 * @deprecated since 1.30 use class MediaWiki\Shell\Shell
2272 function wfShellExecWithStderr( $cmd, &$retval = null, $environ = [], $limits = [] ) {
2273 return wfShellExec( $cmd, $retval, $environ, $limits,
2274 [ 'duplicateStderr' => true, 'profileMethod' => wfGetCaller() ] );
2278 * Generate a shell-escaped command line string to run a MediaWiki cli script.
2279 * Note that $parameters should be a flat array and an option with an argument
2280 * should consist of two consecutive items in the array (do not use "--option value").
2282 * @deprecated since 1.31, use Shell::makeScriptCommand()
2284 * @param string $script MediaWiki cli script path
2285 * @param array $parameters Arguments and options to the script
2286 * @param array $options Associative array of options:
2287 * 'php': The path to the php executable
2288 * 'wrapper': Path to a PHP wrapper to handle the maintenance script
2291 function wfShellWikiCmd( $script, array $parameters = [], array $options = [] ) {
2293 // Give site config file a chance to run the script in a wrapper.
2294 // The caller may likely want to call wfBasename() on $script.
2295 Hooks
::run( 'wfShellWikiCmd', [ &$script, &$parameters, &$options ] );
2296 $cmd = [ $options['php'] ??
$wgPhpCli ];
2297 if ( isset( $options['wrapper'] ) ) {
2298 $cmd[] = $options['wrapper'];
2301 // Escape each parameter for shell
2302 return Shell
::escape( array_merge( $cmd, $parameters ) );
2306 * wfMerge attempts to merge differences between three texts.
2307 * Returns true for a clean merge and false for failure or a conflict.
2309 * @param string $old
2310 * @param string $mine
2311 * @param string $yours
2312 * @param string &$result
2313 * @param string|null &$mergeAttemptResult
2316 function wfMerge( $old, $mine, $yours, &$result, &$mergeAttemptResult = null ) {
2319 # This check may also protect against code injection in
2320 # case of broken installations.
2321 Wikimedia\
suppressWarnings();
2322 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
2323 Wikimedia\restoreWarnings
();
2325 if ( !$haveDiff3 ) {
2326 wfDebug( "diff3 not found\n" );
2330 # Make temporary files
2332 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2333 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
2334 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
2336 # NOTE: diff3 issues a warning to stderr if any of the files does not end with
2337 # a newline character. To avoid this, we normalize the trailing whitespace before
2338 # creating the diff.
2340 fwrite( $oldtextFile, rtrim( $old ) . "\n" );
2341 fclose( $oldtextFile );
2342 fwrite( $mytextFile, rtrim( $mine ) . "\n" );
2343 fclose( $mytextFile );
2344 fwrite( $yourtextFile, rtrim( $yours ) . "\n" );
2345 fclose( $yourtextFile );
2347 # Check for a conflict
2348 $cmd = Shell
::escape( $wgDiff3, '-a', '--overlap-only', $mytextName,
2349 $oldtextName, $yourtextName );
2350 $handle = popen( $cmd, 'r' );
2352 $mergeAttemptResult = '';
2354 $data = fread( $handle, 8192 );
2355 if ( strlen( $data ) == 0 ) {
2358 $mergeAttemptResult .= $data;
2362 $conflict = $mergeAttemptResult !== '';
2365 $cmd = Shell
::escape( $wgDiff3, '-a', '-e', '--merge', $mytextName,
2366 $oldtextName, $yourtextName );
2367 $handle = popen( $cmd, 'r' );
2370 $data = fread( $handle, 8192 );
2371 if ( strlen( $data ) == 0 ) {
2377 unlink( $mytextName );
2378 unlink( $oldtextName );
2379 unlink( $yourtextName );
2381 if ( $result === '' && $old !== '' && !$conflict ) {
2382 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
2389 * Returns unified plain-text diff of two texts.
2390 * "Useful" for machine processing of diffs.
2392 * @deprecated since 1.25, use DiffEngine/UnifiedDiffFormatter directly
2394 * @param string $before The text before the changes.
2395 * @param string $after The text after the changes.
2396 * @param string $params Command-line options for the diff command.
2397 * @return string Unified diff of $before and $after
2399 function wfDiff( $before, $after, $params = '-u' ) {
2400 if ( $before == $after ) {
2405 Wikimedia\
suppressWarnings();
2406 $haveDiff = $wgDiff && file_exists( $wgDiff );
2407 Wikimedia\restoreWarnings
();
2409 # This check may also protect against code injection in
2410 # case of broken installations.
2412 wfDebug( "diff executable not found\n" );
2413 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
2414 $format = new UnifiedDiffFormatter();
2415 return $format->format( $diffs );
2418 # Make temporary files
2420 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2421 $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
2423 fwrite( $oldtextFile, $before );
2424 fclose( $oldtextFile );
2425 fwrite( $newtextFile, $after );
2426 fclose( $newtextFile );
2428 // Get the diff of the two files
2429 $cmd = "$wgDiff " . $params . ' ' . Shell
::escape( $oldtextName, $newtextName );
2431 $h = popen( $cmd, 'r' );
2433 unlink( $oldtextName );
2434 unlink( $newtextName );
2435 throw new Exception( __METHOD__
. '(): popen() failed' );
2441 $data = fread( $h, 8192 );
2442 if ( strlen( $data ) == 0 ) {
2450 unlink( $oldtextName );
2451 unlink( $newtextName );
2453 // Kill the --- and +++ lines. They're not useful.
2454 $diff_lines = explode( "\n", $diff );
2455 if ( isset( $diff_lines[0] ) && strpos( $diff_lines[0], '---' ) === 0 ) {
2456 unset( $diff_lines[0] );
2458 if ( isset( $diff_lines[1] ) && strpos( $diff_lines[1], '+++' ) === 0 ) {
2459 unset( $diff_lines[1] );
2462 $diff = implode( "\n", $diff_lines );
2468 * This function works like "use VERSION" in Perl, the program will die with a
2469 * backtrace if the current version of PHP is less than the version provided
2471 * This is useful for extensions which due to their nature are not kept in sync
2472 * with releases, and might depend on other versions of PHP than the main code
2474 * Note: PHP might die due to parsing errors in some cases before it ever
2475 * manages to call this function, such is life
2477 * @see perldoc -f use
2479 * @param string|int|float $req_ver The version to check, can be a string, an integer, or a float
2481 * @deprecated since 1.30
2483 * @throws MWException
2485 function wfUsePHP( $req_ver ) {
2486 wfDeprecated( __FUNCTION__
, '1.30' );
2487 $php_ver = PHP_VERSION
;
2489 if ( version_compare( $php_ver, (string)$req_ver, '<' ) ) {
2490 throw new MWException( "PHP $req_ver required--this is only $php_ver" );
2495 * This function works like "use VERSION" in Perl except it checks the version
2496 * of MediaWiki, the program will die with a backtrace if the current version
2497 * of MediaWiki is less than the version provided.
2499 * This is useful for extensions which due to their nature are not kept in sync
2502 * Note: Due to the behavior of PHP's version_compare() which is used in this
2503 * function, if you want to allow the 'wmf' development versions add a 'c' (or
2504 * any single letter other than 'a', 'b' or 'p') as a post-fix to your
2505 * targeted version number. For example if you wanted to allow any variation
2506 * of 1.22 use `wfUseMW( '1.22c' )`. Using an 'a' or 'b' instead of 'c' will
2507 * not result in the same comparison due to the internal logic of
2508 * version_compare().
2510 * @see perldoc -f use
2512 * @deprecated since 1.26, use the "requires" property of extension.json
2513 * @param string|int|float $req_ver The version to check, can be a string, an integer, or a float
2514 * @throws MWException
2516 function wfUseMW( $req_ver ) {
2519 if ( version_compare( $wgVersion, (string)$req_ver, '<' ) ) {
2520 throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
2525 * Return the final portion of a pathname.
2526 * Reimplemented because PHP5's "basename()" is buggy with multibyte text.
2527 * https://bugs.php.net/bug.php?id=33898
2529 * PHP's basename() only considers '\' a pathchar on Windows and Netware.
2530 * We'll consider it so always, as we don't want '\s' in our Unix paths either.
2532 * @param string $path
2533 * @param string $suffix String to remove if present
2536 function wfBaseName( $path, $suffix = '' ) {
2537 if ( $suffix == '' ) {
2540 $encSuffix = '(?:' . preg_quote( $suffix, '#' ) . ')?';
2544 if ( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
2552 * Generate a relative path name to the given file.
2553 * May explode on non-matching case-insensitive paths,
2554 * funky symlinks, etc.
2556 * @param string $path Absolute destination path including target filename
2557 * @param string $from Absolute source path, directory only
2560 function wfRelativePath( $path, $from ) {
2561 // Normalize mixed input on Windows...
2562 $path = str_replace( '/', DIRECTORY_SEPARATOR
, $path );
2563 $from = str_replace( '/', DIRECTORY_SEPARATOR
, $from );
2565 // Trim trailing slashes -- fix for drive root
2566 $path = rtrim( $path, DIRECTORY_SEPARATOR
);
2567 $from = rtrim( $from, DIRECTORY_SEPARATOR
);
2569 $pieces = explode( DIRECTORY_SEPARATOR
, dirname( $path ) );
2570 $against = explode( DIRECTORY_SEPARATOR
, $from );
2572 if ( $pieces[0] !== $against[0] ) {
2573 // Non-matching Windows drive letters?
2574 // Return a full path.
2578 // Trim off common prefix
2579 while ( count( $pieces ) && count( $against )
2580 && $pieces[0] == $against[0] ) {
2581 array_shift( $pieces );
2582 array_shift( $against );
2585 // relative dots to bump us to the parent
2586 while ( count( $against ) ) {
2587 array_unshift( $pieces, '..' );
2588 array_shift( $against );
2591 array_push( $pieces, wfBaseName( $path ) );
2593 return implode( DIRECTORY_SEPARATOR
, $pieces );
2597 * Reset the session id
2599 * @deprecated since 1.27, use MediaWiki\Session\SessionManager instead
2602 function wfResetSessionID() {
2603 wfDeprecated( __FUNCTION__
, '1.27' );
2604 $session = SessionManager
::getGlobalSession();
2605 $delay = $session->delaySave();
2607 $session->resetId();
2609 // Make sure a session is started, since that's what the old
2610 // wfResetSessionID() did.
2611 if ( session_id() !== $session->getId() ) {
2612 wfSetupSession( $session->getId() );
2615 ScopedCallback
::consume( $delay );
2619 * Initialise php session
2621 * @deprecated since 1.27, use MediaWiki\Session\SessionManager instead.
2622 * Generally, "using" SessionManager will be calling ->getSessionById() or
2623 * ::getGlobalSession() (depending on whether you were passing $sessionId
2624 * here), then calling $session->persist().
2625 * @param bool|string $sessionId
2627 function wfSetupSession( $sessionId = false ) {
2628 wfDeprecated( __FUNCTION__
, '1.27' );
2631 session_id( $sessionId );
2634 $session = SessionManager
::getGlobalSession();
2635 $session->persist();
2637 if ( session_id() !== $session->getId() ) {
2638 session_id( $session->getId() );
2640 Wikimedia\
quietCall( 'session_start' );
2644 * Get an object from the precompiled serialized directory
2646 * @param string $name
2647 * @return mixed The variable on success, false on failure
2649 function wfGetPrecompiledData( $name ) {
2652 $file = "$IP/serialized/$name";
2653 if ( file_exists( $file ) ) {
2654 $blob = file_get_contents( $file );
2656 return unserialize( $blob );
2664 * @param string[] $data Array with string keys/values to export
2665 * @param string $header
2666 * @return string PHP code
2668 function wfMakeStaticArrayFile( array $data, $header = 'Automatically generated' ) {
2669 $format = "\t%s => %s,\n";
2671 . "// " . implode( "\n// ", explode( "\n", $header ) ) . "\n"
2673 foreach ( $data as $key => $value ) {
2676 var_export( $key, true ),
2677 var_export( $value, true )
2685 * Make a cache key for the local wiki.
2687 * @deprecated since 1.30 Call makeKey on a BagOStuff instance
2688 * @param string $args,...
2691 function wfMemcKey( /*...*/ ) {
2692 return ObjectCache
::getLocalClusterInstance()->makeKey( ...func_get_args() );
2696 * Make a cache key for a foreign DB.
2698 * Must match what wfMemcKey() would produce in context of the foreign wiki.
2701 * @param string $prefix
2702 * @param string $args,...
2705 function wfForeignMemcKey( $db, $prefix /*...*/ ) {
2706 $args = array_slice( func_get_args(), 2 );
2707 $keyspace = $prefix ?
"$db-$prefix" : $db;
2708 return ObjectCache
::getLocalClusterInstance()->makeKeyInternal( $keyspace, $args );
2712 * Make a cache key with database-agnostic prefix.
2714 * Doesn't have a wiki-specific namespace. Uses a generic 'global' prefix
2715 * instead. Must have a prefix as otherwise keys that use a database name
2716 * in the first segment will clash with wfMemcKey/wfForeignMemcKey.
2718 * @deprecated since 1.30 Call makeGlobalKey on a BagOStuff instance
2720 * @param string $args,...
2723 function wfGlobalCacheKey( /*...*/ ) {
2724 return ObjectCache
::getLocalClusterInstance()->makeGlobalKey( ...func_get_args() );
2728 * Get an ASCII string identifying this wiki
2729 * This is used as a prefix in memcached keys
2733 function wfWikiID() {
2734 global $wgDBprefix, $wgDBname;
2735 if ( $wgDBprefix ) {
2736 return "$wgDBname-$wgDBprefix";
2743 * Split a wiki ID into DB name and table prefix
2745 * @param string $wiki
2749 function wfSplitWikiID( $wiki ) {
2750 $bits = explode( '-', $wiki, 2 );
2751 if ( count( $bits ) < 2 ) {
2758 * Get a Database object.
2760 * @param int $db Index of the connection to get. May be DB_MASTER for the
2761 * master (for write queries), DB_REPLICA for potentially lagged read
2762 * queries, or an integer >= 0 for a particular server.
2764 * @param string|string[] $groups Query groups. An array of group names that this query
2765 * belongs to. May contain a single string if the query is only
2768 * @param string|bool $wiki The wiki ID, or false for the current wiki
2770 * Note: multiple calls to wfGetDB(DB_REPLICA) during the course of one request
2771 * will always return the same object, unless the underlying connection or load
2772 * balancer is manually destroyed.
2774 * Note 2: use $this->getDB() in maintenance scripts that may be invoked by
2775 * updater to ensure that a proper database is being updated.
2777 * @todo Replace calls to wfGetDB with calls to LoadBalancer::getConnection()
2778 * on an injected instance of LoadBalancer.
2780 * @return \Wikimedia\Rdbms\Database
2782 function wfGetDB( $db, $groups = [], $wiki = false ) {
2783 return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
2787 * Get a load balancer object.
2789 * @deprecated since 1.27, use MediaWikiServices::getDBLoadBalancer()
2790 * or MediaWikiServices::getDBLoadBalancerFactory() instead.
2792 * @param string|bool $wiki Wiki ID, or false for the current wiki
2793 * @return \Wikimedia\Rdbms\LoadBalancer
2795 function wfGetLB( $wiki = false ) {
2796 if ( $wiki === false ) {
2797 return MediaWikiServices
::getInstance()->getDBLoadBalancer();
2799 $factory = MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
2800 return $factory->getMainLB( $wiki );
2805 * Get the load balancer factory object
2807 * @deprecated since 1.27, use MediaWikiServices::getDBLoadBalancerFactory() instead.
2809 * @return \Wikimedia\Rdbms\LBFactory
2811 function wfGetLBFactory() {
2812 return MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
2817 * Shortcut for RepoGroup::singleton()->findFile()
2819 * @param string|Title $title String or Title object
2820 * @param array $options Associative array of options (see RepoGroup::findFile)
2821 * @return File|bool File, or false if the file does not exist
2823 function wfFindFile( $title, $options = [] ) {
2824 return RepoGroup
::singleton()->findFile( $title, $options );
2828 * Get an object referring to a locally registered file.
2829 * Returns a valid placeholder object if the file does not exist.
2831 * @param Title|string $title
2832 * @return LocalFile|null A File, or null if passed an invalid Title
2834 function wfLocalFile( $title ) {
2835 return RepoGroup
::singleton()->getLocalRepo()->newFile( $title );
2839 * Should low-performance queries be disabled?
2842 * @codeCoverageIgnore
2844 function wfQueriesMustScale() {
2845 global $wgMiserMode;
2847 ||
( SiteStats
::pages() > 100000
2848 && SiteStats
::edits() > 1000000
2849 && SiteStats
::users() > 10000 );
2853 * Get the path to a specified script file, respecting file
2854 * extensions; this is a wrapper around $wgScriptPath etc.
2855 * except for 'index' and 'load' which use $wgScript/$wgLoadScript
2857 * @param string $script Script filename, sans extension
2860 function wfScript( $script = 'index' ) {
2861 global $wgScriptPath, $wgScript, $wgLoadScript;
2862 if ( $script === 'index' ) {
2864 } elseif ( $script === 'load' ) {
2865 return $wgLoadScript;
2867 return "{$wgScriptPath}/{$script}.php";
2872 * Get the script URL.
2874 * @return string Script URL
2876 function wfGetScriptUrl() {
2877 if ( isset( $_SERVER['SCRIPT_NAME'] ) ) {
2878 /* as it was called, minus the query string.
2880 * Some sites use Apache rewrite rules to handle subdomains,
2881 * and have PHP set up in a weird way that causes PHP_SELF
2882 * to contain the rewritten URL instead of the one that the
2883 * outside world sees.
2885 * If in this mode, use SCRIPT_URL instead, which mod_rewrite
2886 * provides containing the "before" URL.
2888 return $_SERVER['SCRIPT_NAME'];
2890 return $_SERVER['URL'];
2895 * Convenience function converts boolean values into "true"
2896 * or "false" (string) values
2898 * @param bool $value
2901 function wfBoolToStr( $value ) {
2902 return $value ?
'true' : 'false';
2906 * Get a platform-independent path to the null file, e.g. /dev/null
2910 function wfGetNull() {
2911 return wfIsWindows() ?
'NUL' : '/dev/null';
2915 * Waits for the replica DBs to catch up to the master position
2917 * Use this when updating very large numbers of rows, as in maintenance scripts,
2918 * to avoid causing too much lag. Of course, this is a no-op if there are no replica DBs.
2920 * By default this waits on the main DB cluster of the current wiki.
2921 * If $cluster is set to "*" it will wait on all DB clusters, including
2922 * external ones. If the lag being waiting on is caused by the code that
2923 * does this check, it makes since to use $ifWritesSince, particularly if
2924 * cluster is "*", to avoid excess overhead.
2926 * Never call this function after a big DB write that is still in a transaction.
2927 * This only makes sense after the possible lag inducing changes were committed.
2929 * @param float|null $ifWritesSince Only wait if writes were done since this UNIX timestamp
2930 * @param string|bool $wiki Wiki identifier accepted by wfGetLB
2931 * @param string|bool $cluster Cluster name accepted by LBFactory. Default: false.
2932 * @param int|null $timeout Max wait time. Default: 1 day (cli), ~10 seconds (web)
2933 * @return bool Success (able to connect and no timeouts reached)
2934 * @deprecated since 1.27 Use LBFactory::waitForReplication
2936 function wfWaitForSlaves(
2937 $ifWritesSince = null, $wiki = false, $cluster = false, $timeout = null
2939 if ( $timeout === null ) {
2940 $timeout = wfIsCLI() ?
60 : 10;
2943 if ( $cluster === '*' ) {
2946 } elseif ( $wiki === false ) {
2951 $lbFactory = MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
2952 $lbFactory->waitForReplication( [
2954 'cluster' => $cluster,
2955 'timeout' => $timeout,
2956 // B/C: first argument used to be "max seconds of lag"; ignore such values
2957 'ifWritesSince' => ( $ifWritesSince > 1e9
) ?
$ifWritesSince : null
2959 } catch ( DBReplicationWaitError
$e ) {
2967 * Count down from $seconds to zero on the terminal, with a one-second pause
2968 * between showing each number. For use in command-line scripts.
2970 * @deprecated since 1.31, use Maintenance::countDown()
2972 * @codeCoverageIgnore
2973 * @param int $seconds
2975 function wfCountDown( $seconds ) {
2976 wfDeprecated( __FUNCTION__
, '1.31' );
2977 for ( $i = $seconds; $i >= 0; $i-- ) {
2978 if ( $i != $seconds ) {
2979 echo str_repeat( "\x08", strlen( $i +
1 ) );
2991 * Replace all invalid characters with '-'.
2992 * Additional characters can be defined in $wgIllegalFileChars (see T22489).
2993 * By default, $wgIllegalFileChars includes ':', '/', '\'.
2995 * @param string $name Filename to process
2998 function wfStripIllegalFilenameChars( $name ) {
2999 global $wgIllegalFileChars;
3000 $illegalFileChars = $wgIllegalFileChars ?
"|[" . $wgIllegalFileChars . "]" : '';
3001 $name = preg_replace(
3002 "/[^" . Title
::legalChars() . "]" . $illegalFileChars . "/",
3006 // $wgIllegalFileChars may not include '/' and '\', so we still need to do this
3007 $name = wfBaseName( $name );
3012 * Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit
3014 * @return int Resulting value of the memory limit.
3016 function wfMemoryLimit() {
3017 global $wgMemoryLimit;
3018 $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
3019 if ( $memlimit != -1 ) {
3020 $conflimit = wfShorthandToInteger( $wgMemoryLimit );
3021 if ( $conflimit == -1 ) {
3022 wfDebug( "Removing PHP's memory limit\n" );
3023 Wikimedia\
suppressWarnings();
3024 ini_set( 'memory_limit', $conflimit );
3025 Wikimedia\restoreWarnings
();
3027 } elseif ( $conflimit > $memlimit ) {
3028 wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
3029 Wikimedia\
suppressWarnings();
3030 ini_set( 'memory_limit', $conflimit );
3031 Wikimedia\restoreWarnings
();
3039 * Set PHP's time limit to the larger of php.ini or $wgTransactionalTimeLimit
3041 * @return int Prior time limit
3044 function wfTransactionalTimeLimit() {
3045 global $wgTransactionalTimeLimit;
3047 $timeLimit = ini_get( 'max_execution_time' );
3048 // Note that CLI scripts use 0
3049 if ( $timeLimit > 0 && $wgTransactionalTimeLimit > $timeLimit ) {
3050 set_time_limit( $wgTransactionalTimeLimit );
3053 ignore_user_abort( true ); // ignore client disconnects
3059 * Converts shorthand byte notation to integer form
3061 * @param string $string
3062 * @param int $default Returned if $string is empty
3065 function wfShorthandToInteger( $string = '', $default = -1 ) {
3066 $string = trim( $string );
3067 if ( $string === '' ) {
3070 $last = $string[strlen( $string ) - 1];
3071 $val = intval( $string );
3076 // break intentionally missing
3080 // break intentionally missing
3090 * Get the normalised IETF language tag
3091 * See unit test for examples.
3092 * See mediawiki.language.bcp47 for the JavaScript implementation.
3094 * @deprecated since 1.31, use LanguageCode::bcp47() directly.
3096 * @param string $code The language code.
3097 * @return string The language code which complying with BCP 47 standards.
3099 function wfBCP47( $code ) {
3100 wfDeprecated( __METHOD__
, '1.31' );
3101 return LanguageCode
::bcp47( $code );
3105 * Get a specific cache object.
3107 * @param int|string $cacheType A CACHE_* constants, or other key in $wgObjectCaches
3110 function wfGetCache( $cacheType ) {
3111 return ObjectCache
::getInstance( $cacheType );
3115 * Get the main cache object
3119 function wfGetMainCache() {
3120 global $wgMainCacheType;
3121 return ObjectCache
::getInstance( $wgMainCacheType );
3125 * Get the cache object used by the message cache
3129 function wfGetMessageCacheStorage() {
3130 global $wgMessageCacheType;
3131 return ObjectCache
::getInstance( $wgMessageCacheType );
3135 * Call hook functions defined in $wgHooks
3137 * @param string $event Event name
3138 * @param array $args Parameters passed to hook functions
3139 * @param string|null $deprecatedVersion Optionally mark hook as deprecated with version number
3141 * @return bool True if no handler aborted the hook
3142 * @deprecated since 1.25 - use Hooks::run
3144 function wfRunHooks( $event, array $args = [], $deprecatedVersion = null ) {
3145 wfDeprecated( __METHOD__
, '1.25' );
3146 return Hooks
::run( $event, $args, $deprecatedVersion );
3150 * Wrapper around php's unpack.
3152 * @param string $format The format string (See php's docs)
3153 * @param string $data A binary string of binary data
3154 * @param int|bool $length The minimum length of $data or false. This is to
3155 * prevent reading beyond the end of $data. false to disable the check.
3157 * Also be careful when using this function to read unsigned 32 bit integer
3158 * because php might make it negative.
3160 * @throws MWException If $data not long enough, or if unpack fails
3161 * @return array Associative array of the extracted data
3163 function wfUnpack( $format, $data, $length = false ) {
3164 if ( $length !== false ) {
3165 $realLen = strlen( $data );
3166 if ( $realLen < $length ) {
3167 throw new MWException( "Tried to use wfUnpack on a "
3168 . "string of length $realLen, but needed one "
3169 . "of at least length $length."
3174 Wikimedia\
suppressWarnings();
3175 $result = unpack( $format, $data );
3176 Wikimedia\restoreWarnings
();
3178 if ( $result === false ) {
3179 // If it cannot extract the packed data.
3180 throw new MWException( "unpack could not unpack binary data" );
3186 * Determine if an image exists on the 'bad image list'.
3188 * The format of MediaWiki:Bad_image_list is as follows:
3189 * * Only list items (lines starting with "*") are considered
3190 * * The first link on a line must be a link to a bad image
3191 * * Any subsequent links on the same line are considered to be exceptions,
3192 * i.e. articles where the image may occur inline.
3194 * @param string $name The image name to check
3195 * @param Title|bool $contextTitle The page on which the image occurs, if known
3196 * @param string|null $blacklist Wikitext of a file blacklist
3199 function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
3200 # Handle redirects; callers almost always hit wfFindFile() anyway,
3201 # so just use that method because it has a fast process cache.
3202 $file = wfFindFile( $name ); // get the final name
3203 $name = $file ?
$file->getTitle()->getDBkey() : $name;
3205 # Run the extension hook
3207 if ( !Hooks
::run( 'BadImage', [ $name, &$bad ] ) ) {
3211 $cache = ObjectCache
::getLocalServerInstance( 'hash' );
3212 $key = $cache->makeKey(
3213 'bad-image-list', ( $blacklist === null ) ?
'default' : md5( $blacklist )
3215 $badImages = $cache->get( $key );
3217 if ( $badImages === false ) { // cache miss
3218 if ( $blacklist === null ) {
3219 $blacklist = wfMessage( 'bad_image_list' )->inContentLanguage()->plain(); // site list
3221 # Build the list now
3223 $lines = explode( "\n", $blacklist );
3224 foreach ( $lines as $line ) {
3226 if ( substr( $line, 0, 1 ) !== '*' ) {
3232 if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
3237 $imageDBkey = false;
3238 foreach ( $m[1] as $i => $titleText ) {
3239 $title = Title
::newFromText( $titleText );
3240 if ( !is_null( $title ) ) {
3242 $imageDBkey = $title->getDBkey();
3244 $exceptions[$title->getPrefixedDBkey()] = true;
3249 if ( $imageDBkey !== false ) {
3250 $badImages[$imageDBkey] = $exceptions;
3253 $cache->set( $key, $badImages, 60 );
3256 $contextKey = $contextTitle ?
$contextTitle->getPrefixedDBkey() : false;
3257 $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
3263 * Determine whether the client at a given source IP is likely to be able to
3264 * access the wiki via HTTPS.
3266 * @param string $ip The IPv4/6 address in the normal human-readable form
3269 function wfCanIPUseHTTPS( $ip ) {
3271 Hooks
::run( 'CanIPUseHTTPS', [ $ip, &$canDo ] );
3276 * Determine input string is represents as infinity
3278 * @param string $str The string to determine
3282 function wfIsInfinity( $str ) {
3283 // These are hardcoded elsewhere in MediaWiki (e.g. mediawiki.special.block.js).
3284 $infinityValues = [ 'infinite', 'indefinite', 'infinity', 'never' ];
3285 return in_array( $str, $infinityValues );
3289 * Returns true if these thumbnail parameters match one that MediaWiki
3290 * requests from file description pages and/or parser output.
3292 * $params is considered non-standard if they involve a non-standard
3293 * width or any non-default parameters aside from width and page number.
3294 * The number of possible files with standard parameters is far less than
3295 * that of all combinations; rate-limiting for them can thus be more generious.
3298 * @param array $params
3300 * @since 1.24 Moved from thumb.php to GlobalFunctions in 1.25
3302 function wfThumbIsStandard( File
$file, array $params ) {
3303 global $wgThumbLimits, $wgImageLimits, $wgResponsiveImages;
3305 $multipliers = [ 1 ];
3306 if ( $wgResponsiveImages ) {
3307 // These available sizes are hardcoded currently elsewhere in MediaWiki.
3308 // @see Linker::processResponsiveImages
3309 $multipliers[] = 1.5;
3313 $handler = $file->getHandler();
3314 if ( !$handler ||
!isset( $params['width'] ) ) {
3319 if ( isset( $params['page'] ) ) {
3320 $basicParams['page'] = $params['page'];
3325 // Expand limits to account for multipliers
3326 foreach ( $multipliers as $multiplier ) {
3327 $thumbLimits = array_merge( $thumbLimits, array_map(
3328 function ( $width ) use ( $multiplier ) {
3329 return round( $width * $multiplier );
3332 $imageLimits = array_merge( $imageLimits, array_map(
3333 function ( $pair ) use ( $multiplier ) {
3335 round( $pair[0] * $multiplier ),
3336 round( $pair[1] * $multiplier ),
3342 // Check if the width matches one of $wgThumbLimits
3343 if ( in_array( $params['width'], $thumbLimits ) ) {
3344 $normalParams = $basicParams +
[ 'width' => $params['width'] ];
3345 // Append any default values to the map (e.g. "lossy", "lossless", ...)
3346 $handler->normaliseParams( $file, $normalParams );
3348 // If not, then check if the width matchs one of $wgImageLimits
3350 foreach ( $imageLimits as $pair ) {
3351 $normalParams = $basicParams +
[ 'width' => $pair[0], 'height' => $pair[1] ];
3352 // Decide whether the thumbnail should be scaled on width or height.
3353 // Also append any default values to the map (e.g. "lossy", "lossless", ...)
3354 $handler->normaliseParams( $file, $normalParams );
3355 // Check if this standard thumbnail size maps to the given width
3356 if ( $normalParams['width'] == $params['width'] ) {
3362 return false; // not standard for description pages
3366 // Check that the given values for non-page, non-width, params are just defaults
3367 foreach ( $params as $key => $value ) {
3368 if ( !isset( $normalParams[$key] ) ||
$normalParams[$key] != $value ) {
3377 * Merges two (possibly) 2 dimensional arrays into the target array ($baseArray).
3379 * Values that exist in both values will be combined with += (all values of the array
3380 * of $newValues will be added to the values of the array of $baseArray, while values,
3381 * that exists in both, the value of $baseArray will be used).
3383 * @param array $baseArray The array where you want to add the values of $newValues to
3384 * @param array $newValues An array with new values
3385 * @return array The combined array
3388 function wfArrayPlus2d( array $baseArray, array $newValues ) {
3389 // First merge items that are in both arrays
3390 foreach ( $baseArray as $name => &$groupVal ) {
3391 if ( isset( $newValues[$name] ) ) {
3392 $groupVal +
= $newValues[$name];
3395 // Now add items that didn't exist yet
3396 $baseArray +
= $newValues;
3402 * Get system resource usage of current request context.
3403 * Invokes the getrusage(2) system call, requesting RUSAGE_SELF if on PHP5
3404 * or RUSAGE_THREAD if on HHVM. Returns false if getrusage is not available.
3407 * @return array|bool Resource usage data or false if no data available.
3409 function wfGetRusage() {
3410 if ( !function_exists( 'getrusage' ) ) {
3412 } elseif ( defined( 'HHVM_VERSION' ) && PHP_OS
=== 'Linux' ) {
3413 return getrusage( 2 /* RUSAGE_THREAD */ );
3415 return getrusage( 0 /* RUSAGE_SELF */ );