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 // Hide compatibility functions from Doxygen
31 * Compatibility functions
33 * We support PHP 5.3.2 and up.
34 * Re-implementations of newer functions or functions in non-standard
35 * PHP extensions may be included here.
38 if ( !function_exists( 'iconv' ) ) {
43 function iconv( $from, $to, $string ) {
44 return Fallback
::iconv( $from, $to, $string );
48 if ( !function_exists( 'mb_substr' ) ) {
53 function mb_substr( $str, $start, $count = 'end' ) {
54 return Fallback
::mb_substr( $str, $start, $count );
61 function mb_substr_split_unicode( $str, $splitPos ) {
62 return Fallback
::mb_substr_split_unicode( $str, $splitPos );
66 if ( !function_exists( 'mb_strlen' ) ) {
71 function mb_strlen( $str, $enc = '' ) {
72 return Fallback
::mb_strlen( $str, $enc );
76 if ( !function_exists( 'mb_strpos' ) ) {
81 function mb_strpos( $haystack, $needle, $offset = 0, $encoding = '' ) {
82 return Fallback
::mb_strpos( $haystack, $needle, $offset, $encoding );
86 if ( !function_exists( 'mb_strrpos' ) ) {
91 function mb_strrpos( $haystack, $needle, $offset = 0, $encoding = '' ) {
92 return Fallback
::mb_strrpos( $haystack, $needle, $offset, $encoding );
96 // gzdecode function only exists in PHP >= 5.4.0
97 // http://php.net/gzdecode
98 if ( !function_exists( 'gzdecode' ) ) {
100 * @codeCoverageIgnore
103 function gzdecode( $data ) {
104 return gzinflate( substr( $data, 10, -8 ) );
110 * Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
115 function wfArrayDiff2( $a, $b ) {
116 return array_udiff( $a, $b, 'wfArrayDiff2_cmp' );
120 * @param $a array|string
121 * @param $b array|string
124 function wfArrayDiff2_cmp( $a, $b ) {
125 if ( is_string( $a ) && is_string( $b ) ) {
126 return strcmp( $a, $b );
127 } elseif ( count( $a ) !== count( $b ) ) {
128 return count( $a ) < count( $b ) ?
-1 : 1;
132 while ( ( list( , $valueA ) = each( $a ) ) && ( list( , $valueB ) = each( $b ) ) ) {
133 $cmp = strcmp( $valueA, $valueB );
144 * Returns an array where the values in array $b are replaced by the
145 * values in array $a with the corresponding keys
147 * @deprecated since 1.22; use array_intersect_key()
152 function wfArrayLookup( $a, $b ) {
153 wfDeprecated( __FUNCTION__
, '1.22' );
154 return array_flip( array_intersect( array_flip( $a ), array_keys( $b ) ) );
158 * Appends to second array if $value differs from that in $default
160 * @param $key String|Int
161 * @param $value Mixed
162 * @param $default Mixed
163 * @param array $changed to alter
164 * @throws MWException
166 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
167 if ( is_null( $changed ) ) {
168 throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' );
170 if ( $default[$key] !== $value ) {
171 $changed[$key] = $value;
176 * Backwards array plus for people who haven't bothered to read the PHP manual
177 * XXX: will not darn your socks for you.
179 * @deprecated since 1.22; use array_replace()
181 * @param array $array1 Initial array to merge.
182 * @param array [$array2,...] Variable list of arrays to merge.
185 function wfArrayMerge( $array1 /*...*/ ) {
186 wfDeprecated( __FUNCTION__
, '1.22' );
187 $args = func_get_args();
188 $args = array_reverse( $args, true );
190 foreach ( $args as $arg ) {
197 * Merge arrays in the style of getUserPermissionsErrors, with duplicate removal
199 * wfMergeErrorArrays(
200 * array( array( 'x' ) ),
201 * array( array( 'x', '2' ) ),
202 * array( array( 'x' ) ),
203 * array( array( 'y' ) )
212 * @param array [$array1,...]
215 function wfMergeErrorArrays( /*...*/ ) {
216 $args = func_get_args();
218 foreach ( $args as $errors ) {
219 foreach ( $errors as $params ) {
220 # @todo FIXME: Sometimes get nested arrays for $params,
221 # which leads to E_NOTICEs
222 $spec = implode( "\t", $params );
223 $out[$spec] = $params;
226 return array_values( $out );
230 * Insert array into another array after the specified *KEY*
232 * @param array $array The array.
233 * @param array $insert The array to insert.
234 * @param $after Mixed: The key to insert after
237 function wfArrayInsertAfter( array $array, array $insert, $after ) {
238 // Find the offset of the element to insert after.
239 $keys = array_keys( $array );
240 $offsetByKey = array_flip( $keys );
242 $offset = $offsetByKey[$after];
244 // Insert at the specified offset
245 $before = array_slice( $array, 0, $offset +
1, true );
246 $after = array_slice( $array, $offset +
1, count( $array ) - $offset, true );
248 $output = $before +
$insert +
$after;
254 * Recursively converts the parameter (an object) to an array with the same data
256 * @param $objOrArray Object|Array
257 * @param $recursive Bool
260 function wfObjectToArray( $objOrArray, $recursive = true ) {
262 if ( is_object( $objOrArray ) ) {
263 $objOrArray = get_object_vars( $objOrArray );
265 foreach ( $objOrArray as $key => $value ) {
266 if ( $recursive && ( is_object( $value ) ||
is_array( $value ) ) ) {
267 $value = wfObjectToArray( $value );
270 $array[$key] = $value;
277 * Get a random decimal value between 0 and 1, in a way
278 * not likely to give duplicate values for any realistic
279 * number of articles.
283 function wfRandom() {
284 # The maximum random value is "only" 2^31-1, so get two random
285 # values to reduce the chance of dupes
286 $max = mt_getrandmax() +
1;
287 $rand = number_format( ( mt_rand() * $max +
mt_rand() ) / $max / $max, 12, '.', '' );
293 * Get a random string containing a number of pseudo-random hex
295 * @note This is not secure, if you are trying to generate some sort
296 * of token please use MWCryptRand instead.
298 * @param int $length The length of the string to generate
302 function wfRandomString( $length = 32 ) {
304 for ( $n = 0; $n < $length; $n +
= 7 ) {
305 $str .= sprintf( '%07x', mt_rand() & 0xfffffff );
307 return substr( $str, 0, $length );
311 * We want some things to be included as literal characters in our title URLs
312 * for prettiness, which urlencode encodes by default. According to RFC 1738,
313 * all of the following should be safe:
317 * But + is not safe because it's used to indicate a space; &= are only safe in
318 * paths and not in queries (and we don't distinguish here); ' seems kind of
319 * scary; and urlencode() doesn't touch -_. to begin with. Plus, although /
320 * is reserved, we don't care. So the list we unescape is:
324 * However, IIS7 redirects fail when the url contains a colon (Bug 22709),
325 * so no fancy : for IIS7.
327 * %2F in the page titles seems to fatally break for some reason.
332 function wfUrlencode( $s ) {
335 if ( is_null( $s ) ) {
340 if ( is_null( $needle ) ) {
341 $needle = array( '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F' );
342 if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) ||
343 ( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false )
349 $s = urlencode( $s );
352 array( ';', '@', '$', '!', '*', '(', ')', ',', '/', ':' ),
360 * This function takes two arrays as input, and returns a CGI-style string, e.g.
361 * "days=7&limit=100". Options in the first array override options in the second.
362 * Options set to null or false will not be output.
364 * @param array $array1 ( String|Array )
365 * @param array $array2 ( String|Array )
366 * @param $prefix String
369 function wfArrayToCgi( $array1, $array2 = null, $prefix = '' ) {
370 if ( !is_null( $array2 ) ) {
371 $array1 = $array1 +
$array2;
375 foreach ( $array1 as $key => $value ) {
376 if ( !is_null( $value ) && $value !== false ) {
380 if ( $prefix !== '' ) {
381 $key = $prefix . "[$key]";
383 if ( is_array( $value ) ) {
385 foreach ( $value as $k => $v ) {
386 $cgi .= $firstTime ?
'' : '&';
387 if ( is_array( $v ) ) {
388 $cgi .= wfArrayToCgi( $v, null, $key . "[$k]" );
390 $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v );
395 if ( is_object( $value ) ) {
396 $value = $value->__toString();
398 $cgi .= urlencode( $key ) . '=' . urlencode( $value );
406 * This is the logical opposite of wfArrayToCgi(): it accepts a query string as
407 * its argument and returns the same string in array form. This allows compatibility
408 * with legacy functions that accept raw query strings instead of nice
409 * arrays. Of course, keys and values are urldecode()d.
411 * @param string $query query string
412 * @return string[] Array version of input
414 function wfCgiToArray( $query ) {
415 if ( isset( $query[0] ) && $query[0] == '?' ) {
416 $query = substr( $query, 1 );
418 $bits = explode( '&', $query );
420 foreach ( $bits as $bit ) {
424 if ( strpos( $bit, '=' ) === false ) {
425 // Pieces like &qwerty become 'qwerty' => '' (at least this is what php does)
429 list( $key, $value ) = explode( '=', $bit );
431 $key = urldecode( $key );
432 $value = urldecode( $value );
433 if ( strpos( $key, '[' ) !== false ) {
434 $keys = array_reverse( explode( '[', $key ) );
435 $key = array_pop( $keys );
437 foreach ( $keys as $k ) {
438 $k = substr( $k, 0, -1 );
439 $temp = array( $k => $temp );
441 if ( isset( $ret[$key] ) ) {
442 $ret[$key] = array_merge( $ret[$key], $temp );
454 * Append a query string to an existing URL, which may or may not already
455 * have query string parameters already. If so, they will be combined.
458 * @param string|string[] $query String or associative array
461 function wfAppendQuery( $url, $query ) {
462 if ( is_array( $query ) ) {
463 $query = wfArrayToCgi( $query );
465 if ( $query != '' ) {
466 if ( false === strpos( $url, '?' ) ) {
477 * Expand a potentially local URL to a fully-qualified URL. Assumes $wgServer
480 * The meaning of the PROTO_* constants is as follows:
481 * PROTO_HTTP: Output a URL starting with http://
482 * PROTO_HTTPS: Output a URL starting with https://
483 * PROTO_RELATIVE: Output a URL starting with // (protocol-relative URL)
484 * PROTO_CURRENT: Output a URL starting with either http:// or https:// , depending
485 * on which protocol was used for the current incoming request
486 * PROTO_CANONICAL: For URLs without a domain, like /w/index.php , use $wgCanonicalServer.
487 * For protocol-relative URLs, use the protocol of $wgCanonicalServer
488 * PROTO_INTERNAL: Like PROTO_CANONICAL, but uses $wgInternalServer instead of $wgCanonicalServer
490 * @todo this won't work with current-path-relative URLs
491 * like "subdir/foo.html", etc.
493 * @param string $url either fully-qualified or a local path + query
494 * @param $defaultProto Mixed: one of the PROTO_* constants. Determines the
495 * protocol to use if $url or $wgServer is protocol-relative
496 * @return string Fully-qualified URL, current-path-relative URL or false if
497 * no valid URL can be constructed
499 function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT
) {
500 global $wgServer, $wgCanonicalServer, $wgInternalServer, $wgRequest;
501 if ( $defaultProto === PROTO_CANONICAL
) {
502 $serverUrl = $wgCanonicalServer;
503 } elseif ( $defaultProto === PROTO_INTERNAL
&& $wgInternalServer !== false ) {
504 // Make $wgInternalServer fall back to $wgServer if not set
505 $serverUrl = $wgInternalServer;
507 $serverUrl = $wgServer;
508 if ( $defaultProto === PROTO_CURRENT
) {
509 $defaultProto = $wgRequest->getProtocol() . '://';
513 // Analyze $serverUrl to obtain its protocol
514 $bits = wfParseUrl( $serverUrl );
515 $serverHasProto = $bits && $bits['scheme'] != '';
517 if ( $defaultProto === PROTO_CANONICAL ||
$defaultProto === PROTO_INTERNAL
) {
518 if ( $serverHasProto ) {
519 $defaultProto = $bits['scheme'] . '://';
521 // $wgCanonicalServer or $wgInternalServer doesn't have a protocol.
522 // This really isn't supposed to happen. Fall back to HTTP in this
524 $defaultProto = PROTO_HTTP
;
528 $defaultProtoWithoutSlashes = substr( $defaultProto, 0, -2 );
530 if ( substr( $url, 0, 2 ) == '//' ) {
531 $url = $defaultProtoWithoutSlashes . $url;
532 } elseif ( substr( $url, 0, 1 ) == '/' ) {
533 // If $serverUrl is protocol-relative, prepend $defaultProtoWithoutSlashes,
534 // otherwise leave it alone.
535 $url = ( $serverHasProto ?
'' : $defaultProtoWithoutSlashes ) . $serverUrl . $url;
538 $bits = wfParseUrl( $url );
539 if ( $bits && isset( $bits['path'] ) ) {
540 $bits['path'] = wfRemoveDotSegments( $bits['path'] );
541 return wfAssembleUrl( $bits );
545 } elseif ( substr( $url, 0, 1 ) != '/' ) {
546 # URL is a relative path
547 return wfRemoveDotSegments( $url );
550 # Expanded URL is not valid.
555 * This function will reassemble a URL parsed with wfParseURL. This is useful
556 * if you need to edit part of a URL and put it back together.
558 * This is the basic structure used (brackets contain keys for $urlParts):
559 * [scheme][delimiter][user]:[pass]@[host]:[port][path]?[query]#[fragment]
561 * @todo Need to integrate this into wfExpandUrl (bug 32168)
564 * @param array $urlParts URL parts, as output from wfParseUrl
565 * @return string URL assembled from its component parts
567 function wfAssembleUrl( $urlParts ) {
570 if ( isset( $urlParts['delimiter'] ) ) {
571 if ( isset( $urlParts['scheme'] ) ) {
572 $result .= $urlParts['scheme'];
575 $result .= $urlParts['delimiter'];
578 if ( isset( $urlParts['host'] ) ) {
579 if ( isset( $urlParts['user'] ) ) {
580 $result .= $urlParts['user'];
581 if ( isset( $urlParts['pass'] ) ) {
582 $result .= ':' . $urlParts['pass'];
587 $result .= $urlParts['host'];
589 if ( isset( $urlParts['port'] ) ) {
590 $result .= ':' . $urlParts['port'];
594 if ( isset( $urlParts['path'] ) ) {
595 $result .= $urlParts['path'];
598 if ( isset( $urlParts['query'] ) ) {
599 $result .= '?' . $urlParts['query'];
602 if ( isset( $urlParts['fragment'] ) ) {
603 $result .= '#' . $urlParts['fragment'];
610 * Remove all dot-segments in the provided URL path. For example,
611 * '/a/./b/../c/' becomes '/a/c/'. For details on the algorithm, please see
612 * RFC3986 section 5.2.4.
614 * @todo Need to integrate this into wfExpandUrl (bug 32168)
616 * @param string $urlPath URL path, potentially containing dot-segments
617 * @return string URL path with all dot-segments removed
619 function wfRemoveDotSegments( $urlPath ) {
622 $inputLength = strlen( $urlPath );
624 while ( $inputOffset < $inputLength ) {
625 $prefixLengthOne = substr( $urlPath, $inputOffset, 1 );
626 $prefixLengthTwo = substr( $urlPath, $inputOffset, 2 );
627 $prefixLengthThree = substr( $urlPath, $inputOffset, 3 );
628 $prefixLengthFour = substr( $urlPath, $inputOffset, 4 );
631 if ( $prefixLengthTwo == './' ) {
632 # Step A, remove leading "./"
634 } elseif ( $prefixLengthThree == '../' ) {
635 # Step A, remove leading "../"
637 } elseif ( ( $prefixLengthTwo == '/.' ) && ( $inputOffset +
2 == $inputLength ) ) {
638 # Step B, replace leading "/.$" with "/"
640 $urlPath[$inputOffset] = '/';
641 } elseif ( $prefixLengthThree == '/./' ) {
642 # Step B, replace leading "/./" with "/"
644 } elseif ( $prefixLengthThree == '/..' && ( $inputOffset +
3 == $inputLength ) ) {
645 # Step C, replace leading "/..$" with "/" and
646 # remove last path component in output
648 $urlPath[$inputOffset] = '/';
650 } elseif ( $prefixLengthFour == '/../' ) {
651 # Step C, replace leading "/../" with "/" and
652 # remove last path component in output
655 } elseif ( ( $prefixLengthOne == '.' ) && ( $inputOffset +
1 == $inputLength ) ) {
656 # Step D, remove "^.$"
658 } elseif ( ( $prefixLengthTwo == '..' ) && ( $inputOffset +
2 == $inputLength ) ) {
659 # Step D, remove "^..$"
662 # Step E, move leading path segment to output
663 if ( $prefixLengthOne == '/' ) {
664 $slashPos = strpos( $urlPath, '/', $inputOffset +
1 );
666 $slashPos = strpos( $urlPath, '/', $inputOffset );
668 if ( $slashPos === false ) {
669 $output .= substr( $urlPath, $inputOffset );
670 $inputOffset = $inputLength;
672 $output .= substr( $urlPath, $inputOffset, $slashPos - $inputOffset );
673 $inputOffset +
= $slashPos - $inputOffset;
678 $slashPos = strrpos( $output, '/' );
679 if ( $slashPos === false ) {
682 $output = substr( $output, 0, $slashPos );
691 * Returns a regular expression of url protocols
693 * @param bool $includeProtocolRelative If false, remove '//' from the returned protocol list.
694 * DO NOT USE this directly, use wfUrlProtocolsWithoutProtRel() instead
697 function wfUrlProtocols( $includeProtocolRelative = true ) {
698 global $wgUrlProtocols;
700 // Cache return values separately based on $includeProtocolRelative
701 static $withProtRel = null, $withoutProtRel = null;
702 $cachedValue = $includeProtocolRelative ?
$withProtRel : $withoutProtRel;
703 if ( !is_null( $cachedValue ) ) {
707 // Support old-style $wgUrlProtocols strings, for backwards compatibility
708 // with LocalSettings files from 1.5
709 if ( is_array( $wgUrlProtocols ) ) {
710 $protocols = array();
711 foreach ( $wgUrlProtocols as $protocol ) {
712 // Filter out '//' if !$includeProtocolRelative
713 if ( $includeProtocolRelative ||
$protocol !== '//' ) {
714 $protocols[] = preg_quote( $protocol, '/' );
718 $retval = implode( '|', $protocols );
720 // Ignore $includeProtocolRelative in this case
721 // This case exists for pre-1.6 compatibility, and we can safely assume
722 // that '//' won't appear in a pre-1.6 config because protocol-relative
723 // URLs weren't supported until 1.18
724 $retval = $wgUrlProtocols;
727 // Cache return value
728 if ( $includeProtocolRelative ) {
729 $withProtRel = $retval;
731 $withoutProtRel = $retval;
737 * Like wfUrlProtocols(), but excludes '//' from the protocol list. Use this if
738 * you need a regex that matches all URL protocols but does not match protocol-
742 function wfUrlProtocolsWithoutProtRel() {
743 return wfUrlProtocols( false );
747 * parse_url() work-alike, but non-broken. Differences:
749 * 1) Does not raise warnings on bad URLs (just returns false).
750 * 2) Handles protocols that don't use :// (e.g., mailto: and news:, as well as
751 * protocol-relative URLs) correctly.
752 * 3) Adds a "delimiter" element to the array, either '://', ':' or '//' (see (2)).
754 * @param string $url a URL to parse
755 * @return string[] Bits of the URL in an associative array, per PHP docs
757 function wfParseUrl( $url ) {
758 global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
760 // Protocol-relative URLs are handled really badly by parse_url(). It's so
761 // bad that the easiest way to handle them is to just prepend 'http:' and
762 // strip the protocol out later.
763 $wasRelative = substr( $url, 0, 2 ) == '//';
764 if ( $wasRelative ) {
767 wfSuppressWarnings();
768 $bits = parse_url( $url );
770 // parse_url() returns an array without scheme for some invalid URLs, e.g.
771 // parse_url("%0Ahttp://example.com") == array( 'host' => '%0Ahttp', 'path' => 'example.com' )
772 if ( !$bits ||
!isset( $bits['scheme'] ) ) {
776 // parse_url() incorrectly handles schemes case-sensitively. Convert it to lowercase.
777 $bits['scheme'] = strtolower( $bits['scheme'] );
779 // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
780 if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
781 $bits['delimiter'] = '://';
782 } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
783 $bits['delimiter'] = ':';
784 // parse_url detects for news: and mailto: the host part of an url as path
785 // We have to correct this wrong detection
786 if ( isset( $bits['path'] ) ) {
787 $bits['host'] = $bits['path'];
794 /* Provide an empty host for eg. file:/// urls (see bug 28627) */
795 if ( !isset( $bits['host'] ) ) {
799 if ( isset( $bits['path'] ) ) {
800 /* parse_url loses the third / for file:///c:/ urls (but not on variants) */
801 if ( substr( $bits['path'], 0, 1 ) !== '/' ) {
802 $bits['path'] = '/' . $bits['path'];
809 // If the URL was protocol-relative, fix scheme and delimiter
810 if ( $wasRelative ) {
811 $bits['scheme'] = '';
812 $bits['delimiter'] = '//';
818 * Take a URL, make sure it's expanded to fully qualified, and replace any
819 * encoded non-ASCII Unicode characters with their UTF-8 original forms
820 * for more compact display and legibility for local audiences.
822 * @todo handle punycode domains too
827 function wfExpandIRI( $url ) {
828 return preg_replace_callback(
829 '/((?:%[89A-F][0-9A-F])+)/i',
830 'wfExpandIRI_callback',
836 * Private callback for wfExpandIRI
837 * @param array $matches
840 function wfExpandIRI_callback( $matches ) {
841 return urldecode( $matches[1] );
845 * Make URL indexes, appropriate for the el_index field of externallinks.
850 function wfMakeUrlIndexes( $url ) {
851 $bits = wfParseUrl( $url );
853 // Reverse the labels in the hostname, convert to lower case
854 // For emails reverse domainpart only
855 if ( $bits['scheme'] == 'mailto' ) {
856 $mailparts = explode( '@', $bits['host'], 2 );
857 if ( count( $mailparts ) === 2 ) {
858 $domainpart = strtolower( implode( '.', array_reverse( explode( '.', $mailparts[1] ) ) ) );
860 // No domain specified, don't mangle it
863 $reversedHost = $domainpart . '@' . $mailparts[0];
865 $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) );
867 // Add an extra dot to the end
868 // Why? Is it in wrong place in mailto links?
869 if ( substr( $reversedHost, -1, 1 ) !== '.' ) {
870 $reversedHost .= '.';
872 // Reconstruct the pseudo-URL
873 $prot = $bits['scheme'];
874 $index = $prot . $bits['delimiter'] . $reversedHost;
875 // Leave out user and password. Add the port, path, query and fragment
876 if ( isset( $bits['port'] ) ) {
877 $index .= ':' . $bits['port'];
879 if ( isset( $bits['path'] ) ) {
880 $index .= $bits['path'];
884 if ( isset( $bits['query'] ) ) {
885 $index .= '?' . $bits['query'];
887 if ( isset( $bits['fragment'] ) ) {
888 $index .= '#' . $bits['fragment'];
892 return array( "http:$index", "https:$index" );
894 return array( $index );
899 * Check whether a given URL has a domain that occurs in a given set of domains
900 * @param string $url URL
901 * @param array $domains Array of domains (strings)
902 * @return bool True if the host part of $url ends in one of the strings in $domains
904 function wfMatchesDomainList( $url, $domains ) {
905 $bits = wfParseUrl( $url );
906 if ( is_array( $bits ) && isset( $bits['host'] ) ) {
907 $host = '.' . $bits['host'];
908 foreach ( (array)$domains as $domain ) {
909 $domain = '.' . $domain;
910 if ( substr( $host, -strlen( $domain ) ) === $domain ) {
919 * Sends a line to the debug log if enabled or, optionally, to a comment in output.
920 * In normal operation this is a NOP.
922 * Controlling globals:
923 * $wgDebugLogFile - points to the log file
924 * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
925 * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
927 * @param $text String
928 * @param string|bool $dest Destination of the message:
929 * - 'all': both to the log and HTML (debug toolbar or HTML comments)
930 * - 'log': only to the log and not in HTML
931 * For backward compatibility, it can also take a boolean:
932 * - true: same as 'all'
933 * - false: same as 'log'
935 function wfDebug( $text, $dest = 'all' ) {
936 global $wgDebugLogFile, $wgDebugRawPage, $wgDebugLogPrefix;
938 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
942 // Turn $dest into a string if it's a boolean (for b/c)
943 if ( $dest === true ) {
945 } elseif ( $dest === false ) {
949 $timer = wfDebugTimer();
950 if ( $timer !== '' ) {
951 $text = preg_replace( '/[^\n]/', $timer . '\0', $text, 1 );
954 if ( $dest === 'all' ) {
955 MWDebug
::debugMsg( $text );
958 if ( $wgDebugLogFile != '' ) {
959 # Strip unprintables; they can switch terminal modes when binary data
960 # gets dumped, which is pretty annoying.
961 $text = preg_replace( '![\x00-\x08\x0b\x0c\x0e-\x1f]!', ' ', $text );
962 $text = $wgDebugLogPrefix . $text;
963 wfErrorLog( $text, $wgDebugLogFile );
968 * Returns true if debug logging should be suppressed if $wgDebugRawPage = false
971 function wfIsDebugRawPage() {
973 if ( $cache !== null ) {
976 # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
977 if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
979 isset( $_SERVER['SCRIPT_NAME'] )
980 && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
991 * Get microsecond timestamps for debug logs
995 function wfDebugTimer() {
996 global $wgDebugTimestamps, $wgRequestTime;
998 if ( !$wgDebugTimestamps ) {
1002 $prefix = sprintf( "%6.4f", microtime( true ) - $wgRequestTime );
1003 $mem = sprintf( "%5.1fM", ( memory_get_usage( true ) / ( 1024 * 1024 ) ) );
1004 return "$prefix $mem ";
1008 * Send a line giving PHP memory usage.
1010 * @param bool $exact print exact values instead of kilobytes (default: false)
1012 function wfDebugMem( $exact = false ) {
1013 $mem = memory_get_usage();
1015 $mem = floor( $mem / 1024 ) . ' kilobytes';
1019 wfDebug( "Memory usage: $mem\n" );
1023 * Send a line to a supplementary debug log file, if configured, or main debug log if not.
1024 * To configure a supplementary log file, set $wgDebugLogGroups[$logGroup] to a string
1025 * filename or an associative array mapping 'destination' to the desired filename. The
1026 * associative array may also contain a 'sample' key with an integer value, specifying
1027 * a sampling factor.
1029 * @since 1.23 support for sampling log messages via $wgDebugLogGroups.
1031 * @param string $logGroup
1032 * @param string $text
1033 * @param string|bool $dest Destination of the message:
1034 * - 'all': both to the log and HTML (debug toolbar or HTML comments)
1035 * - 'log': only to the log and not in HTML
1036 * - 'private': only to the specifc log if set in $wgDebugLogGroups and
1037 * discarded otherwise
1038 * For backward compatibility, it can also take a boolean:
1039 * - true: same as 'all'
1040 * - false: same as 'private'
1042 function wfDebugLog( $logGroup, $text, $dest = 'all' ) {
1043 global $wgDebugLogGroups;
1045 $text = trim( $text ) . "\n";
1047 // Turn $dest into a string if it's a boolean (for b/c)
1048 if ( $dest === true ) {
1050 } elseif ( $dest === false ) {
1054 if ( !isset( $wgDebugLogGroups[$logGroup] ) ) {
1055 if ( $dest !== 'private' ) {
1056 wfDebug( "[$logGroup] $text", $dest );
1061 if ( $dest === 'all' ) {
1062 MWDebug
::debugMsg( "[$logGroup] $text" );
1065 $logConfig = $wgDebugLogGroups[$logGroup];
1066 if ( $logConfig === false ) {
1069 if ( is_array( $logConfig ) ) {
1070 if ( isset( $logConfig['sample'] ) && mt_rand( 1, $logConfig['sample'] ) !== 1 ) {
1073 $destination = $logConfig['destination'];
1075 $destination = strval( $logConfig );
1078 $time = wfTimestamp( TS_DB
);
1080 $host = wfHostname();
1081 wfErrorLog( "$time $host $wiki: $text", $destination );
1085 * Log for database errors
1087 * @param string $text database error message.
1089 function wfLogDBError( $text ) {
1090 global $wgDBerrorLog, $wgDBerrorLogTZ;
1091 static $logDBErrorTimeZoneObject = null;
1093 if ( $wgDBerrorLog ) {
1094 $host = wfHostname();
1097 if ( $wgDBerrorLogTZ && !$logDBErrorTimeZoneObject ) {
1098 $logDBErrorTimeZoneObject = new DateTimeZone( $wgDBerrorLogTZ );
1101 // Workaround for https://bugs.php.net/bug.php?id=52063
1102 // Can be removed when min PHP > 5.3.2
1103 if ( $logDBErrorTimeZoneObject === null ) {
1104 $d = date_create( "now" );
1106 $d = date_create( "now", $logDBErrorTimeZoneObject );
1109 $date = $d->format( 'D M j G:i:s T Y' );
1111 $text = "$date\t$host\t$wiki\t" . trim( $text ) . "\n";
1112 wfErrorLog( $text, $wgDBerrorLog );
1117 * Throws a warning that $function is deprecated
1119 * @param $function String
1120 * @param string|bool $version Version of MediaWiki that the function
1121 * was deprecated in (Added in 1.19).
1122 * @param string|bool $component Added in 1.19.
1123 * @param $callerOffset integer: How far up the call stack is the original
1124 * caller. 2 = function that called the function that called
1125 * wfDeprecated (Added in 1.20)
1129 function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) {
1130 MWDebug
::deprecated( $function, $version, $component, $callerOffset +
1 );
1134 * Send a warning either to the debug log or in a PHP error depending on
1135 * $wgDevelopmentWarnings. To log warnings in production, use wfLogWarning() instead.
1137 * @param string $msg message to send
1138 * @param $callerOffset Integer: number of items to go back in the backtrace to
1139 * find the correct caller (1 = function calling wfWarn, ...)
1140 * @param $level Integer: PHP error level; defaults to E_USER_NOTICE;
1141 * only used when $wgDevelopmentWarnings is true
1143 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE
) {
1144 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'auto' );
1148 * Send a warning as a PHP error and the debug log. This is intended for logging
1149 * warnings in production. For logging development warnings, use WfWarn instead.
1151 * @param $msg String: message to send
1152 * @param $callerOffset Integer: number of items to go back in the backtrace to
1153 * find the correct caller (1 = function calling wfLogWarning, ...)
1154 * @param $level Integer: PHP error level; defaults to E_USER_WARNING
1156 function wfLogWarning( $msg, $callerOffset = 1, $level = E_USER_WARNING
) {
1157 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'production' );
1161 * Log to a file without getting "file size exceeded" signals.
1163 * Can also log to TCP or UDP with the syntax udp://host:port/prefix. This will
1164 * send lines to the specified port, prefixed by the specified prefix and a space.
1166 * @param $text String
1167 * @param string $file filename
1168 * @throws MWException
1170 function wfErrorLog( $text, $file ) {
1171 if ( substr( $file, 0, 4 ) == 'udp:' ) {
1172 # Needs the sockets extension
1173 if ( preg_match( '!^(tcp|udp):(?://)?\[([0-9a-fA-F:]+)\]:(\d+)(?:/(.*))?$!', $file, $m ) ) {
1174 // IPv6 bracketed host
1176 $port = intval( $m[3] );
1177 $prefix = isset( $m[4] ) ?
$m[4] : false;
1179 } elseif ( preg_match( '!^(tcp|udp):(?://)?([a-zA-Z0-9.-]+):(\d+)(?:/(.*))?$!', $file, $m ) ) {
1181 if ( !IP
::isIPv4( $host ) ) {
1182 $host = gethostbyname( $host );
1184 $port = intval( $m[3] );
1185 $prefix = isset( $m[4] ) ?
$m[4] : false;
1188 throw new MWException( __METHOD__
. ': Invalid UDP specification' );
1191 // Clean it up for the multiplexer
1192 if ( strval( $prefix ) !== '' ) {
1193 $text = preg_replace( '/^/m', $prefix . ' ', $text );
1196 if ( strlen( $text ) > 65506 ) {
1197 $text = substr( $text, 0, 65506 );
1200 if ( substr( $text, -1 ) != "\n" ) {
1203 } elseif ( strlen( $text ) > 65507 ) {
1204 $text = substr( $text, 0, 65507 );
1207 $sock = socket_create( $domain, SOCK_DGRAM
, SOL_UDP
);
1212 socket_sendto( $sock, $text, strlen( $text ), 0, $host, $port );
1213 socket_close( $sock );
1215 wfSuppressWarnings();
1216 $exists = file_exists( $file );
1217 $size = $exists ?
filesize( $file ) : false;
1218 if ( !$exists ||
( $size !== false && $size +
strlen( $text ) < 0x7fffffff ) ) {
1219 file_put_contents( $file, $text, FILE_APPEND
);
1221 wfRestoreWarnings();
1228 function wfLogProfilingData() {
1229 global $wgRequestTime, $wgDebugLogFile, $wgDebugLogGroups, $wgDebugRawPage;
1230 global $wgProfileLimit, $wgUser, $wgRequest;
1232 StatCounter
::singleton()->flush();
1234 $profiler = Profiler
::instance();
1236 # Profiling must actually be enabled...
1237 if ( $profiler->isStub() ) {
1241 // Get total page request time and only show pages that longer than
1242 // $wgProfileLimit time (default is 0)
1243 $elapsed = microtime( true ) - $wgRequestTime;
1244 if ( $elapsed <= $wgProfileLimit ) {
1248 $profiler->logData();
1250 // Check whether this should be logged in the debug file.
1251 if ( isset( $wgDebugLogGroups['profileoutput'] )
1252 && $wgDebugLogGroups['profileoutput'] === false
1254 // Explicitely disabled
1257 if ( !isset( $wgDebugLogGroups['profileoutput'] ) && $wgDebugLogFile == '' ) {
1258 // Logging not enabled; no point going further
1261 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1266 if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1267 $forward = ' forwarded for ' . $_SERVER['HTTP_X_FORWARDED_FOR'];
1269 if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1270 $forward .= ' client IP ' . $_SERVER['HTTP_CLIENT_IP'];
1272 if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1273 $forward .= ' from ' . $_SERVER['HTTP_FROM'];
1276 $forward = "\t(proxied via {$_SERVER['REMOTE_ADDR']}{$forward})";
1278 // Don't load $wgUser at this late stage just for statistics purposes
1279 // @todo FIXME: We can detect some anons even if it is not loaded. See User::getId()
1280 if ( $wgUser->isItemLoaded( 'id' ) && $wgUser->isAnon() ) {
1281 $forward .= ' anon';
1284 // Command line script uses a FauxRequest object which does not have
1285 // any knowledge about an URL and throw an exception instead.
1287 $requestUrl = $wgRequest->getRequestURL();
1288 } catch ( MWException
$e ) {
1289 $requestUrl = 'n/a';
1292 $log = sprintf( "%s\t%04.3f\t%s\n",
1293 gmdate( 'YmdHis' ), $elapsed,
1294 urldecode( $requestUrl . $forward ) );
1296 wfDebugLog( 'profileoutput', $log . $profiler->getOutput() );
1300 * Increment a statistics counter
1302 * @param $key String
1306 function wfIncrStats( $key, $count = 1 ) {
1307 StatCounter
::singleton()->incr( $key, $count );
1311 * Check whether the wiki is in read-only mode.
1315 function wfReadOnly() {
1316 return wfReadOnlyReason() !== false;
1320 * Get the value of $wgReadOnly or the contents of $wgReadOnlyFile.
1322 * @return string|bool: String when in read-only mode; false otherwise
1324 function wfReadOnlyReason() {
1325 global $wgReadOnly, $wgReadOnlyFile;
1327 if ( $wgReadOnly === null ) {
1328 // Set $wgReadOnly for faster access next time
1329 if ( is_file( $wgReadOnlyFile ) && filesize( $wgReadOnlyFile ) > 0 ) {
1330 $wgReadOnly = file_get_contents( $wgReadOnlyFile );
1332 $wgReadOnly = false;
1340 * Return a Language object from $langcode
1342 * @param $langcode Mixed: either:
1343 * - a Language object
1344 * - code of the language to get the message for, if it is
1345 * a valid code create a language for that language, if
1346 * it is a string but not a valid code then make a basic
1348 * - a boolean: if it's false then use the global object for
1349 * the current user's language (as a fallback for the old parameter
1350 * functionality), or if it is true then use global object
1351 * for the wiki's content language.
1352 * @return Language object
1354 function wfGetLangObj( $langcode = false ) {
1355 # Identify which language to get or create a language object for.
1356 # Using is_object here due to Stub objects.
1357 if ( is_object( $langcode ) ) {
1358 # Great, we already have the object (hopefully)!
1362 global $wgContLang, $wgLanguageCode;
1363 if ( $langcode === true ||
$langcode === $wgLanguageCode ) {
1364 # $langcode is the language code of the wikis content language object.
1365 # or it is a boolean and value is true
1370 if ( $langcode === false ||
$langcode === $wgLang->getCode() ) {
1371 # $langcode is the language code of user language object.
1372 # or it was a boolean and value is false
1376 $validCodes = array_keys( Language
::fetchLanguageNames() );
1377 if ( in_array( $langcode, $validCodes ) ) {
1378 # $langcode corresponds to a valid language.
1379 return Language
::factory( $langcode );
1382 # $langcode is a string, but not a valid language code; use content language.
1383 wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1388 * This is the function for getting translated interface messages.
1390 * @see Message class for documentation how to use them.
1391 * @see https://www.mediawiki.org/wiki/Manual:Messages_API
1393 * This function replaces all old wfMsg* functions.
1395 * @param string $key Message key
1396 * @param mixed [$params,...] Normal message parameters
1401 * @see Message::__construct
1403 function wfMessage( $key /*...*/ ) {
1404 $params = func_get_args();
1405 array_shift( $params );
1406 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
1407 $params = $params[0];
1409 return new Message( $key, $params );
1413 * This function accepts multiple message keys and returns a message instance
1414 * for the first message which is non-empty. If all messages are empty then an
1415 * instance of the first message key is returned.
1417 * @param string|string[] [$keys,...] Message keys
1422 * @see Message::newFallbackSequence
1424 function wfMessageFallback( /*...*/ ) {
1425 $args = func_get_args();
1426 return call_user_func_array( 'Message::newFallbackSequence', $args );
1430 * Get a message from anywhere, for the current user language.
1432 * Use wfMsgForContent() instead if the message should NOT
1433 * change depending on the user preferences.
1435 * @deprecated since 1.18
1437 * @param string $key lookup key for the message, usually
1438 * defined in languages/Language.php
1440 * Parameters to the message, which can be used to insert variable text into
1441 * it, can be passed to this function in the following formats:
1442 * - One per argument, starting at the second parameter
1443 * - As an array in the second parameter
1444 * These are not shown in the function definition.
1448 function wfMsg( $key ) {
1449 wfDeprecated( __METHOD__
, '1.21' );
1451 $args = func_get_args();
1452 array_shift( $args );
1453 return wfMsgReal( $key, $args );
1457 * Same as above except doesn't transform the message
1459 * @deprecated since 1.18
1461 * @param $key String
1464 function wfMsgNoTrans( $key ) {
1465 wfDeprecated( __METHOD__
, '1.21' );
1467 $args = func_get_args();
1468 array_shift( $args );
1469 return wfMsgReal( $key, $args, true, false, false );
1473 * Get a message from anywhere, for the current global language
1474 * set with $wgLanguageCode.
1476 * Use this if the message should NOT change dependent on the
1477 * language set in the user's preferences. This is the case for
1478 * most text written into logs, as well as link targets (such as
1479 * the name of the copyright policy page). Link titles, on the
1480 * other hand, should be shown in the UI language.
1482 * Note that MediaWiki allows users to change the user interface
1483 * language in their preferences, but a single installation
1484 * typically only contains content in one language.
1486 * Be wary of this distinction: If you use wfMsg() where you should
1487 * use wfMsgForContent(), a user of the software may have to
1488 * customize potentially hundreds of messages in
1489 * order to, e.g., fix a link in every possible language.
1491 * @deprecated since 1.18
1493 * @param string $key lookup key for the message, usually
1494 * defined in languages/Language.php
1497 function wfMsgForContent( $key ) {
1498 wfDeprecated( __METHOD__
, '1.21' );
1500 global $wgForceUIMsgAsContentMsg;
1501 $args = func_get_args();
1502 array_shift( $args );
1504 if ( is_array( $wgForceUIMsgAsContentMsg )
1505 && in_array( $key, $wgForceUIMsgAsContentMsg )
1507 $forcontent = false;
1509 return wfMsgReal( $key, $args, true, $forcontent );
1513 * Same as above except doesn't transform the message
1515 * @deprecated since 1.18
1517 * @param $key String
1520 function wfMsgForContentNoTrans( $key ) {
1521 wfDeprecated( __METHOD__
, '1.21' );
1523 global $wgForceUIMsgAsContentMsg;
1524 $args = func_get_args();
1525 array_shift( $args );
1527 if ( is_array( $wgForceUIMsgAsContentMsg )
1528 && in_array( $key, $wgForceUIMsgAsContentMsg )
1530 $forcontent = false;
1532 return wfMsgReal( $key, $args, true, $forcontent, false );
1536 * Really get a message
1538 * @deprecated since 1.18
1540 * @param string $key key to get.
1541 * @param array $args
1542 * @param bool $useDB
1543 * @param string|bool $forContent Language code, or false for user lang, true for content lang.
1544 * @param bool $transform Whether or not to transform the message.
1545 * @return string The requested message.
1547 function wfMsgReal( $key, $args, $useDB = true, $forContent = false, $transform = true ) {
1548 wfDeprecated( __METHOD__
, '1.21' );
1550 wfProfileIn( __METHOD__
);
1551 $message = wfMsgGetKey( $key, $useDB, $forContent, $transform );
1552 $message = wfMsgReplaceArgs( $message, $args );
1553 wfProfileOut( __METHOD__
);
1558 * Fetch a message string value, but don't replace any keys yet.
1560 * @deprecated since 1.18
1562 * @param string $key
1563 * @param bool $useDB
1564 * @param string|bool $langCode Code of the language to get the message for, or
1565 * behaves as a content language switch if it is a boolean.
1566 * @param bool $transform Whether to parse magic words, etc.
1569 function wfMsgGetKey( $key, $useDB = true, $langCode = false, $transform = true ) {
1570 wfDeprecated( __METHOD__
, '1.21' );
1572 wfRunHooks( 'NormalizeMessageKey', array( &$key, &$useDB, &$langCode, &$transform ) );
1574 $cache = MessageCache
::singleton();
1575 $message = $cache->get( $key, $useDB, $langCode );
1576 if ( $message === false ) {
1577 $message = '<' . htmlspecialchars( $key ) . '>';
1578 } elseif ( $transform ) {
1579 $message = $cache->transform( $message );
1585 * Replace message parameter keys on the given formatted output.
1587 * @param string $message
1588 * @param array $args
1592 function wfMsgReplaceArgs( $message, $args ) {
1593 # Fix windows line-endings
1594 # Some messages are split with explode("\n", $msg)
1595 $message = str_replace( "\r", '', $message );
1597 // Replace arguments
1598 if ( count( $args ) ) {
1599 if ( is_array( $args[0] ) ) {
1600 $args = array_values( $args[0] );
1602 $replacementKeys = array();
1603 foreach ( $args as $n => $param ) {
1604 $replacementKeys['$' . ( $n +
1 )] = $param;
1606 $message = strtr( $message, $replacementKeys );
1613 * Return an HTML-escaped version of a message.
1614 * Parameter replacements, if any, are done *after* the HTML-escaping,
1615 * so parameters may contain HTML (eg links or form controls). Be sure
1616 * to pre-escape them if you really do want plaintext, or just wrap
1617 * the whole thing in htmlspecialchars().
1619 * @deprecated since 1.18
1621 * @param string $key
1622 * @param string [$args,...] Parameters
1625 function wfMsgHtml( $key ) {
1626 wfDeprecated( __METHOD__
, '1.21' );
1628 $args = func_get_args();
1629 array_shift( $args );
1630 return wfMsgReplaceArgs( htmlspecialchars( wfMsgGetKey( $key ) ), $args );
1634 * Return an HTML version of message
1635 * Parameter replacements, if any, are done *after* parsing the wiki-text message,
1636 * so parameters may contain HTML (eg links or form controls). Be sure
1637 * to pre-escape them if you really do want plaintext, or just wrap
1638 * the whole thing in htmlspecialchars().
1640 * @deprecated since 1.18
1642 * @param string $key
1643 * @param string [$args,...] Parameters
1646 function wfMsgWikiHtml( $key ) {
1647 wfDeprecated( __METHOD__
, '1.21' );
1649 $args = func_get_args();
1650 array_shift( $args );
1651 return wfMsgReplaceArgs(
1652 MessageCache
::singleton()->parse( wfMsgGetKey( $key ), null,
1653 /* can't be set to false */ true, /* interface */ true )->getText(),
1658 * Returns message in the requested format
1660 * @deprecated since 1.18
1662 * @param string $key key of the message
1663 * @param array $options processing rules.
1664 * Can take the following options:
1665 * parse: parses wikitext to HTML
1666 * parseinline: parses wikitext to HTML and removes the surrounding
1667 * p's added by parser or tidy
1668 * escape: filters message through htmlspecialchars
1669 * escapenoentities: same, but allows entity references like   through
1670 * replaceafter: parameters are substituted after parsing or escaping
1671 * parsemag: transform the message using magic phrases
1672 * content: fetch message for content language instead of interface
1673 * Also can accept a single associative argument, of the form 'language' => 'xx':
1674 * language: Language object or language code to fetch message for
1675 * (overridden by content).
1676 * Behavior for conflicting options (e.g., parse+parseinline) is undefined.
1680 function wfMsgExt( $key, $options ) {
1681 wfDeprecated( __METHOD__
, '1.21' );
1683 $args = func_get_args();
1684 array_shift( $args );
1685 array_shift( $args );
1686 $options = (array)$options;
1688 foreach ( $options as $arrayKey => $option ) {
1689 if ( !preg_match( '/^[0-9]+|language$/', $arrayKey ) ) {
1690 # An unknown index, neither numeric nor "language"
1691 wfWarn( "wfMsgExt called with incorrect parameter key $arrayKey", 1, E_USER_WARNING
);
1692 } elseif ( preg_match( '/^[0-9]+$/', $arrayKey ) && !in_array( $option,
1693 array( 'parse', 'parseinline', 'escape', 'escapenoentities',
1694 'replaceafter', 'parsemag', 'content' ) ) ) {
1695 # A numeric index with unknown value
1696 wfWarn( "wfMsgExt called with incorrect parameter $option", 1, E_USER_WARNING
);
1700 if ( in_array( 'content', $options, true ) ) {
1703 $langCodeObj = null;
1704 } elseif ( array_key_exists( 'language', $options ) ) {
1705 $forContent = false;
1706 $langCode = wfGetLangObj( $options['language'] );
1707 $langCodeObj = $langCode;
1709 $forContent = false;
1711 $langCodeObj = null;
1714 $string = wfMsgGetKey( $key, /*DB*/true, $langCode, /*Transform*/false );
1716 if ( !in_array( 'replaceafter', $options, true ) ) {
1717 $string = wfMsgReplaceArgs( $string, $args );
1720 $messageCache = MessageCache
::singleton();
1721 $parseInline = in_array( 'parseinline', $options, true );
1722 if ( in_array( 'parse', $options, true ) ||
$parseInline ) {
1723 $string = $messageCache->parse( $string, null, true, !$forContent, $langCodeObj );
1724 if ( $string instanceof ParserOutput
) {
1725 $string = $string->getText();
1728 if ( $parseInline ) {
1730 if ( preg_match( '/^<p>(.*)\n?<\/p>\n?$/sU', $string, $m ) ) {
1734 } elseif ( in_array( 'parsemag', $options, true ) ) {
1735 $string = $messageCache->transform( $string,
1736 !$forContent, $langCodeObj );
1739 if ( in_array( 'escape', $options, true ) ) {
1740 $string = htmlspecialchars ( $string );
1741 } elseif ( in_array( 'escapenoentities', $options, true ) ) {
1742 $string = Sanitizer
::escapeHtmlAllowEntities( $string );
1745 if ( in_array( 'replaceafter', $options, true ) ) {
1746 $string = wfMsgReplaceArgs( $string, $args );
1753 * Since wfMsg() and co suck, they don't return false if the message key they
1754 * looked up didn't exist but instead the key wrapped in <>'s, this function checks for the
1755 * nonexistence of messages by checking the MessageCache::get() result directly.
1757 * @deprecated since 1.18. Use Message::isDisabled().
1759 * @param string $key The message key looked up
1760 * @return bool True if the message *doesn't* exist.
1762 function wfEmptyMsg( $key ) {
1763 wfDeprecated( __METHOD__
, '1.21' );
1765 return MessageCache
::singleton()->get( $key, /*useDB*/true, /*content*/false ) === false;
1769 * Throw a debugging exception. This function previously once exited the process,
1770 * but now throws an exception instead, with similar results.
1772 * @deprecated since 1.22; just throw an MWException yourself
1773 * @param string $msg message shown when dying.
1774 * @throws MWException
1776 function wfDebugDieBacktrace( $msg = '' ) {
1777 wfDeprecated( __FUNCTION__
, '1.22' );
1778 throw new MWException( $msg );
1782 * Fetch server name for use in error reporting etc.
1783 * Use real server name if available, so we know which machine
1784 * in a server farm generated the current page.
1788 function wfHostname() {
1790 if ( is_null( $host ) ) {
1792 # Hostname overriding
1793 global $wgOverrideHostname;
1794 if ( $wgOverrideHostname !== false ) {
1795 # Set static and skip any detection
1796 $host = $wgOverrideHostname;
1800 if ( function_exists( 'posix_uname' ) ) {
1801 // This function not present on Windows
1802 $uname = posix_uname();
1806 if ( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1807 $host = $uname['nodename'];
1808 } elseif ( getenv( 'COMPUTERNAME' ) ) {
1809 # Windows computer name
1810 $host = getenv( 'COMPUTERNAME' );
1812 # This may be a virtual server.
1813 $host = $_SERVER['SERVER_NAME'];
1820 * Returns a HTML comment with the elapsed time since request.
1821 * This method has no side effects.
1825 function wfReportTime() {
1826 global $wgRequestTime, $wgShowHostnames;
1828 $elapsed = microtime( true ) - $wgRequestTime;
1830 return $wgShowHostnames
1831 ?
sprintf( '<!-- Served by %s in %01.3f secs. -->', wfHostname(), $elapsed )
1832 : sprintf( '<!-- Served in %01.3f secs. -->', $elapsed );
1836 * Safety wrapper for debug_backtrace().
1838 * With Zend Optimizer 3.2.0 loaded, this causes segfaults under somewhat
1839 * murky circumstances, which may be triggered in part by stub objects
1840 * or other fancy talking'.
1842 * Will return an empty array if Zend Optimizer is detected or if
1843 * debug_backtrace is disabled, otherwise the output from
1844 * debug_backtrace() (trimmed).
1846 * @param int $limit This parameter can be used to limit the number of stack frames returned
1848 * @return array of backtrace information
1850 function wfDebugBacktrace( $limit = 0 ) {
1851 static $disabled = null;
1853 if ( extension_loaded( 'Zend Optimizer' ) ) {
1854 wfDebug( "Zend Optimizer detected; skipping debug_backtrace for safety.\n" );
1858 if ( is_null( $disabled ) ) {
1860 $functions = explode( ',', ini_get( 'disable_functions' ) );
1861 $functions = array_map( 'trim', $functions );
1862 $functions = array_map( 'strtolower', $functions );
1863 if ( in_array( 'debug_backtrace', $functions ) ) {
1864 wfDebug( "debug_backtrace is in disabled_functions\n" );
1872 if ( $limit && version_compare( PHP_VERSION
, '5.4.0', '>=' ) ) {
1873 return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT
, $limit +
1 ), 1 );
1875 return array_slice( debug_backtrace(), 1 );
1880 * Get a debug backtrace as a string
1884 function wfBacktrace() {
1885 global $wgCommandLineMode;
1887 if ( $wgCommandLineMode ) {
1892 $backtrace = wfDebugBacktrace();
1893 foreach ( $backtrace as $call ) {
1894 if ( isset( $call['file'] ) ) {
1895 $f = explode( DIRECTORY_SEPARATOR
, $call['file'] );
1896 $file = $f[count( $f ) - 1];
1900 if ( isset( $call['line'] ) ) {
1901 $line = $call['line'];
1905 if ( $wgCommandLineMode ) {
1906 $msg .= "$file line $line calls ";
1908 $msg .= '<li>' . $file . ' line ' . $line . ' calls ';
1910 if ( !empty( $call['class'] ) ) {
1911 $msg .= $call['class'] . $call['type'];
1913 $msg .= $call['function'] . '()';
1915 if ( $wgCommandLineMode ) {
1921 if ( $wgCommandLineMode ) {
1931 * Get the name of the function which called this function
1932 * wfGetCaller( 1 ) is the function with the wfGetCaller() call (ie. __FUNCTION__)
1933 * wfGetCaller( 2 ) [default] is the caller of the function running wfGetCaller()
1934 * wfGetCaller( 3 ) is the parent of that.
1939 function wfGetCaller( $level = 2 ) {
1940 $backtrace = wfDebugBacktrace( $level +
1 );
1941 if ( isset( $backtrace[$level] ) ) {
1942 return wfFormatStackFrame( $backtrace[$level] );
1949 * Return a string consisting of callers in the stack. Useful sometimes
1950 * for profiling specific points.
1952 * @param int $limit The maximum depth of the stack frame to return, or false for
1956 function wfGetAllCallers( $limit = 3 ) {
1957 $trace = array_reverse( wfDebugBacktrace() );
1958 if ( !$limit ||
$limit > count( $trace ) - 1 ) {
1959 $limit = count( $trace ) - 1;
1961 $trace = array_slice( $trace, -$limit - 1, $limit );
1962 return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1966 * Return a string representation of frame
1968 * @param $frame Array
1971 function wfFormatStackFrame( $frame ) {
1972 return isset( $frame['class'] ) ?
1973 $frame['class'] . '::' . $frame['function'] :
1977 /* Some generic result counters, pulled out of SearchEngine */
1982 * @param int $offset
1986 function wfShowingResults( $offset, $limit ) {
1987 return wfMessage( 'showingresults' )->numParams( $limit, $offset +
1 )->parse();
1991 * Generate (prev x| next x) (20|50|100...) type links for paging
1993 * @param string $offset
1995 * @param string $link
1996 * @param string $query optional URL query parameter string
1997 * @param bool $atend optional param for specified if this is the last page
1999 * @deprecated in 1.19; use Language::viewPrevNext() instead
2001 function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) {
2002 wfDeprecated( __METHOD__
, '1.19' );
2006 $query = wfCgiToArray( $query );
2008 if ( is_object( $link ) ) {
2011 $title = Title
::newFromText( $link );
2012 if ( is_null( $title ) ) {
2017 return $wgLang->viewPrevNext( $title, $offset, $limit, $query, $atend );
2022 * @todo FIXME: We may want to blacklist some broken browsers
2024 * @param bool $force
2025 * @return bool Whereas client accept gzip compression
2027 function wfClientAcceptsGzip( $force = false ) {
2028 static $result = null;
2029 if ( $result === null ||
$force ) {
2031 if ( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
2032 # @todo FIXME: We may want to blacklist some broken browsers
2035 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
2036 $_SERVER['HTTP_ACCEPT_ENCODING'],
2040 if ( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
2044 wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
2053 * Obtain the offset and limit values from the request string;
2054 * used in special pages
2056 * @param int $deflimit default limit if none supplied
2057 * @param string $optionname Name of a user preference to check against
2061 function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
2063 return $wgRequest->getLimitOffset( $deflimit, $optionname );
2067 * Escapes the given text so that it may be output using addWikiText()
2068 * without any linking, formatting, etc. making its way through. This
2069 * is achieved by substituting certain characters with HTML entities.
2070 * As required by the callers, "<nowiki>" is not used.
2072 * @param string $text text to be escaped
2075 function wfEscapeWikiText( $text ) {
2076 static $repl = null, $repl2 = null;
2077 if ( $repl === null ) {
2079 '"' => '"', '&' => '&', "'" => ''', '<' => '<',
2080 '=' => '=', '>' => '>', '[' => '[', ']' => ']',
2081 '{' => '{', '|' => '|', '}' => '}', ';' => ';',
2082 "\n#" => "\n#", "\r#" => "\r#",
2083 "\n*" => "\n*", "\r*" => "\r*",
2084 "\n:" => "\n:", "\r:" => "\r:",
2085 "\n " => "\n ", "\r " => "\r ",
2086 "\n\n" => "\n ", "\r\n" => " \n",
2087 "\n\r" => "\n ", "\r\r" => "\r ",
2088 "\n\t" => "\n	", "\r\t" => "\r	", // "\n\t\n" is treated like "\n\n"
2089 "\n----" => "\n----", "\r----" => "\r----",
2090 '__' => '__', '://' => '://',
2093 // We have to catch everything "\s" matches in PCRE
2094 foreach ( array( 'ISBN', 'RFC', 'PMID' ) as $magic ) {
2095 $repl["$magic "] = "$magic ";
2096 $repl["$magic\t"] = "$magic	";
2097 $repl["$magic\r"] = "$magic ";
2098 $repl["$magic\n"] = "$magic ";
2099 $repl["$magic\f"] = "$magic";
2102 // And handle protocols that don't use "://"
2103 global $wgUrlProtocols;
2105 foreach ( $wgUrlProtocols as $prot ) {
2106 if ( substr( $prot, -1 ) === ':' ) {
2107 $repl2[] = preg_quote( substr( $prot, 0, -1 ), '/' );
2110 $repl2 = $repl2 ?
'/\b(' . join( '|', $repl2 ) . '):/i' : '/^(?!)/';
2112 $text = substr( strtr( "\n$text", $repl ), 1 );
2113 $text = preg_replace( $repl2, '$1:', $text );
2118 * Get the current unix timestamp with microseconds. Useful for profiling
2119 * @deprecated since 1.22; call microtime() directly
2123 wfDeprecated( __FUNCTION__
, '1.22' );
2124 return microtime( true );
2128 * Sets dest to source and returns the original value of dest
2129 * If source is NULL, it just returns the value, it doesn't set the variable
2130 * If force is true, it will set the value even if source is NULL
2132 * @param $dest Mixed
2133 * @param $source Mixed
2134 * @param $force Bool
2137 function wfSetVar( &$dest, $source, $force = false ) {
2139 if ( !is_null( $source ) ||
$force ) {
2146 * As for wfSetVar except setting a bit
2150 * @param $state Bool
2154 function wfSetBit( &$dest, $bit, $state = true ) {
2155 $temp = (bool)( $dest & $bit );
2156 if ( !is_null( $state ) ) {
2167 * A wrapper around the PHP function var_export().
2168 * Either print it or add it to the regular output ($wgOut).
2170 * @param $var mixed A PHP variable to dump.
2172 function wfVarDump( $var ) {
2174 $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
2175 if ( headers_sent() ||
!isset( $wgOut ) ||
!is_object( $wgOut ) ) {
2178 $wgOut->addHTML( $s );
2183 * Provide a simple HTTP error.
2185 * @param $code Int|String
2186 * @param $label String
2187 * @param $desc String
2189 function wfHttpError( $code, $label, $desc ) {
2192 header( "HTTP/1.0 $code $label" );
2193 header( "Status: $code $label" );
2194 $wgOut->sendCacheControl();
2196 header( 'Content-type: text/html; charset=utf-8' );
2197 print "<!doctype html>" .
2198 '<html><head><title>' .
2199 htmlspecialchars( $label ) .
2200 '</title></head><body><h1>' .
2201 htmlspecialchars( $label ) .
2203 nl2br( htmlspecialchars( $desc ) ) .
2204 "</p></body></html>\n";
2208 * Clear away any user-level output buffers, discarding contents.
2210 * Suitable for 'starting afresh', for instance when streaming
2211 * relatively large amounts of data without buffering, or wanting to
2212 * output image files without ob_gzhandler's compression.
2214 * The optional $resetGzipEncoding parameter controls suppression of
2215 * the Content-Encoding header sent by ob_gzhandler; by default it
2216 * is left. See comments for wfClearOutputBuffers() for why it would
2219 * Note that some PHP configuration options may add output buffer
2220 * layers which cannot be removed; these are left in place.
2222 * @param $resetGzipEncoding Bool
2224 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
2225 if ( $resetGzipEncoding ) {
2226 // Suppress Content-Encoding and Content-Length
2227 // headers from 1.10+s wfOutputHandler
2228 global $wgDisableOutputCompression;
2229 $wgDisableOutputCompression = true;
2231 while ( $status = ob_get_status() ) {
2232 if ( $status['type'] == 0 /* PHP_OUTPUT_HANDLER_INTERNAL */ ) {
2233 // Probably from zlib.output_compression or other
2234 // PHP-internal setting which can't be removed.
2236 // Give up, and hope the result doesn't break
2240 if ( !ob_end_clean() ) {
2241 // Could not remove output buffer handler; abort now
2242 // to avoid getting in some kind of infinite loop.
2245 if ( $resetGzipEncoding ) {
2246 if ( $status['name'] == 'ob_gzhandler' ) {
2247 // Reset the 'Content-Encoding' field set by this handler
2248 // so we can start fresh.
2249 header_remove( 'Content-Encoding' );
2257 * More legible than passing a 'false' parameter to wfResetOutputBuffers():
2259 * Clear away output buffers, but keep the Content-Encoding header
2260 * produced by ob_gzhandler, if any.
2262 * This should be used for HTTP 304 responses, where you need to
2263 * preserve the Content-Encoding header of the real result, but
2264 * also need to suppress the output of ob_gzhandler to keep to spec
2265 * and avoid breaking Firefox in rare cases where the headers and
2266 * body are broken over two packets.
2268 function wfClearOutputBuffers() {
2269 wfResetOutputBuffers( false );
2273 * Converts an Accept-* header into an array mapping string values to quality
2276 * @param string $accept
2277 * @param string $def default
2278 * @return float[] Associative array of string => float pairs
2280 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
2281 # No arg means accept anything (per HTTP spec)
2283 return array( $def => 1.0 );
2288 $parts = explode( ',', $accept );
2290 foreach ( $parts as $part ) {
2291 # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
2292 $values = explode( ';', trim( $part ) );
2294 if ( count( $values ) == 1 ) {
2295 $prefs[$values[0]] = 1.0;
2296 } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
2297 $prefs[$values[0]] = floatval( $match[1] );
2305 * Checks if a given MIME type matches any of the keys in the given
2306 * array. Basic wildcards are accepted in the array keys.
2308 * Returns the matching MIME type (or wildcard) if a match, otherwise
2311 * @param string $type
2312 * @param array $avail
2316 function mimeTypeMatch( $type, $avail ) {
2317 if ( array_key_exists( $type, $avail ) ) {
2320 $parts = explode( '/', $type );
2321 if ( array_key_exists( $parts[0] . '/*', $avail ) ) {
2322 return $parts[0] . '/*';
2323 } elseif ( array_key_exists( '*/*', $avail ) ) {
2332 * Returns the 'best' match between a client's requested internet media types
2333 * and the server's list of available types. Each list should be an associative
2334 * array of type to preference (preference is a float between 0.0 and 1.0).
2335 * Wildcards in the types are acceptable.
2337 * @param array $cprefs client's acceptable type list
2338 * @param array $sprefs server's offered types
2341 * @todo FIXME: Doesn't handle params like 'text/plain; charset=UTF-8'
2342 * XXX: generalize to negotiate other stuff
2344 function wfNegotiateType( $cprefs, $sprefs ) {
2347 foreach ( array_keys( $sprefs ) as $type ) {
2348 $parts = explode( '/', $type );
2349 if ( $parts[1] != '*' ) {
2350 $ckey = mimeTypeMatch( $type, $cprefs );
2352 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
2357 foreach ( array_keys( $cprefs ) as $type ) {
2358 $parts = explode( '/', $type );
2359 if ( $parts[1] != '*' && !array_key_exists( $type, $sprefs ) ) {
2360 $skey = mimeTypeMatch( $type, $sprefs );
2362 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
2370 foreach ( array_keys( $combine ) as $type ) {
2371 if ( $combine[$type] > $bestq ) {
2373 $bestq = $combine[$type];
2381 * Reference-counted warning suppression
2385 function wfSuppressWarnings( $end = false ) {
2386 static $suppressCount = 0;
2387 static $originalLevel = false;
2390 if ( $suppressCount ) {
2392 if ( !$suppressCount ) {
2393 error_reporting( $originalLevel );
2397 if ( !$suppressCount ) {
2398 $originalLevel = error_reporting( E_ALL
& ~
(
2413 * Restore error level to previous value
2415 function wfRestoreWarnings() {
2416 wfSuppressWarnings( true );
2419 # Autodetect, convert and provide timestamps of various types
2422 * Unix time - the number of seconds since 1970-01-01 00:00:00 UTC
2424 define( 'TS_UNIX', 0 );
2427 * MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
2429 define( 'TS_MW', 1 );
2432 * MySQL DATETIME (YYYY-MM-DD HH:MM:SS)
2434 define( 'TS_DB', 2 );
2437 * RFC 2822 format, for E-mail and HTTP headers
2439 define( 'TS_RFC2822', 3 );
2442 * ISO 8601 format with no timezone: 1986-02-09T20:00:00Z
2444 * This is used by Special:Export
2446 define( 'TS_ISO_8601', 4 );
2449 * An Exif timestamp (YYYY:MM:DD HH:MM:SS)
2451 * @see http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the
2452 * DateTime tag and page 36 for the DateTimeOriginal and
2453 * DateTimeDigitized tags.
2455 define( 'TS_EXIF', 5 );
2458 * Oracle format time.
2460 define( 'TS_ORACLE', 6 );
2463 * Postgres format time.
2465 define( 'TS_POSTGRES', 7 );
2468 * ISO 8601 basic format with no timezone: 19860209T200000Z. This is used by ResourceLoader
2470 define( 'TS_ISO_8601_BASIC', 9 );
2473 * Get a timestamp string in one of various formats
2475 * @param $outputtype Mixed: A timestamp in one of the supported formats, the
2476 * function will autodetect which format is supplied and act
2478 * @param $ts Mixed: optional timestamp to convert, default 0 for the current time
2479 * @return Mixed: String / false The same date in the format specified in $outputtype or false
2481 function wfTimestamp( $outputtype = TS_UNIX
, $ts = 0 ) {
2483 $timestamp = new MWTimestamp( $ts );
2484 return $timestamp->getTimestamp( $outputtype );
2485 } catch ( TimestampException
$e ) {
2486 wfDebug( "wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n" );
2492 * Return a formatted timestamp, or null if input is null.
2493 * For dealing with nullable timestamp columns in the database.
2495 * @param int $outputtype
2499 function wfTimestampOrNull( $outputtype = TS_UNIX
, $ts = null ) {
2500 if ( is_null( $ts ) ) {
2503 return wfTimestamp( $outputtype, $ts );
2508 * Convenience function; returns MediaWiki timestamp for the present time.
2512 function wfTimestampNow() {
2514 return wfTimestamp( TS_MW
, time() );
2518 * Check if the operating system is Windows
2520 * @return bool True if it's Windows, false otherwise.
2522 function wfIsWindows() {
2523 static $isWindows = null;
2524 if ( $isWindows === null ) {
2525 $isWindows = substr( php_uname(), 0, 7 ) == 'Windows';
2531 * Check if we are running under HHVM
2535 function wfIsHHVM() {
2536 return defined( 'HHVM_VERSION' );
2540 * Swap two variables
2545 function swap( &$x, &$y ) {
2552 * Tries to get the system directory for temporary files. First
2553 * $wgTmpDirectory is checked, and then the TMPDIR, TMP, and TEMP
2554 * environment variables are then checked in sequence, and if none are
2555 * set try sys_get_temp_dir().
2557 * NOTE: When possible, use instead the tmpfile() function to create
2558 * temporary files to avoid race conditions on file creation, etc.
2562 function wfTempDir() {
2563 global $wgTmpDirectory;
2565 if ( $wgTmpDirectory !== false ) {
2566 return $wgTmpDirectory;
2569 $tmpDir = array_map( "getenv", array( 'TMPDIR', 'TMP', 'TEMP' ) );
2571 foreach ( $tmpDir as $tmp ) {
2572 if ( $tmp && file_exists( $tmp ) && is_dir( $tmp ) && is_writable( $tmp ) ) {
2576 return sys_get_temp_dir();
2580 * Make directory, and make all parent directories if they don't exist
2582 * @param string $dir full path to directory to create
2583 * @param int $mode Chmod value to use, default is $wgDirectoryMode
2584 * @param string $caller optional caller param for debugging.
2585 * @throws MWException
2588 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2589 global $wgDirectoryMode;
2591 if ( FileBackend
::isStoragePath( $dir ) ) { // sanity
2592 throw new MWException( __FUNCTION__
. " given storage path '$dir'." );
2595 if ( !is_null( $caller ) ) {
2596 wfDebug( "$caller: called wfMkdirParents($dir)\n" );
2599 if ( strval( $dir ) === '' ||
( file_exists( $dir ) && is_dir( $dir ) ) ) {
2603 $dir = str_replace( array( '\\', '/' ), DIRECTORY_SEPARATOR
, $dir );
2605 if ( is_null( $mode ) ) {
2606 $mode = $wgDirectoryMode;
2609 // Turn off the normal warning, we're doing our own below
2610 wfSuppressWarnings();
2611 $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2612 wfRestoreWarnings();
2615 //directory may have been created on another request since we last checked
2616 if ( is_dir( $dir ) ) {
2620 // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2621 wfLogWarning( sprintf( "failed to mkdir \"%s\" mode 0%o", $dir, $mode ) );
2627 * Remove a directory and all its content.
2628 * Does not hide error.
2630 function wfRecursiveRemoveDir( $dir ) {
2631 wfDebug( __FUNCTION__
. "( $dir )\n" );
2632 // taken from http://de3.php.net/manual/en/function.rmdir.php#98622
2633 if ( is_dir( $dir ) ) {
2634 $objects = scandir( $dir );
2635 foreach ( $objects as $object ) {
2636 if ( $object != "." && $object != ".." ) {
2637 if ( filetype( $dir . '/' . $object ) == "dir" ) {
2638 wfRecursiveRemoveDir( $dir . '/' . $object );
2640 unlink( $dir . '/' . $object );
2650 * @param number $nr The number to format
2651 * @param int $acc The number of digits after the decimal point, default 2
2652 * @param bool $round Whether or not to round the value, default true
2655 function wfPercent( $nr, $acc = 2, $round = true ) {
2656 $ret = sprintf( "%.${acc}f", $nr );
2657 return $round ?
round( $ret, $acc ) . '%' : "$ret%";
2661 * Safety wrapper around ini_get() for boolean settings.
2662 * The values returned from ini_get() are pre-normalized for settings
2663 * set via php.ini or php_flag/php_admin_flag... but *not*
2664 * for those set via php_value/php_admin_value.
2666 * It's fairly common for people to use php_value instead of php_flag,
2667 * which can leave you with an 'off' setting giving a false positive
2668 * for code that just takes the ini_get() return value as a boolean.
2670 * To make things extra interesting, setting via php_value accepts
2671 * "true" and "yes" as true, but php.ini and php_flag consider them false. :)
2672 * Unrecognized values go false... again opposite PHP's own coercion
2673 * from string to bool.
2675 * Luckily, 'properly' set settings will always come back as '0' or '1',
2676 * so we only have to worry about them and the 'improper' settings.
2678 * I frickin' hate PHP... :P
2680 * @param string $setting
2683 function wfIniGetBool( $setting ) {
2684 $val = strtolower( ini_get( $setting ) );
2685 // 'on' and 'true' can't have whitespace around them, but '1' can.
2689 ||
preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2693 * Windows-compatible version of escapeshellarg()
2694 * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
2695 * function puts single quotes in regardless of OS.
2697 * Also fixes the locale problems on Linux in PHP 5.2.6+ (bug backported to
2698 * earlier distro releases of PHP)
2700 * @param string [$args,...]
2703 function wfEscapeShellArg( /*...*/ ) {
2704 wfInitShellLocale();
2706 $args = func_get_args();
2709 foreach ( $args as $arg ) {
2716 if ( wfIsWindows() ) {
2717 // Escaping for an MSVC-style command line parser and CMD.EXE
2718 // @codingStandardsIgnoreStart For long URLs
2720 // * http://web.archive.org/web/20020708081031/http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
2721 // * http://technet.microsoft.com/en-us/library/cc723564.aspx
2724 // Double the backslashes before any double quotes. Escape the double quotes.
2725 // @codingStandardsIgnoreEnd
2726 $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE
);
2729 foreach ( $tokens as $token ) {
2730 if ( $iteration %
2 == 1 ) {
2731 // Delimiter, a double quote preceded by zero or more slashes
2732 $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
2733 } elseif ( $iteration %
4 == 2 ) {
2734 // ^ in $token will be outside quotes, need to be escaped
2735 $arg .= str_replace( '^', '^^', $token );
2736 } else { // $iteration % 4 == 0
2737 // ^ in $token will appear inside double quotes, so leave as is
2742 // Double the backslashes before the end of the string, because
2743 // we will soon add a quote
2745 if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
2746 $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
2749 // Add surrounding quotes
2750 $retVal .= '"' . $arg . '"';
2752 $retVal .= escapeshellarg( $arg );
2759 * Check if wfShellExec() is effectively disabled via php.ini config
2761 * @return bool|string False or one of (safemode,disabled)
2764 function wfShellExecDisabled() {
2765 static $disabled = null;
2766 if ( is_null( $disabled ) ) {
2768 if ( wfIniGetBool( 'safe_mode' ) ) {
2769 wfDebug( "wfShellExec can't run in safe_mode, PHP's exec functions are too broken.\n" );
2770 $disabled = 'safemode';
2772 $functions = explode( ',', ini_get( 'disable_functions' ) );
2773 $functions = array_map( 'trim', $functions );
2774 $functions = array_map( 'strtolower', $functions );
2775 if ( in_array( 'proc_open', $functions ) ) {
2776 wfDebug( "proc_open is in disabled_functions\n" );
2777 $disabled = 'disabled';
2785 * Execute a shell command, with time and memory limits mirrored from the PHP
2786 * configuration if supported.
2788 * @param string $cmd Command line, properly escaped for shell.
2789 * @param &$retval null|Mixed optional, will receive the program's exit code.
2790 * (non-zero is usually failure). If there is an error from
2791 * read, select, or proc_open(), this will be set to -1.
2792 * @param array $environ optional environment variables which should be
2793 * added to the executed command environment.
2794 * @param array $limits optional array with limits(filesize, memory, time, walltime)
2795 * this overwrites the global wgMaxShell* limits.
2796 * @param array $options Array of options:
2797 * - duplicateStderr: Set this to true to duplicate stderr to stdout,
2798 * including errors from limit.sh
2800 * @return string collected stdout as a string
2802 function wfShellExec( $cmd, &$retval = null, $environ = array(),
2803 $limits = array(), $options = array()
2805 global $IP, $wgMaxShellMemory, $wgMaxShellFileSize, $wgMaxShellTime,
2806 $wgMaxShellWallClockTime, $wgShellCgroup;
2808 $disabled = wfShellExecDisabled();
2811 return $disabled == 'safemode' ?
2812 'Unable to run external programs in safe mode.' :
2813 'Unable to run external programs, proc_open() is disabled.';
2816 $includeStderr = isset( $options['duplicateStderr'] ) && $options['duplicateStderr'];
2818 wfInitShellLocale();
2821 foreach ( $environ as $k => $v ) {
2822 if ( wfIsWindows() ) {
2823 /* Surrounding a set in quotes (method used by wfEscapeShellArg) makes the quotes themselves
2824 * appear in the environment variable, so we must use carat escaping as documented in
2825 * http://technet.microsoft.com/en-us/library/cc723564.aspx
2826 * Note however that the quote isn't listed there, but is needed, and the parentheses
2827 * are listed there but doesn't appear to need it.
2829 $envcmd .= "set $k=" . preg_replace( '/([&|()<>^"])/', '^\\1', $v ) . '&& ';
2831 /* Assume this is a POSIX shell, thus required to accept variable assignments before the command
2832 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_09_01
2834 $envcmd .= "$k=" . escapeshellarg( $v ) . ' ';
2837 $cmd = $envcmd . $cmd;
2839 $useLogPipe = false;
2840 if ( php_uname( 's' ) == 'Linux' ) {
2841 $time = intval ( isset( $limits['time'] ) ?
$limits['time'] : $wgMaxShellTime );
2842 if ( isset( $limits['walltime'] ) ) {
2843 $wallTime = intval( $limits['walltime'] );
2844 } elseif ( isset( $limits['time'] ) ) {
2847 $wallTime = intval( $wgMaxShellWallClockTime );
2849 $mem = intval ( isset( $limits['memory'] ) ?
$limits['memory'] : $wgMaxShellMemory );
2850 $filesize = intval ( isset( $limits['filesize'] ) ?
$limits['filesize'] : $wgMaxShellFileSize );
2852 if ( $time > 0 ||
$mem > 0 ||
$filesize > 0 ||
$wallTime > 0 ) {
2853 $cmd = '/bin/bash ' . escapeshellarg( "$IP/includes/limit.sh" ) . ' ' .
2854 escapeshellarg( $cmd ) . ' ' .
2856 "MW_INCLUDE_STDERR=" . ( $includeStderr ?
'1' : '' ) . ';' .
2857 "MW_CPU_LIMIT=$time; " .
2858 'MW_CGROUP=' . escapeshellarg( $wgShellCgroup ) . '; ' .
2859 "MW_MEM_LIMIT=$mem; " .
2860 "MW_FILE_SIZE_LIMIT=$filesize; " .
2861 "MW_WALL_CLOCK_LIMIT=$wallTime; " .
2862 "MW_USE_LOG_PIPE=yes"
2865 } elseif ( $includeStderr ) {
2868 } elseif ( $includeStderr ) {
2871 wfDebug( "wfShellExec: $cmd\n" );
2874 0 => array( 'file', 'php://stdin', 'r' ),
2875 1 => array( 'pipe', 'w' ),
2876 2 => array( 'file', 'php://stderr', 'w' ) );
2877 if ( $useLogPipe ) {
2878 $desc[3] = array( 'pipe', 'w' );
2881 # TODO/FIXME: This is a bad hack to workaround an HHVM bug that prevents
2882 # proc_open() from opening stdin/stdout, so use /dev/null *for now*
2883 # See bug 56597 / https://github.com/facebook/hhvm/issues/1247 for more info
2885 $desc[0] = array( 'file', '/dev/null', 'r' );
2886 $desc[2] = array( 'file', '/dev/null', 'w' );
2890 $proc = proc_open( $cmd, $desc, $pipes );
2892 wfDebugLog( 'exec', "proc_open() failed: $cmd" );
2896 $outBuffer = $logBuffer = '';
2897 $emptyArray = array();
2901 // According to the documentation, it is possible for stream_select()
2902 // to fail due to EINTR. I haven't managed to induce this in testing
2903 // despite sending various signals. If it did happen, the error
2904 // message would take the form:
2906 // stream_select(): unable to select [4]: Interrupted system call (max_fd=5)
2908 // where [4] is the value of the macro EINTR and "Interrupted system
2909 // call" is string which according to the Linux manual is "possibly"
2910 // localised according to LC_MESSAGES.
2911 $eintr = defined( 'SOCKET_EINTR' ) ? SOCKET_EINTR
: 4;
2912 $eintrMessage = "stream_select(): unable to select [$eintr]";
2914 // Build a table mapping resource IDs to pipe FDs to work around a
2915 // PHP 5.3 issue in which stream_select() does not preserve array keys
2916 // <https://bugs.php.net/bug.php?id=53427>.
2918 foreach ( $pipes as $fd => $pipe ) {
2919 $fds[(int)$pipe] = $fd;
2923 $status = proc_get_status( $proc );
2924 if ( !$status['running'] ) {
2929 $readyPipes = $pipes;
2932 @trigger_error
( '' );
2933 if ( @stream_select
( $readyPipes, $emptyArray, $emptyArray, null ) === false ) {
2934 $error = error_get_last();
2935 if ( strncmp( $error['message'], $eintrMessage, strlen( $eintrMessage ) ) == 0 ) {
2938 trigger_error( $error['message'], E_USER_WARNING
);
2939 $logMsg = $error['message'];
2943 foreach ( $readyPipes as $pipe ) {
2944 $block = fread( $pipe, 65536 );
2945 $fd = $fds[(int)$pipe];
2946 if ( $block === '' ) {
2948 fclose( $pipes[$fd] );
2949 unset( $pipes[$fd] );
2953 } elseif ( $block === false ) {
2955 $logMsg = "Error reading from pipe";
2957 } elseif ( $fd == 1 ) {
2959 $outBuffer .= $block;
2960 } elseif ( $fd == 3 ) {
2962 $logBuffer .= $block;
2963 if ( strpos( $block, "\n" ) !== false ) {
2964 $lines = explode( "\n", $logBuffer );
2965 $logBuffer = array_pop( $lines );
2966 foreach ( $lines as $line ) {
2967 wfDebugLog( 'exec', $line );
2974 foreach ( $pipes as $pipe ) {
2978 // Use the status previously collected if possible, since proc_get_status()
2979 // just calls waitpid() which will not return anything useful the second time.
2980 if ( $status === false ) {
2981 $status = proc_get_status( $proc );
2984 if ( $logMsg !== false ) {
2985 // Read/select error
2987 proc_close( $proc );
2988 } elseif ( $status['signaled'] ) {
2989 $logMsg = "Exited with signal {$status['termsig']}";
2990 $retval = 128 +
$status['termsig'];
2991 proc_close( $proc );
2993 if ( $status['running'] ) {
2994 $retval = proc_close( $proc );
2996 $retval = $status['exitcode'];
2997 proc_close( $proc );
2999 if ( $retval == 127 ) {
3000 $logMsg = "Possibly missing executable file";
3001 } elseif ( $retval >= 129 && $retval <= 192 ) {
3002 $logMsg = "Probably exited with signal " . ( $retval - 128 );
3006 if ( $logMsg !== false ) {
3007 wfDebugLog( 'exec', "$logMsg: $cmd" );
3014 * Execute a shell command, returning both stdout and stderr. Convenience
3015 * function, as all the arguments to wfShellExec can become unwieldy.
3017 * @note This also includes errors from limit.sh, e.g. if $wgMaxShellFileSize is exceeded.
3018 * @param string $cmd Command line, properly escaped for shell.
3019 * @param &$retval null|Mixed optional, will receive the program's exit code.
3020 * (non-zero is usually failure)
3021 * @param array $environ optional environment variables which should be
3022 * added to the executed command environment.
3023 * @param array $limits optional array with limits(filesize, memory, time, walltime)
3024 * this overwrites the global wgShellMax* limits.
3025 * @return string collected stdout and stderr as a string
3027 function wfShellExecWithStderr( $cmd, &$retval = null, $environ = array(), $limits = array() ) {
3028 return wfShellExec( $cmd, $retval, $environ, $limits, array( 'duplicateStderr' => true ) );
3032 * Workaround for http://bugs.php.net/bug.php?id=45132
3033 * escapeshellarg() destroys non-ASCII characters if LANG is not a UTF-8 locale
3035 function wfInitShellLocale() {
3036 static $done = false;
3041 global $wgShellLocale;
3042 if ( !wfIniGetBool( 'safe_mode' ) ) {
3043 putenv( "LC_CTYPE=$wgShellLocale" );
3044 setlocale( LC_CTYPE
, $wgShellLocale );
3049 * Alias to wfShellWikiCmd()
3051 * @see wfShellWikiCmd()
3053 function wfShellMaintenanceCmd( $script, array $parameters = array(), array $options = array() ) {
3054 return wfShellWikiCmd( $script, $parameters, $options );
3058 * Generate a shell-escaped command line string to run a MediaWiki cli script.
3059 * Note that $parameters should be a flat array and an option with an argument
3060 * should consist of two consecutive items in the array (do not use "--option value").
3062 * @param string $script MediaWiki cli script path
3063 * @param array $parameters Arguments and options to the script
3064 * @param array $options Associative array of options:
3065 * 'php': The path to the php executable
3066 * 'wrapper': Path to a PHP wrapper to handle the maintenance script
3069 function wfShellWikiCmd( $script, array $parameters = array(), array $options = array() ) {
3071 // Give site config file a chance to run the script in a wrapper.
3072 // The caller may likely want to call wfBasename() on $script.
3073 wfRunHooks( 'wfShellWikiCmd', array( &$script, &$parameters, &$options ) );
3074 $cmd = isset( $options['php'] ) ?
array( $options['php'] ) : array( $wgPhpCli );
3075 if ( isset( $options['wrapper'] ) ) {
3076 $cmd[] = $options['wrapper'];
3079 // Escape each parameter for shell
3080 return implode( " ", array_map( 'wfEscapeShellArg', array_merge( $cmd, $parameters ) ) );
3084 * wfMerge attempts to merge differences between three texts.
3085 * Returns true for a clean merge and false for failure or a conflict.
3087 * @param string $old
3088 * @param string $mine
3089 * @param string $yours
3090 * @param string $result
3093 function wfMerge( $old, $mine, $yours, &$result ) {
3096 # This check may also protect against code injection in
3097 # case of broken installations.
3098 wfSuppressWarnings();
3099 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
3100 wfRestoreWarnings();
3102 if ( !$haveDiff3 ) {
3103 wfDebug( "diff3 not found\n" );
3107 # Make temporary files
3109 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
3110 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
3111 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
3113 # NOTE: diff3 issues a warning to stderr if any of the files does not end with
3114 # a newline character. To avoid this, we normalize the trailing whitespace before
3115 # creating the diff.
3117 fwrite( $oldtextFile, rtrim( $old ) . "\n" );
3118 fclose( $oldtextFile );
3119 fwrite( $mytextFile, rtrim( $mine ) . "\n" );
3120 fclose( $mytextFile );
3121 fwrite( $yourtextFile, rtrim( $yours ) . "\n" );
3122 fclose( $yourtextFile );
3124 # Check for a conflict
3125 $cmd = wfEscapeShellArg( $wgDiff3 ) . ' -a --overlap-only ' .
3126 wfEscapeShellArg( $mytextName ) . ' ' .
3127 wfEscapeShellArg( $oldtextName ) . ' ' .
3128 wfEscapeShellArg( $yourtextName );
3129 $handle = popen( $cmd, 'r' );
3131 if ( fgets( $handle, 1024 ) ) {
3139 $cmd = wfEscapeShellArg( $wgDiff3 ) . ' -a -e --merge ' .
3140 wfEscapeShellArg( $mytextName, $oldtextName, $yourtextName );
3141 $handle = popen( $cmd, 'r' );
3144 $data = fread( $handle, 8192 );
3145 if ( strlen( $data ) == 0 ) {
3151 unlink( $mytextName );
3152 unlink( $oldtextName );
3153 unlink( $yourtextName );
3155 if ( $result === '' && $old !== '' && !$conflict ) {
3156 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
3163 * Returns unified plain-text diff of two texts.
3164 * Useful for machine processing of diffs.
3166 * @param string $before the text before the changes.
3167 * @param string $after the text after the changes.
3168 * @param string $params command-line options for the diff command.
3169 * @return string Unified diff of $before and $after
3171 function wfDiff( $before, $after, $params = '-u' ) {
3172 if ( $before == $after ) {
3177 wfSuppressWarnings();
3178 $haveDiff = $wgDiff && file_exists( $wgDiff );
3179 wfRestoreWarnings();
3181 # This check may also protect against code injection in
3182 # case of broken installations.
3184 wfDebug( "diff executable not found\n" );
3185 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
3186 $format = new UnifiedDiffFormatter();
3187 return $format->format( $diffs );
3190 # Make temporary files
3192 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
3193 $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
3195 fwrite( $oldtextFile, $before );
3196 fclose( $oldtextFile );
3197 fwrite( $newtextFile, $after );
3198 fclose( $newtextFile );
3200 // Get the diff of the two files
3201 $cmd = "$wgDiff " . $params . ' ' . wfEscapeShellArg( $oldtextName, $newtextName );
3203 $h = popen( $cmd, 'r' );
3208 $data = fread( $h, 8192 );
3209 if ( strlen( $data ) == 0 ) {
3217 unlink( $oldtextName );
3218 unlink( $newtextName );
3220 // Kill the --- and +++ lines. They're not useful.
3221 $diff_lines = explode( "\n", $diff );
3222 if ( strpos( $diff_lines[0], '---' ) === 0 ) {
3223 unset( $diff_lines[0] );
3225 if ( strpos( $diff_lines[1], '+++' ) === 0 ) {
3226 unset( $diff_lines[1] );
3229 $diff = implode( "\n", $diff_lines );
3235 * This function works like "use VERSION" in Perl, the program will die with a
3236 * backtrace if the current version of PHP is less than the version provided
3238 * This is useful for extensions which due to their nature are not kept in sync
3239 * with releases, and might depend on other versions of PHP than the main code
3241 * Note: PHP might die due to parsing errors in some cases before it ever
3242 * manages to call this function, such is life
3244 * @see perldoc -f use
3246 * @param string|number $req_ver The version to check, can be a string, an integer, or
3248 * @throws MWException
3250 function wfUsePHP( $req_ver ) {
3251 $php_ver = PHP_VERSION
;
3253 if ( version_compare( $php_ver, (string)$req_ver, '<' ) ) {
3254 throw new MWException( "PHP $req_ver required--this is only $php_ver" );
3259 * This function works like "use VERSION" in Perl except it checks the version
3260 * of MediaWiki, the program will die with a backtrace if the current version
3261 * of MediaWiki is less than the version provided.
3263 * This is useful for extensions which due to their nature are not kept in sync
3266 * Note: Due to the behavior of PHP's version_compare() which is used in this
3267 * function, if you want to allow the 'wmf' development versions add a 'c' (or
3268 * any single letter other than 'a', 'b' or 'p') as a post-fix to your
3269 * targeted version number. For example if you wanted to allow any variation
3270 * of 1.22 use `wfUseMW( '1.22c' )`. Using an 'a' or 'b' instead of 'c' will
3271 * not result in the same comparison due to the internal logic of
3272 * version_compare().
3274 * @see perldoc -f use
3276 * @param string|number $req_ver The version to check, can be a string, an integer, or
3278 * @throws MWException
3280 function wfUseMW( $req_ver ) {
3283 if ( version_compare( $wgVersion, (string)$req_ver, '<' ) ) {
3284 throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
3289 * Return the final portion of a pathname.
3290 * Reimplemented because PHP5's "basename()" is buggy with multibyte text.
3291 * http://bugs.php.net/bug.php?id=33898
3293 * PHP's basename() only considers '\' a pathchar on Windows and Netware.
3294 * We'll consider it so always, as we don't want '\s' in our Unix paths either.
3296 * @param string $path
3297 * @param string $suffix to remove if present
3300 function wfBaseName( $path, $suffix = '' ) {
3301 if ( $suffix == '' ) {
3304 $encSuffix = '(?:' . preg_quote( $suffix, '#' ) . ')?';
3308 if ( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
3316 * Generate a relative path name to the given file.
3317 * May explode on non-matching case-insensitive paths,
3318 * funky symlinks, etc.
3320 * @param string $path absolute destination path including target filename
3321 * @param string $from Absolute source path, directory only
3324 function wfRelativePath( $path, $from ) {
3325 // Normalize mixed input on Windows...
3326 $path = str_replace( '/', DIRECTORY_SEPARATOR
, $path );
3327 $from = str_replace( '/', DIRECTORY_SEPARATOR
, $from );
3329 // Trim trailing slashes -- fix for drive root
3330 $path = rtrim( $path, DIRECTORY_SEPARATOR
);
3331 $from = rtrim( $from, DIRECTORY_SEPARATOR
);
3333 $pieces = explode( DIRECTORY_SEPARATOR
, dirname( $path ) );
3334 $against = explode( DIRECTORY_SEPARATOR
, $from );
3336 if ( $pieces[0] !== $against[0] ) {
3337 // Non-matching Windows drive letters?
3338 // Return a full path.
3342 // Trim off common prefix
3343 while ( count( $pieces ) && count( $against )
3344 && $pieces[0] == $against[0] ) {
3345 array_shift( $pieces );
3346 array_shift( $against );
3349 // relative dots to bump us to the parent
3350 while ( count( $against ) ) {
3351 array_unshift( $pieces, '..' );
3352 array_shift( $against );
3355 array_push( $pieces, wfBaseName( $path ) );
3357 return implode( DIRECTORY_SEPARATOR
, $pieces );
3361 * Convert an arbitrarily-long digit string from one numeric base
3362 * to another, optionally zero-padding to a minimum column width.
3364 * Supports base 2 through 36; digit values 10-36 are represented
3365 * as lowercase letters a-z. Input is case-insensitive.
3367 * @param string $input Input number
3368 * @param int $sourceBase Base of the input number
3369 * @param int $destBase Desired base of the output
3370 * @param int $pad Minimum number of digits in the output (pad with zeroes)
3371 * @param bool $lowercase Whether to output in lowercase or uppercase
3372 * @param string $engine Either "gmp", "bcmath", or "php"
3373 * @return string|bool The output number as a string, or false on error
3375 function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1,
3376 $lowercase = true, $engine = 'auto'
3378 $input = (string)$input;
3384 $sourceBase != (int)$sourceBase ||
3385 $destBase != (int)$destBase ||
3386 $pad != (int)$pad ||
3388 "/^[" . substr( '0123456789abcdefghijklmnopqrstuvwxyz', 0, $sourceBase ) . "]+$/i",
3395 static $baseChars = array(
3396 10 => 'a', 11 => 'b', 12 => 'c', 13 => 'd', 14 => 'e', 15 => 'f',
3397 16 => 'g', 17 => 'h', 18 => 'i', 19 => 'j', 20 => 'k', 21 => 'l',
3398 22 => 'm', 23 => 'n', 24 => 'o', 25 => 'p', 26 => 'q', 27 => 'r',
3399 28 => 's', 29 => 't', 30 => 'u', 31 => 'v', 32 => 'w', 33 => 'x',
3400 34 => 'y', 35 => 'z',
3402 '0' => 0, '1' => 1, '2' => 2, '3' => 3, '4' => 4, '5' => 5,
3403 '6' => 6, '7' => 7, '8' => 8, '9' => 9, 'a' => 10, 'b' => 11,
3404 'c' => 12, 'd' => 13, 'e' => 14, 'f' => 15, 'g' => 16, 'h' => 17,
3405 'i' => 18, 'j' => 19, 'k' => 20, 'l' => 21, 'm' => 22, 'n' => 23,
3406 'o' => 24, 'p' => 25, 'q' => 26, 'r' => 27, 's' => 28, 't' => 29,
3407 'u' => 30, 'v' => 31, 'w' => 32, 'x' => 33, 'y' => 34, 'z' => 35
3410 if ( extension_loaded( 'gmp' ) && ( $engine == 'auto' ||
$engine == 'gmp' ) ) {
3411 $result = gmp_strval( gmp_init( $input, $sourceBase ), $destBase );
3412 } elseif ( extension_loaded( 'bcmath' ) && ( $engine == 'auto' ||
$engine == 'bcmath' ) ) {
3414 foreach ( str_split( strtolower( $input ) ) as $char ) {
3415 $decimal = bcmul( $decimal, $sourceBase );
3416 $decimal = bcadd( $decimal, $baseChars[$char] );
3419 for ( $result = ''; bccomp( $decimal, 0 ); $decimal = bcdiv( $decimal, $destBase, 0 ) ) {
3420 $result .= $baseChars[bcmod( $decimal, $destBase )];
3423 $result = strrev( $result );
3425 $inDigits = array();
3426 foreach ( str_split( strtolower( $input ) ) as $char ) {
3427 $inDigits[] = $baseChars[$char];
3430 // Iterate over the input, modulo-ing out an output digit
3431 // at a time until input is gone.
3433 while ( $inDigits ) {
3435 $workDigits = array();
3438 foreach ( $inDigits as $digit ) {
3439 $work *= $sourceBase;
3442 if ( $workDigits ||
$work >= $destBase ) {
3443 $workDigits[] = (int)( $work / $destBase );
3448 // All that division leaves us with a remainder,
3449 // which is conveniently our next output digit.
3450 $result .= $baseChars[$work];
3453 $inDigits = $workDigits;
3456 $result = strrev( $result );
3459 if ( !$lowercase ) {
3460 $result = strtoupper( $result );
3463 return str_pad( $result, $pad, '0', STR_PAD_LEFT
);
3467 * Check if there is sufficient entropy in php's built-in session generation
3469 * @return bool true = there is sufficient entropy
3471 function wfCheckEntropy() {
3473 ( wfIsWindows() && version_compare( PHP_VERSION
, '5.3.3', '>=' ) )
3474 ||
ini_get( 'session.entropy_file' )
3476 && intval( ini_get( 'session.entropy_length' ) ) >= 32;
3480 * Override session_id before session startup if php's built-in
3481 * session generation code is not secure.
3483 function wfFixSessionID() {
3484 // If the cookie or session id is already set we already have a session and should abort
3485 if ( isset( $_COOKIE[session_name()] ) ||
session_id() ) {
3489 // PHP's built-in session entropy is enabled if:
3490 // - entropy_file is set or you're on Windows with php 5.3.3+
3491 // - AND entropy_length is > 0
3492 // We treat it as disabled if it doesn't have an entropy length of at least 32
3493 $entropyEnabled = wfCheckEntropy();
3495 // If built-in entropy is not enabled or not sufficient override PHP's
3496 // built in session id generation code
3497 if ( !$entropyEnabled ) {
3498 wfDebug( __METHOD__
. ": PHP's built in entropy is disabled or not sufficient, " .
3499 "overriding session id generation using our cryptrand source.\n" );
3500 session_id( MWCryptRand
::generateHex( 32 ) );
3505 * Reset the session_id
3509 function wfResetSessionID() {
3510 global $wgCookieSecure;
3511 $oldSessionId = session_id();
3512 $cookieParams = session_get_cookie_params();
3513 if ( wfCheckEntropy() && $wgCookieSecure == $cookieParams['secure'] ) {
3514 session_regenerate_id( false );
3518 wfSetupSession( MWCryptRand
::generateHex( 32 ) );
3521 $newSessionId = session_id();
3522 wfRunHooks( 'ResetSessionID', array( $oldSessionId, $newSessionId ) );
3526 * Initialise php session
3528 * @param bool $sessionId
3530 function wfSetupSession( $sessionId = false ) {
3531 global $wgSessionsInMemcached, $wgSessionsInObjectCache, $wgCookiePath, $wgCookieDomain,
3532 $wgCookieSecure, $wgCookieHttpOnly, $wgSessionHandler;
3533 if ( $wgSessionsInObjectCache ||
$wgSessionsInMemcached ) {
3534 ObjectCacheSessionHandler
::install();
3535 } elseif ( $wgSessionHandler && $wgSessionHandler != ini_get( 'session.save_handler' ) ) {
3536 # Only set this if $wgSessionHandler isn't null and session.save_handler
3537 # hasn't already been set to the desired value (that causes errors)
3538 ini_set( 'session.save_handler', $wgSessionHandler );
3540 session_set_cookie_params(
3541 0, $wgCookiePath, $wgCookieDomain, $wgCookieSecure, $wgCookieHttpOnly );
3542 session_cache_limiter( 'private, must-revalidate' );
3544 session_id( $sessionId );
3548 wfSuppressWarnings();
3550 wfRestoreWarnings();
3554 * Get an object from the precompiled serialized directory
3556 * @param string $name
3557 * @return mixed The variable on success, false on failure
3559 function wfGetPrecompiledData( $name ) {
3562 $file = "$IP/serialized/$name";
3563 if ( file_exists( $file ) ) {
3564 $blob = file_get_contents( $file );
3566 return unserialize( $blob );
3575 * @param string [$args,...]
3578 function wfMemcKey( /*...*/ ) {
3579 global $wgCachePrefix;
3580 $prefix = $wgCachePrefix === false ?
wfWikiID() : $wgCachePrefix;
3581 $args = func_get_args();
3582 $key = $prefix . ':' . implode( ':', $args );
3583 $key = str_replace( ' ', '_', $key );
3588 * Get a cache key for a foreign DB
3591 * @param string $prefix
3592 * @param string [$args,...]
3595 function wfForeignMemcKey( $db, $prefix /*...*/ ) {
3596 $args = array_slice( func_get_args(), 2 );
3598 $key = "$db-$prefix:" . implode( ':', $args );
3600 $key = $db . ':' . implode( ':', $args );
3602 return str_replace( ' ', '_', $key );
3606 * Get an ASCII string identifying this wiki
3607 * This is used as a prefix in memcached keys
3611 function wfWikiID() {
3612 global $wgDBprefix, $wgDBname;
3613 if ( $wgDBprefix ) {
3614 return "$wgDBname-$wgDBprefix";
3621 * Split a wiki ID into DB name and table prefix
3623 * @param string $wiki
3627 function wfSplitWikiID( $wiki ) {
3628 $bits = explode( '-', $wiki, 2 );
3629 if ( count( $bits ) < 2 ) {
3636 * Get a Database object.
3638 * @param int $db Index of the connection to get. May be DB_MASTER for the
3639 * master (for write queries), DB_SLAVE for potentially lagged read
3640 * queries, or an integer >= 0 for a particular server.
3642 * @param string|string[] $groups Query groups. An array of group names that this query
3643 * belongs to. May contain a single string if the query is only
3646 * @param string|bool $wiki The wiki ID, or false for the current wiki
3648 * Note: multiple calls to wfGetDB(DB_SLAVE) during the course of one request
3649 * will always return the same object, unless the underlying connection or load
3650 * balancer is manually destroyed.
3652 * Note 2: use $this->getDB() in maintenance scripts that may be invoked by
3653 * updater to ensure that a proper database is being updated.
3655 * @return DatabaseBase
3657 function &wfGetDB( $db, $groups = array(), $wiki = false ) {
3658 return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
3662 * Get a load balancer object.
3664 * @param string|bool $wiki wiki ID, or false for the current wiki
3665 * @return LoadBalancer
3667 function wfGetLB( $wiki = false ) {
3668 return wfGetLBFactory()->getMainLB( $wiki );
3672 * Get the load balancer factory object
3676 function &wfGetLBFactory() {
3677 return LBFactory
::singleton();
3682 * Shortcut for RepoGroup::singleton()->findFile()
3684 * @param string $title or Title object
3685 * @param array $options Associative array of options:
3686 * time: requested time for an archived image, or false for the
3687 * current version. An image object will be returned which was
3688 * created at the specified time.
3690 * ignoreRedirect: If true, do not follow file redirects
3692 * private: If true, return restricted (deleted) files if the current
3693 * user is allowed to view them. Otherwise, such files will not
3696 * bypassCache: If true, do not use the process-local cache of File objects
3698 * @return File, or false if the file does not exist
3700 function wfFindFile( $title, $options = array() ) {
3701 return RepoGroup
::singleton()->findFile( $title, $options );
3705 * Get an object referring to a locally registered file.
3706 * Returns a valid placeholder object if the file does not exist.
3708 * @param Title|string $title
3709 * @return LocalFile|null A File, or null if passed an invalid Title
3711 function wfLocalFile( $title ) {
3712 return RepoGroup
::singleton()->getLocalRepo()->newFile( $title );
3716 * Should low-performance queries be disabled?
3719 * @codeCoverageIgnore
3721 function wfQueriesMustScale() {
3722 global $wgMiserMode;
3724 ||
( SiteStats
::pages() > 100000
3725 && SiteStats
::edits() > 1000000
3726 && SiteStats
::users() > 10000 );
3730 * Get the path to a specified script file, respecting file
3731 * extensions; this is a wrapper around $wgScriptExtension etc.
3732 * except for 'index' and 'load' which use $wgScript/$wgLoadScript
3734 * @param string $script script filename, sans extension
3737 function wfScript( $script = 'index' ) {
3738 global $wgScriptPath, $wgScriptExtension, $wgScript, $wgLoadScript;
3739 if ( $script === 'index' ) {
3741 } elseif ( $script === 'load' ) {
3742 return $wgLoadScript;
3744 return "{$wgScriptPath}/{$script}{$wgScriptExtension}";
3749 * Get the script URL.
3751 * @return string script URL
3753 function wfGetScriptUrl() {
3754 if ( isset( $_SERVER['SCRIPT_NAME'] ) ) {
3756 # as it was called, minus the query string.
3758 # Some sites use Apache rewrite rules to handle subdomains,
3759 # and have PHP set up in a weird way that causes PHP_SELF
3760 # to contain the rewritten URL instead of the one that the
3761 # outside world sees.
3763 # If in this mode, use SCRIPT_URL instead, which mod_rewrite
3764 # provides containing the "before" URL.
3765 return $_SERVER['SCRIPT_NAME'];
3767 return $_SERVER['URL'];
3772 * Convenience function converts boolean values into "true"
3773 * or "false" (string) values
3775 * @param bool $value
3778 function wfBoolToStr( $value ) {
3779 return $value ?
'true' : 'false';
3783 * Get a platform-independent path to the null file, e.g. /dev/null
3787 function wfGetNull() {
3788 return wfIsWindows() ?
'NUL' : '/dev/null';
3792 * Modern version of wfWaitForSlaves(). Instead of looking at replication lag
3793 * and waiting for it to go down, this waits for the slaves to catch up to the
3794 * master position. Use this when updating very large numbers of rows, as
3795 * in maintenance scripts, to avoid causing too much lag. Of course, this is
3796 * a no-op if there are no slaves.
3798 * @param int|bool $maxLag (deprecated)
3799 * @param string|bool $wiki Wiki identifier accepted by wfGetLB
3800 * @param string|bool $cluster Cluster name accepted by LBFactory. Default: false.
3802 function wfWaitForSlaves( $maxLag = false, $wiki = false, $cluster = false ) {
3803 if ( $cluster !== false ) {
3804 $lb = wfGetLBFactory()->getExternalLB( $cluster );
3806 $lb = wfGetLB( $wiki );
3809 // bug 27975 - Don't try to wait for slaves if there are none
3810 // Prevents permission error when getting master position
3811 if ( $lb->getServerCount() > 1 ) {
3812 $dbw = $lb->getConnection( DB_MASTER
, array(), $wiki );
3813 $pos = $dbw->getMasterPos();
3814 // The DBMS may not support getMasterPos() or the whole
3815 // load balancer might be fake (e.g. $wgAllDBsAreLocalhost).
3816 if ( $pos !== false ) {
3817 $lb->waitForAll( $pos );
3823 * Count down from $seconds to zero on the terminal, with a one-second pause
3824 * between showing each number. For use in command-line scripts.
3826 * @codeCoverageIgnore
3827 * @param int $seconds
3829 function wfCountDown( $seconds ) {
3830 for ( $i = $seconds; $i >= 0; $i-- ) {
3831 if ( $i != $seconds ) {
3832 echo str_repeat( "\x08", strlen( $i +
1 ) );
3844 * Replace all invalid characters with -
3845 * Additional characters can be defined in $wgIllegalFileChars (see bug 20489)
3846 * By default, $wgIllegalFileChars = ':'
3848 * @param string $name Filename to process
3851 function wfStripIllegalFilenameChars( $name ) {
3852 global $wgIllegalFileChars;
3853 $illegalFileChars = $wgIllegalFileChars ?
"|[" . $wgIllegalFileChars . "]" : '';
3854 $name = wfBaseName( $name );
3855 $name = preg_replace(
3856 "/[^" . Title
::legalChars() . "]" . $illegalFileChars . "/",
3864 * Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit;
3866 * @return int Value the memory limit was set to.
3868 function wfMemoryLimit() {
3869 global $wgMemoryLimit;
3870 $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
3871 if ( $memlimit != -1 ) {
3872 $conflimit = wfShorthandToInteger( $wgMemoryLimit );
3873 if ( $conflimit == -1 ) {
3874 wfDebug( "Removing PHP's memory limit\n" );
3875 wfSuppressWarnings();
3876 ini_set( 'memory_limit', $conflimit );
3877 wfRestoreWarnings();
3879 } elseif ( $conflimit > $memlimit ) {
3880 wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
3881 wfSuppressWarnings();
3882 ini_set( 'memory_limit', $conflimit );
3883 wfRestoreWarnings();
3891 * Converts shorthand byte notation to integer form
3893 * @param string $string
3896 function wfShorthandToInteger( $string = '' ) {
3897 $string = trim( $string );
3898 if ( $string === '' ) {
3901 $last = $string[strlen( $string ) - 1];
3902 $val = intval( $string );
3907 // break intentionally missing
3911 // break intentionally missing
3921 * Get the normalised IETF language tag
3922 * See unit test for examples.
3924 * @param string $code The language code.
3925 * @return string The language code which complying with BCP 47 standards.
3927 function wfBCP47( $code ) {
3928 $codeSegment = explode( '-', $code );
3930 foreach ( $codeSegment as $segNo => $seg ) {
3931 // when previous segment is x, it is a private segment and should be lc
3932 if ( $segNo > 0 && strtolower( $codeSegment[( $segNo - 1 )] ) == 'x' ) {
3933 $codeBCP[$segNo] = strtolower( $seg );
3934 // ISO 3166 country code
3935 } elseif ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) {
3936 $codeBCP[$segNo] = strtoupper( $seg );
3937 // ISO 15924 script code
3938 } elseif ( ( strlen( $seg ) == 4 ) && ( $segNo > 0 ) ) {
3939 $codeBCP[$segNo] = ucfirst( strtolower( $seg ) );
3940 // Use lowercase for other cases
3942 $codeBCP[$segNo] = strtolower( $seg );
3945 $langCode = implode( '-', $codeBCP );
3950 * Get a cache object.
3952 * @param $inputType integer Cache type, one the the CACHE_* constants.
3955 function wfGetCache( $inputType ) {
3956 return ObjectCache
::getInstance( $inputType );
3960 * Get the main cache object
3964 function wfGetMainCache() {
3965 global $wgMainCacheType;
3966 return ObjectCache
::getInstance( $wgMainCacheType );
3970 * Get the cache object used by the message cache
3974 function wfGetMessageCacheStorage() {
3975 global $wgMessageCacheType;
3976 return ObjectCache
::getInstance( $wgMessageCacheType );
3980 * Get the cache object used by the parser cache
3984 function wfGetParserCacheStorage() {
3985 global $wgParserCacheType;
3986 return ObjectCache
::getInstance( $wgParserCacheType );
3990 * Get the cache object used by the language converter
3994 function wfGetLangConverterCacheStorage() {
3995 global $wgLanguageConverterCacheType;
3996 return ObjectCache
::getInstance( $wgLanguageConverterCacheType );
4000 * Call hook functions defined in $wgHooks
4002 * @param string $event event name
4003 * @param array $args parameters passed to hook functions
4004 * @param string|null $deprecatedVersion optionally mark hook as deprecated with version number
4006 * @return bool True if no handler aborted the hook
4008 function wfRunHooks( $event, array $args = array(), $deprecatedVersion = null ) {
4009 return Hooks
::run( $event, $args, $deprecatedVersion );
4013 * Wrapper around php's unpack.
4015 * @param string $format The format string (See php's docs)
4016 * @param string $data A binary string of binary data
4017 * @param int|bool $length The minimum length of $data or false. This is to
4018 * prevent reading beyond the end of $data. false to disable the check.
4020 * Also be careful when using this function to read unsigned 32 bit integer
4021 * because php might make it negative.
4023 * @throws MWException if $data not long enough, or if unpack fails
4024 * @return array Associative array of the extracted data
4026 function wfUnpack( $format, $data, $length = false ) {
4027 if ( $length !== false ) {
4028 $realLen = strlen( $data );
4029 if ( $realLen < $length ) {
4030 throw new MWException( "Tried to use wfUnpack on a "
4031 . "string of length $realLen, but needed one "
4032 . "of at least length $length."
4037 wfSuppressWarnings();
4038 $result = unpack( $format, $data );
4039 wfRestoreWarnings();
4041 if ( $result === false ) {
4042 // If it cannot extract the packed data.
4043 throw new MWException( "unpack could not unpack binary data" );
4049 * Determine if an image exists on the 'bad image list'.
4051 * The format of MediaWiki:Bad_image_list is as follows:
4052 * * Only list items (lines starting with "*") are considered
4053 * * The first link on a line must be a link to a bad image
4054 * * Any subsequent links on the same line are considered to be exceptions,
4055 * i.e. articles where the image may occur inline.
4057 * @param string $name the image name to check
4058 * @param Title|bool $contextTitle The page on which the image occurs, if known
4059 * @param string $blacklist wikitext of a file blacklist
4062 function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
4063 static $badImageCache = null; // based on bad_image_list msg
4064 wfProfileIn( __METHOD__
);
4067 $redirectTitle = RepoGroup
::singleton()->checkRedirect( Title
::makeTitle( NS_FILE
, $name ) );
4068 if ( $redirectTitle ) {
4069 $name = $redirectTitle->getDBkey();
4072 # Run the extension hook
4074 if ( !wfRunHooks( 'BadImage', array( $name, &$bad ) ) ) {
4075 wfProfileOut( __METHOD__
);
4079 $cacheable = ( $blacklist === null );
4080 if ( $cacheable && $badImageCache !== null ) {
4081 $badImages = $badImageCache;
4082 } else { // cache miss
4083 if ( $blacklist === null ) {
4084 $blacklist = wfMessage( 'bad_image_list' )->inContentLanguage()->plain(); // site list
4086 # Build the list now
4087 $badImages = array();
4088 $lines = explode( "\n", $blacklist );
4089 foreach ( $lines as $line ) {
4091 if ( substr( $line, 0, 1 ) !== '*' ) {
4097 if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
4101 $exceptions = array();
4102 $imageDBkey = false;
4103 foreach ( $m[1] as $i => $titleText ) {
4104 $title = Title
::newFromText( $titleText );
4105 if ( !is_null( $title ) ) {
4107 $imageDBkey = $title->getDBkey();
4109 $exceptions[$title->getPrefixedDBkey()] = true;
4114 if ( $imageDBkey !== false ) {
4115 $badImages[$imageDBkey] = $exceptions;
4119 $badImageCache = $badImages;
4123 $contextKey = $contextTitle ?
$contextTitle->getPrefixedDBkey() : false;
4124 $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
4125 wfProfileOut( __METHOD__
);
4130 * Determine whether the client at a given source IP is likely to be able to
4131 * access the wiki via HTTPS.
4133 * @param string $ip The IPv4/6 address in the normal human-readable form
4136 function wfCanIPUseHTTPS( $ip ) {
4138 wfRunHooks( 'CanIPUseHTTPS', array( $ip, &$canDo ) );
4143 * Work out the IP address based on various globals
4144 * For trusted proxies, use the XFF client IP (first of the chain)
4146 * @deprecated in 1.19; call $wgRequest->getIP() directly.
4149 function wfGetIP() {
4150 wfDeprecated( __METHOD__
, '1.19' );
4152 return $wgRequest->getIP();
4156 * Checks if an IP is a trusted proxy provider.
4157 * Useful to tell if X-Forwarded-For data is possibly bogus.
4158 * Squid cache servers for the site are whitelisted.
4163 function wfIsTrustedProxy( $ip ) {
4164 $trusted = wfIsConfiguredProxy( $ip );
4165 wfRunHooks( 'IsTrustedProxy', array( &$ip, &$trusted ) );
4170 * Checks if an IP matches a proxy we've configured.
4174 * @since 1.23 Supports CIDR ranges in $wgSquidServersNoPurge
4176 function wfIsConfiguredProxy( $ip ) {
4177 global $wgSquidServers, $wgSquidServersNoPurge;
4179 // quick check of known proxy servers
4180 $trusted = in_array( $ip, $wgSquidServers )
4181 ||
in_array( $ip, $wgSquidServersNoPurge );
4184 // slightly slower check to see if the ip is listed directly or in a CIDR
4185 // block in $wgSquidServersNoPurge
4186 foreach ( $wgSquidServersNoPurge as $block ) {
4187 if ( strpos( $block, '/' ) !== false && IP
::isInRange( $ip, $block ) ) {