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 * $wgProfileOnly - if set, normal debug messages will not be recorded.
925 * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
926 * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
928 * @param $text String
929 * @param string|bool $dest Destination of the message:
930 * - 'all': both to the log and HTML (debug toolbar or HTML comments)
931 * - 'log': only to the log and not in HTML
932 * For backward compatibility, it can also take a boolean:
933 * - true: same as 'all'
934 * - false: same as 'log'
936 function wfDebug( $text, $dest = 'all' ) {
937 global $wgDebugLogFile, $wgProfileOnly, $wgDebugRawPage, $wgDebugLogPrefix;
939 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
943 // Turn $dest into a string if it's a boolean (for b/c)
944 if ( $dest === true ) {
946 } elseif ( $dest === false ) {
950 $timer = wfDebugTimer();
951 if ( $timer !== '' ) {
952 $text = preg_replace( '/[^\n]/', $timer . '\0', $text, 1 );
955 if ( $dest === 'all' ) {
956 MWDebug
::debugMsg( $text );
959 if ( $wgDebugLogFile != '' && !$wgProfileOnly ) {
960 # Strip unprintables; they can switch terminal modes when binary data
961 # gets dumped, which is pretty annoying.
962 $text = preg_replace( '![\x00-\x08\x0b\x0c\x0e-\x1f]!', ' ', $text );
963 $text = $wgDebugLogPrefix . $text;
964 wfErrorLog( $text, $wgDebugLogFile );
969 * Returns true if debug logging should be suppressed if $wgDebugRawPage = false
972 function wfIsDebugRawPage() {
974 if ( $cache !== null ) {
977 # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
978 if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
980 isset( $_SERVER['SCRIPT_NAME'] )
981 && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
992 * Get microsecond timestamps for debug logs
996 function wfDebugTimer() {
997 global $wgDebugTimestamps, $wgRequestTime;
999 if ( !$wgDebugTimestamps ) {
1003 $prefix = sprintf( "%6.4f", microtime( true ) - $wgRequestTime );
1004 $mem = sprintf( "%5.1fM", ( memory_get_usage( true ) / ( 1024 * 1024 ) ) );
1005 return "$prefix $mem ";
1009 * Send a line giving PHP memory usage.
1011 * @param bool $exact print exact values instead of kilobytes (default: false)
1013 function wfDebugMem( $exact = false ) {
1014 $mem = memory_get_usage();
1016 $mem = floor( $mem / 1024 ) . ' kilobytes';
1020 wfDebug( "Memory usage: $mem\n" );
1024 * Send a line to a supplementary debug log file, if configured, or main debug log if not.
1025 * To configure a supplementary log file, set $wgDebugLogGroups[$logGroup] to a string
1026 * filename or an associative array mapping 'destination' to the desired filename. The
1027 * associative array may also contain a 'sample' key with an integer value, specifying
1028 * a sampling factor.
1030 * @since 1.23 support for sampling log messages via $wgDebugLogGroups.
1032 * @param string $logGroup
1033 * @param string $text
1034 * @param string|bool $dest Destination of the message:
1035 * - 'all': both to the log and HTML (debug toolbar or HTML comments)
1036 * - 'log': only to the log and not in HTML
1037 * - 'private': only to the specifc log if set in $wgDebugLogGroups and
1038 * discarded otherwise
1039 * For backward compatibility, it can also take a boolean:
1040 * - true: same as 'all'
1041 * - false: same as 'private'
1043 function wfDebugLog( $logGroup, $text, $dest = 'all' ) {
1044 global $wgDebugLogGroups;
1046 $text = trim( $text ) . "\n";
1048 // Turn $dest into a string if it's a boolean (for b/c)
1049 if ( $dest === true ) {
1051 } elseif ( $dest === false ) {
1055 if ( !isset( $wgDebugLogGroups[$logGroup] ) ) {
1056 if ( $dest !== 'private' ) {
1057 wfDebug( "[$logGroup] $text", $dest );
1062 if ( $dest === 'all' ) {
1063 MWDebug
::debugMsg( "[$logGroup] $text" );
1066 $logConfig = $wgDebugLogGroups[$logGroup];
1067 if ( $logConfig === false ) {
1070 if ( is_array( $logConfig ) ) {
1071 if ( isset( $logConfig['sample'] ) && mt_rand( 1, $logConfig['sample'] ) !== 1 ) {
1074 $destination = $logConfig['destination'];
1076 $destination = strval( $logConfig );
1079 $time = wfTimestamp( TS_DB
);
1081 $host = wfHostname();
1082 wfErrorLog( "$time $host $wiki: $text", $destination );
1086 * Log for database errors
1088 * @param string $text database error message.
1090 function wfLogDBError( $text ) {
1091 global $wgDBerrorLog, $wgDBerrorLogTZ;
1092 static $logDBErrorTimeZoneObject = null;
1094 if ( $wgDBerrorLog ) {
1095 $host = wfHostname();
1098 if ( $wgDBerrorLogTZ && !$logDBErrorTimeZoneObject ) {
1099 $logDBErrorTimeZoneObject = new DateTimeZone( $wgDBerrorLogTZ );
1102 // Workaround for https://bugs.php.net/bug.php?id=52063
1103 // Can be removed when min PHP > 5.3.2
1104 if ( $logDBErrorTimeZoneObject === null ) {
1105 $d = date_create( "now" );
1107 $d = date_create( "now", $logDBErrorTimeZoneObject );
1110 $date = $d->format( 'D M j G:i:s T Y' );
1112 $text = "$date\t$host\t$wiki\t" . trim( $text ) . "\n";
1113 wfErrorLog( $text, $wgDBerrorLog );
1118 * Throws a warning that $function is deprecated
1120 * @param $function String
1121 * @param string|bool $version Version of MediaWiki that the function
1122 * was deprecated in (Added in 1.19).
1123 * @param string|bool $component Added in 1.19.
1124 * @param $callerOffset integer: How far up the call stack is the original
1125 * caller. 2 = function that called the function that called
1126 * wfDeprecated (Added in 1.20)
1130 function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) {
1131 MWDebug
::deprecated( $function, $version, $component, $callerOffset +
1 );
1135 * Send a warning either to the debug log or in a PHP error depending on
1136 * $wgDevelopmentWarnings. To log warnings in production, use wfLogWarning() instead.
1138 * @param string $msg message to send
1139 * @param $callerOffset Integer: number of items to go back in the backtrace to
1140 * find the correct caller (1 = function calling wfWarn, ...)
1141 * @param $level Integer: PHP error level; defaults to E_USER_NOTICE;
1142 * only used when $wgDevelopmentWarnings is true
1144 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE
) {
1145 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'auto' );
1149 * Send a warning as a PHP error and the debug log. This is intended for logging
1150 * warnings in production. For logging development warnings, use WfWarn instead.
1152 * @param $msg String: message to send
1153 * @param $callerOffset Integer: number of items to go back in the backtrace to
1154 * find the correct caller (1 = function calling wfLogWarning, ...)
1155 * @param $level Integer: PHP error level; defaults to E_USER_WARNING
1157 function wfLogWarning( $msg, $callerOffset = 1, $level = E_USER_WARNING
) {
1158 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'production' );
1162 * Log to a file without getting "file size exceeded" signals.
1164 * Can also log to TCP or UDP with the syntax udp://host:port/prefix. This will
1165 * send lines to the specified port, prefixed by the specified prefix and a space.
1167 * @param $text String
1168 * @param string $file filename
1169 * @throws MWException
1171 function wfErrorLog( $text, $file ) {
1172 if ( substr( $file, 0, 4 ) == 'udp:' ) {
1173 # Needs the sockets extension
1174 if ( preg_match( '!^(tcp|udp):(?://)?\[([0-9a-fA-F:]+)\]:(\d+)(?:/(.*))?$!', $file, $m ) ) {
1175 // IPv6 bracketed host
1177 $port = intval( $m[3] );
1178 $prefix = isset( $m[4] ) ?
$m[4] : false;
1180 } elseif ( preg_match( '!^(tcp|udp):(?://)?([a-zA-Z0-9.-]+):(\d+)(?:/(.*))?$!', $file, $m ) ) {
1182 if ( !IP
::isIPv4( $host ) ) {
1183 $host = gethostbyname( $host );
1185 $port = intval( $m[3] );
1186 $prefix = isset( $m[4] ) ?
$m[4] : false;
1189 throw new MWException( __METHOD__
. ': Invalid UDP specification' );
1192 // Clean it up for the multiplexer
1193 if ( strval( $prefix ) !== '' ) {
1194 $text = preg_replace( '/^/m', $prefix . ' ', $text );
1197 if ( strlen( $text ) > 65506 ) {
1198 $text = substr( $text, 0, 65506 );
1201 if ( substr( $text, -1 ) != "\n" ) {
1204 } elseif ( strlen( $text ) > 65507 ) {
1205 $text = substr( $text, 0, 65507 );
1208 $sock = socket_create( $domain, SOCK_DGRAM
, SOL_UDP
);
1213 socket_sendto( $sock, $text, strlen( $text ), 0, $host, $port );
1214 socket_close( $sock );
1216 wfSuppressWarnings();
1217 $exists = file_exists( $file );
1218 $size = $exists ?
filesize( $file ) : false;
1219 if ( !$exists ||
( $size !== false && $size +
strlen( $text ) < 0x7fffffff ) ) {
1220 file_put_contents( $file, $text, FILE_APPEND
);
1222 wfRestoreWarnings();
1229 function wfLogProfilingData() {
1230 global $wgRequestTime, $wgDebugLogFile, $wgDebugRawPage, $wgRequest;
1231 global $wgProfileLimit, $wgUser;
1233 StatCounter
::singleton()->flush();
1235 $profiler = Profiler
::instance();
1237 # Profiling must actually be enabled...
1238 if ( $profiler->isStub() ) {
1242 // Get total page request time and only show pages that longer than
1243 // $wgProfileLimit time (default is 0)
1244 $elapsed = microtime( true ) - $wgRequestTime;
1245 if ( $elapsed <= $wgProfileLimit ) {
1249 $profiler->logData();
1251 // Check whether this should be logged in the debug file.
1252 if ( $wgDebugLogFile == '' ||
( !$wgDebugRawPage && wfIsDebugRawPage() ) ) {
1257 if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1258 $forward = ' forwarded for ' . $_SERVER['HTTP_X_FORWARDED_FOR'];
1260 if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1261 $forward .= ' client IP ' . $_SERVER['HTTP_CLIENT_IP'];
1263 if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1264 $forward .= ' from ' . $_SERVER['HTTP_FROM'];
1267 $forward = "\t(proxied via {$_SERVER['REMOTE_ADDR']}{$forward})";
1269 // Don't load $wgUser at this late stage just for statistics purposes
1270 // @todo FIXME: We can detect some anons even if it is not loaded. See User::getId()
1271 if ( $wgUser->isItemLoaded( 'id' ) && $wgUser->isAnon() ) {
1272 $forward .= ' anon';
1275 // Command line script uses a FauxRequest object which does not have
1276 // any knowledge about an URL and throw an exception instead.
1278 $requestUrl = $wgRequest->getRequestURL();
1279 } catch ( MWException
$e ) {
1280 $requestUrl = 'n/a';
1283 $log = sprintf( "%s\t%04.3f\t%s\n",
1284 gmdate( 'YmdHis' ), $elapsed,
1285 urldecode( $requestUrl . $forward ) );
1287 wfErrorLog( $log . $profiler->getOutput(), $wgDebugLogFile );
1291 * Increment a statistics counter
1293 * @param $key String
1297 function wfIncrStats( $key, $count = 1 ) {
1298 StatCounter
::singleton()->incr( $key, $count );
1302 * Check whether the wiki is in read-only mode.
1306 function wfReadOnly() {
1307 return wfReadOnlyReason() !== false;
1311 * Get the value of $wgReadOnly or the contents of $wgReadOnlyFile.
1313 * @return string|bool: String when in read-only mode; false otherwise
1315 function wfReadOnlyReason() {
1316 global $wgReadOnly, $wgReadOnlyFile;
1318 if ( $wgReadOnly === null ) {
1319 // Set $wgReadOnly for faster access next time
1320 if ( is_file( $wgReadOnlyFile ) && filesize( $wgReadOnlyFile ) > 0 ) {
1321 $wgReadOnly = file_get_contents( $wgReadOnlyFile );
1323 $wgReadOnly = false;
1331 * Return a Language object from $langcode
1333 * @param $langcode Mixed: either:
1334 * - a Language object
1335 * - code of the language to get the message for, if it is
1336 * a valid code create a language for that language, if
1337 * it is a string but not a valid code then make a basic
1339 * - a boolean: if it's false then use the global object for
1340 * the current user's language (as a fallback for the old parameter
1341 * functionality), or if it is true then use global object
1342 * for the wiki's content language.
1343 * @return Language object
1345 function wfGetLangObj( $langcode = false ) {
1346 # Identify which language to get or create a language object for.
1347 # Using is_object here due to Stub objects.
1348 if ( is_object( $langcode ) ) {
1349 # Great, we already have the object (hopefully)!
1353 global $wgContLang, $wgLanguageCode;
1354 if ( $langcode === true ||
$langcode === $wgLanguageCode ) {
1355 # $langcode is the language code of the wikis content language object.
1356 # or it is a boolean and value is true
1361 if ( $langcode === false ||
$langcode === $wgLang->getCode() ) {
1362 # $langcode is the language code of user language object.
1363 # or it was a boolean and value is false
1367 $validCodes = array_keys( Language
::fetchLanguageNames() );
1368 if ( in_array( $langcode, $validCodes ) ) {
1369 # $langcode corresponds to a valid language.
1370 return Language
::factory( $langcode );
1373 # $langcode is a string, but not a valid language code; use content language.
1374 wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1379 * This is the function for getting translated interface messages.
1381 * @see Message class for documentation how to use them.
1382 * @see https://www.mediawiki.org/wiki/Manual:Messages_API
1384 * This function replaces all old wfMsg* functions.
1386 * @param string $key Message key
1387 * @param mixed [$params,...] Normal message parameters
1392 * @see Message::__construct
1394 function wfMessage( $key /*...*/ ) {
1395 $params = func_get_args();
1396 array_shift( $params );
1397 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
1398 $params = $params[0];
1400 return new Message( $key, $params );
1404 * This function accepts multiple message keys and returns a message instance
1405 * for the first message which is non-empty. If all messages are empty then an
1406 * instance of the first message key is returned.
1408 * @param string|string[] [$keys,...] Message keys
1413 * @see Message::newFallbackSequence
1415 function wfMessageFallback( /*...*/ ) {
1416 $args = func_get_args();
1417 return call_user_func_array( 'Message::newFallbackSequence', $args );
1421 * Get a message from anywhere, for the current user language.
1423 * Use wfMsgForContent() instead if the message should NOT
1424 * change depending on the user preferences.
1426 * @deprecated since 1.18
1428 * @param string $key lookup key for the message, usually
1429 * defined in languages/Language.php
1431 * Parameters to the message, which can be used to insert variable text into
1432 * it, can be passed to this function in the following formats:
1433 * - One per argument, starting at the second parameter
1434 * - As an array in the second parameter
1435 * These are not shown in the function definition.
1439 function wfMsg( $key ) {
1440 wfDeprecated( __METHOD__
, '1.21' );
1442 $args = func_get_args();
1443 array_shift( $args );
1444 return wfMsgReal( $key, $args );
1448 * Same as above except doesn't transform the message
1450 * @deprecated since 1.18
1452 * @param $key String
1455 function wfMsgNoTrans( $key ) {
1456 wfDeprecated( __METHOD__
, '1.21' );
1458 $args = func_get_args();
1459 array_shift( $args );
1460 return wfMsgReal( $key, $args, true, false, false );
1464 * Get a message from anywhere, for the current global language
1465 * set with $wgLanguageCode.
1467 * Use this if the message should NOT change dependent on the
1468 * language set in the user's preferences. This is the case for
1469 * most text written into logs, as well as link targets (such as
1470 * the name of the copyright policy page). Link titles, on the
1471 * other hand, should be shown in the UI language.
1473 * Note that MediaWiki allows users to change the user interface
1474 * language in their preferences, but a single installation
1475 * typically only contains content in one language.
1477 * Be wary of this distinction: If you use wfMsg() where you should
1478 * use wfMsgForContent(), a user of the software may have to
1479 * customize potentially hundreds of messages in
1480 * order to, e.g., fix a link in every possible language.
1482 * @deprecated since 1.18
1484 * @param string $key lookup key for the message, usually
1485 * defined in languages/Language.php
1488 function wfMsgForContent( $key ) {
1489 wfDeprecated( __METHOD__
, '1.21' );
1491 global $wgForceUIMsgAsContentMsg;
1492 $args = func_get_args();
1493 array_shift( $args );
1495 if ( is_array( $wgForceUIMsgAsContentMsg )
1496 && in_array( $key, $wgForceUIMsgAsContentMsg )
1498 $forcontent = false;
1500 return wfMsgReal( $key, $args, true, $forcontent );
1504 * Same as above except doesn't transform the message
1506 * @deprecated since 1.18
1508 * @param $key String
1511 function wfMsgForContentNoTrans( $key ) {
1512 wfDeprecated( __METHOD__
, '1.21' );
1514 global $wgForceUIMsgAsContentMsg;
1515 $args = func_get_args();
1516 array_shift( $args );
1518 if ( is_array( $wgForceUIMsgAsContentMsg )
1519 && in_array( $key, $wgForceUIMsgAsContentMsg )
1521 $forcontent = false;
1523 return wfMsgReal( $key, $args, true, $forcontent, false );
1527 * Really get a message
1529 * @deprecated since 1.18
1531 * @param string $key key to get.
1532 * @param array $args
1533 * @param bool $useDB
1534 * @param string|bool $forContent Language code, or false for user lang, true for content lang.
1535 * @param bool $transform Whether or not to transform the message.
1536 * @return string The requested message.
1538 function wfMsgReal( $key, $args, $useDB = true, $forContent = false, $transform = true ) {
1539 wfDeprecated( __METHOD__
, '1.21' );
1541 wfProfileIn( __METHOD__
);
1542 $message = wfMsgGetKey( $key, $useDB, $forContent, $transform );
1543 $message = wfMsgReplaceArgs( $message, $args );
1544 wfProfileOut( __METHOD__
);
1549 * Fetch a message string value, but don't replace any keys yet.
1551 * @deprecated since 1.18
1553 * @param string $key
1554 * @param bool $useDB
1555 * @param string|bool $langCode Code of the language to get the message for, or
1556 * behaves as a content language switch if it is a boolean.
1557 * @param bool $transform Whether to parse magic words, etc.
1560 function wfMsgGetKey( $key, $useDB = true, $langCode = false, $transform = true ) {
1561 wfDeprecated( __METHOD__
, '1.21' );
1563 wfRunHooks( 'NormalizeMessageKey', array( &$key, &$useDB, &$langCode, &$transform ) );
1565 $cache = MessageCache
::singleton();
1566 $message = $cache->get( $key, $useDB, $langCode );
1567 if ( $message === false ) {
1568 $message = '<' . htmlspecialchars( $key ) . '>';
1569 } elseif ( $transform ) {
1570 $message = $cache->transform( $message );
1576 * Replace message parameter keys on the given formatted output.
1578 * @param string $message
1579 * @param array $args
1583 function wfMsgReplaceArgs( $message, $args ) {
1584 # Fix windows line-endings
1585 # Some messages are split with explode("\n", $msg)
1586 $message = str_replace( "\r", '', $message );
1588 // Replace arguments
1589 if ( count( $args ) ) {
1590 if ( is_array( $args[0] ) ) {
1591 $args = array_values( $args[0] );
1593 $replacementKeys = array();
1594 foreach ( $args as $n => $param ) {
1595 $replacementKeys['$' . ( $n +
1 )] = $param;
1597 $message = strtr( $message, $replacementKeys );
1604 * Return an HTML-escaped version of a message.
1605 * Parameter replacements, if any, are done *after* the HTML-escaping,
1606 * so parameters may contain HTML (eg links or form controls). Be sure
1607 * to pre-escape them if you really do want plaintext, or just wrap
1608 * the whole thing in htmlspecialchars().
1610 * @deprecated since 1.18
1612 * @param string $key
1613 * @param string [$args,...] Parameters
1616 function wfMsgHtml( $key ) {
1617 wfDeprecated( __METHOD__
, '1.21' );
1619 $args = func_get_args();
1620 array_shift( $args );
1621 return wfMsgReplaceArgs( htmlspecialchars( wfMsgGetKey( $key ) ), $args );
1625 * Return an HTML version of message
1626 * Parameter replacements, if any, are done *after* parsing the wiki-text message,
1627 * so parameters may contain HTML (eg links or form controls). Be sure
1628 * to pre-escape them if you really do want plaintext, or just wrap
1629 * the whole thing in htmlspecialchars().
1631 * @deprecated since 1.18
1633 * @param string $key
1634 * @param string [$args,...] Parameters
1637 function wfMsgWikiHtml( $key ) {
1638 wfDeprecated( __METHOD__
, '1.21' );
1640 $args = func_get_args();
1641 array_shift( $args );
1642 return wfMsgReplaceArgs(
1643 MessageCache
::singleton()->parse( wfMsgGetKey( $key ), null,
1644 /* can't be set to false */ true, /* interface */ true )->getText(),
1649 * Returns message in the requested format
1651 * @deprecated since 1.18
1653 * @param string $key key of the message
1654 * @param array $options processing rules.
1655 * Can take the following options:
1656 * parse: parses wikitext to HTML
1657 * parseinline: parses wikitext to HTML and removes the surrounding
1658 * p's added by parser or tidy
1659 * escape: filters message through htmlspecialchars
1660 * escapenoentities: same, but allows entity references like   through
1661 * replaceafter: parameters are substituted after parsing or escaping
1662 * parsemag: transform the message using magic phrases
1663 * content: fetch message for content language instead of interface
1664 * Also can accept a single associative argument, of the form 'language' => 'xx':
1665 * language: Language object or language code to fetch message for
1666 * (overridden by content).
1667 * Behavior for conflicting options (e.g., parse+parseinline) is undefined.
1671 function wfMsgExt( $key, $options ) {
1672 wfDeprecated( __METHOD__
, '1.21' );
1674 $args = func_get_args();
1675 array_shift( $args );
1676 array_shift( $args );
1677 $options = (array)$options;
1679 foreach ( $options as $arrayKey => $option ) {
1680 if ( !preg_match( '/^[0-9]+|language$/', $arrayKey ) ) {
1681 # An unknown index, neither numeric nor "language"
1682 wfWarn( "wfMsgExt called with incorrect parameter key $arrayKey", 1, E_USER_WARNING
);
1683 } elseif ( preg_match( '/^[0-9]+$/', $arrayKey ) && !in_array( $option,
1684 array( 'parse', 'parseinline', 'escape', 'escapenoentities',
1685 'replaceafter', 'parsemag', 'content' ) ) ) {
1686 # A numeric index with unknown value
1687 wfWarn( "wfMsgExt called with incorrect parameter $option", 1, E_USER_WARNING
);
1691 if ( in_array( 'content', $options, true ) ) {
1694 $langCodeObj = null;
1695 } elseif ( array_key_exists( 'language', $options ) ) {
1696 $forContent = false;
1697 $langCode = wfGetLangObj( $options['language'] );
1698 $langCodeObj = $langCode;
1700 $forContent = false;
1702 $langCodeObj = null;
1705 $string = wfMsgGetKey( $key, /*DB*/true, $langCode, /*Transform*/false );
1707 if ( !in_array( 'replaceafter', $options, true ) ) {
1708 $string = wfMsgReplaceArgs( $string, $args );
1711 $messageCache = MessageCache
::singleton();
1712 $parseInline = in_array( 'parseinline', $options, true );
1713 if ( in_array( 'parse', $options, true ) ||
$parseInline ) {
1714 $string = $messageCache->parse( $string, null, true, !$forContent, $langCodeObj );
1715 if ( $string instanceof ParserOutput
) {
1716 $string = $string->getText();
1719 if ( $parseInline ) {
1721 if ( preg_match( '/^<p>(.*)\n?<\/p>\n?$/sU', $string, $m ) ) {
1725 } elseif ( in_array( 'parsemag', $options, true ) ) {
1726 $string = $messageCache->transform( $string,
1727 !$forContent, $langCodeObj );
1730 if ( in_array( 'escape', $options, true ) ) {
1731 $string = htmlspecialchars ( $string );
1732 } elseif ( in_array( 'escapenoentities', $options, true ) ) {
1733 $string = Sanitizer
::escapeHtmlAllowEntities( $string );
1736 if ( in_array( 'replaceafter', $options, true ) ) {
1737 $string = wfMsgReplaceArgs( $string, $args );
1744 * Since wfMsg() and co suck, they don't return false if the message key they
1745 * looked up didn't exist but instead the key wrapped in <>'s, this function checks for the
1746 * nonexistence of messages by checking the MessageCache::get() result directly.
1748 * @deprecated since 1.18. Use Message::isDisabled().
1750 * @param string $key The message key looked up
1751 * @return bool True if the message *doesn't* exist.
1753 function wfEmptyMsg( $key ) {
1754 wfDeprecated( __METHOD__
, '1.21' );
1756 return MessageCache
::singleton()->get( $key, /*useDB*/true, /*content*/false ) === false;
1760 * Throw a debugging exception. This function previously once exited the process,
1761 * but now throws an exception instead, with similar results.
1763 * @deprecated since 1.22; just throw an MWException yourself
1764 * @param string $msg message shown when dying.
1765 * @throws MWException
1767 function wfDebugDieBacktrace( $msg = '' ) {
1768 wfDeprecated( __FUNCTION__
, '1.22' );
1769 throw new MWException( $msg );
1773 * Fetch server name for use in error reporting etc.
1774 * Use real server name if available, so we know which machine
1775 * in a server farm generated the current page.
1779 function wfHostname() {
1781 if ( is_null( $host ) ) {
1783 # Hostname overriding
1784 global $wgOverrideHostname;
1785 if ( $wgOverrideHostname !== false ) {
1786 # Set static and skip any detection
1787 $host = $wgOverrideHostname;
1791 if ( function_exists( 'posix_uname' ) ) {
1792 // This function not present on Windows
1793 $uname = posix_uname();
1797 if ( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1798 $host = $uname['nodename'];
1799 } elseif ( getenv( 'COMPUTERNAME' ) ) {
1800 # Windows computer name
1801 $host = getenv( 'COMPUTERNAME' );
1803 # This may be a virtual server.
1804 $host = $_SERVER['SERVER_NAME'];
1811 * Returns a HTML comment with the elapsed time since request.
1812 * This method has no side effects.
1816 function wfReportTime() {
1817 global $wgRequestTime, $wgShowHostnames;
1819 $elapsed = microtime( true ) - $wgRequestTime;
1821 return $wgShowHostnames
1822 ?
sprintf( '<!-- Served by %s in %01.3f secs. -->', wfHostname(), $elapsed )
1823 : sprintf( '<!-- Served in %01.3f secs. -->', $elapsed );
1827 * Safety wrapper for debug_backtrace().
1829 * With Zend Optimizer 3.2.0 loaded, this causes segfaults under somewhat
1830 * murky circumstances, which may be triggered in part by stub objects
1831 * or other fancy talking'.
1833 * Will return an empty array if Zend Optimizer is detected or if
1834 * debug_backtrace is disabled, otherwise the output from
1835 * debug_backtrace() (trimmed).
1837 * @param int $limit This parameter can be used to limit the number of stack frames returned
1839 * @return array of backtrace information
1841 function wfDebugBacktrace( $limit = 0 ) {
1842 static $disabled = null;
1844 if ( extension_loaded( 'Zend Optimizer' ) ) {
1845 wfDebug( "Zend Optimizer detected; skipping debug_backtrace for safety.\n" );
1849 if ( is_null( $disabled ) ) {
1851 $functions = explode( ',', ini_get( 'disable_functions' ) );
1852 $functions = array_map( 'trim', $functions );
1853 $functions = array_map( 'strtolower', $functions );
1854 if ( in_array( 'debug_backtrace', $functions ) ) {
1855 wfDebug( "debug_backtrace is in disabled_functions\n" );
1863 if ( $limit && version_compare( PHP_VERSION
, '5.4.0', '>=' ) ) {
1864 return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT
, $limit +
1 ), 1 );
1866 return array_slice( debug_backtrace(), 1 );
1871 * Get a debug backtrace as a string
1875 function wfBacktrace() {
1876 global $wgCommandLineMode;
1878 if ( $wgCommandLineMode ) {
1883 $backtrace = wfDebugBacktrace();
1884 foreach ( $backtrace as $call ) {
1885 if ( isset( $call['file'] ) ) {
1886 $f = explode( DIRECTORY_SEPARATOR
, $call['file'] );
1887 $file = $f[count( $f ) - 1];
1891 if ( isset( $call['line'] ) ) {
1892 $line = $call['line'];
1896 if ( $wgCommandLineMode ) {
1897 $msg .= "$file line $line calls ";
1899 $msg .= '<li>' . $file . ' line ' . $line . ' calls ';
1901 if ( !empty( $call['class'] ) ) {
1902 $msg .= $call['class'] . $call['type'];
1904 $msg .= $call['function'] . '()';
1906 if ( $wgCommandLineMode ) {
1912 if ( $wgCommandLineMode ) {
1922 * Get the name of the function which called this function
1923 * wfGetCaller( 1 ) is the function with the wfGetCaller() call (ie. __FUNCTION__)
1924 * wfGetCaller( 2 ) [default] is the caller of the function running wfGetCaller()
1925 * wfGetCaller( 3 ) is the parent of that.
1930 function wfGetCaller( $level = 2 ) {
1931 $backtrace = wfDebugBacktrace( $level +
1 );
1932 if ( isset( $backtrace[$level] ) ) {
1933 return wfFormatStackFrame( $backtrace[$level] );
1940 * Return a string consisting of callers in the stack. Useful sometimes
1941 * for profiling specific points.
1943 * @param int $limit The maximum depth of the stack frame to return, or false for
1947 function wfGetAllCallers( $limit = 3 ) {
1948 $trace = array_reverse( wfDebugBacktrace() );
1949 if ( !$limit ||
$limit > count( $trace ) - 1 ) {
1950 $limit = count( $trace ) - 1;
1952 $trace = array_slice( $trace, -$limit - 1, $limit );
1953 return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1957 * Return a string representation of frame
1959 * @param $frame Array
1962 function wfFormatStackFrame( $frame ) {
1963 return isset( $frame['class'] ) ?
1964 $frame['class'] . '::' . $frame['function'] :
1968 /* Some generic result counters, pulled out of SearchEngine */
1973 * @param int $offset
1977 function wfShowingResults( $offset, $limit ) {
1978 return wfMessage( 'showingresults' )->numParams( $limit, $offset +
1 )->parse();
1982 * Generate (prev x| next x) (20|50|100...) type links for paging
1984 * @param string $offset
1986 * @param string $link
1987 * @param string $query optional URL query parameter string
1988 * @param bool $atend optional param for specified if this is the last page
1990 * @deprecated in 1.19; use Language::viewPrevNext() instead
1992 function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) {
1993 wfDeprecated( __METHOD__
, '1.19' );
1997 $query = wfCgiToArray( $query );
1999 if ( is_object( $link ) ) {
2002 $title = Title
::newFromText( $link );
2003 if ( is_null( $title ) ) {
2008 return $wgLang->viewPrevNext( $title, $offset, $limit, $query, $atend );
2013 * @todo FIXME: We may want to blacklist some broken browsers
2015 * @param bool $force
2016 * @return bool Whereas client accept gzip compression
2018 function wfClientAcceptsGzip( $force = false ) {
2019 static $result = null;
2020 if ( $result === null ||
$force ) {
2022 if ( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
2023 # @todo FIXME: We may want to blacklist some broken browsers
2026 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
2027 $_SERVER['HTTP_ACCEPT_ENCODING'],
2031 if ( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
2035 wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
2044 * Obtain the offset and limit values from the request string;
2045 * used in special pages
2047 * @param int $deflimit default limit if none supplied
2048 * @param string $optionname Name of a user preference to check against
2052 function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
2054 return $wgRequest->getLimitOffset( $deflimit, $optionname );
2058 * Escapes the given text so that it may be output using addWikiText()
2059 * without any linking, formatting, etc. making its way through. This
2060 * is achieved by substituting certain characters with HTML entities.
2061 * As required by the callers, "<nowiki>" is not used.
2063 * @param string $text text to be escaped
2066 function wfEscapeWikiText( $text ) {
2067 static $repl = null, $repl2 = null;
2068 if ( $repl === null ) {
2070 '"' => '"', '&' => '&', "'" => ''', '<' => '<',
2071 '=' => '=', '>' => '>', '[' => '[', ']' => ']',
2072 '{' => '{', '|' => '|', '}' => '}', ';' => ';',
2073 "\n#" => "\n#", "\r#" => "\r#",
2074 "\n*" => "\n*", "\r*" => "\r*",
2075 "\n:" => "\n:", "\r:" => "\r:",
2076 "\n " => "\n ", "\r " => "\r ",
2077 "\n\n" => "\n ", "\r\n" => " \n",
2078 "\n\r" => "\n ", "\r\r" => "\r ",
2079 "\n\t" => "\n	", "\r\t" => "\r	", // "\n\t\n" is treated like "\n\n"
2080 "\n----" => "\n----", "\r----" => "\r----",
2081 '__' => '__', '://' => '://',
2084 // We have to catch everything "\s" matches in PCRE
2085 foreach ( array( 'ISBN', 'RFC', 'PMID' ) as $magic ) {
2086 $repl["$magic "] = "$magic ";
2087 $repl["$magic\t"] = "$magic	";
2088 $repl["$magic\r"] = "$magic ";
2089 $repl["$magic\n"] = "$magic ";
2090 $repl["$magic\f"] = "$magic";
2093 // And handle protocols that don't use "://"
2094 global $wgUrlProtocols;
2096 foreach ( $wgUrlProtocols as $prot ) {
2097 if ( substr( $prot, -1 ) === ':' ) {
2098 $repl2[] = preg_quote( substr( $prot, 0, -1 ), '/' );
2101 $repl2 = $repl2 ?
'/\b(' . join( '|', $repl2 ) . '):/i' : '/^(?!)/';
2103 $text = substr( strtr( "\n$text", $repl ), 1 );
2104 $text = preg_replace( $repl2, '$1:', $text );
2109 * Get the current unix timestamp with microseconds. Useful for profiling
2110 * @deprecated since 1.22; call microtime() directly
2114 wfDeprecated( __FUNCTION__
, '1.22' );
2115 return microtime( true );
2119 * Sets dest to source and returns the original value of dest
2120 * If source is NULL, it just returns the value, it doesn't set the variable
2121 * If force is true, it will set the value even if source is NULL
2123 * @param $dest Mixed
2124 * @param $source Mixed
2125 * @param $force Bool
2128 function wfSetVar( &$dest, $source, $force = false ) {
2130 if ( !is_null( $source ) ||
$force ) {
2137 * As for wfSetVar except setting a bit
2141 * @param $state Bool
2145 function wfSetBit( &$dest, $bit, $state = true ) {
2146 $temp = (bool)( $dest & $bit );
2147 if ( !is_null( $state ) ) {
2158 * A wrapper around the PHP function var_export().
2159 * Either print it or add it to the regular output ($wgOut).
2161 * @param $var mixed A PHP variable to dump.
2163 function wfVarDump( $var ) {
2165 $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
2166 if ( headers_sent() ||
!isset( $wgOut ) ||
!is_object( $wgOut ) ) {
2169 $wgOut->addHTML( $s );
2174 * Provide a simple HTTP error.
2176 * @param $code Int|String
2177 * @param $label String
2178 * @param $desc String
2180 function wfHttpError( $code, $label, $desc ) {
2183 header( "HTTP/1.0 $code $label" );
2184 header( "Status: $code $label" );
2185 $wgOut->sendCacheControl();
2187 header( 'Content-type: text/html; charset=utf-8' );
2188 print "<!doctype html>" .
2189 '<html><head><title>' .
2190 htmlspecialchars( $label ) .
2191 '</title></head><body><h1>' .
2192 htmlspecialchars( $label ) .
2194 nl2br( htmlspecialchars( $desc ) ) .
2195 "</p></body></html>\n";
2199 * Clear away any user-level output buffers, discarding contents.
2201 * Suitable for 'starting afresh', for instance when streaming
2202 * relatively large amounts of data without buffering, or wanting to
2203 * output image files without ob_gzhandler's compression.
2205 * The optional $resetGzipEncoding parameter controls suppression of
2206 * the Content-Encoding header sent by ob_gzhandler; by default it
2207 * is left. See comments for wfClearOutputBuffers() for why it would
2210 * Note that some PHP configuration options may add output buffer
2211 * layers which cannot be removed; these are left in place.
2213 * @param $resetGzipEncoding Bool
2215 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
2216 if ( $resetGzipEncoding ) {
2217 // Suppress Content-Encoding and Content-Length
2218 // headers from 1.10+s wfOutputHandler
2219 global $wgDisableOutputCompression;
2220 $wgDisableOutputCompression = true;
2222 while ( $status = ob_get_status() ) {
2223 if ( $status['type'] == 0 /* PHP_OUTPUT_HANDLER_INTERNAL */ ) {
2224 // Probably from zlib.output_compression or other
2225 // PHP-internal setting which can't be removed.
2227 // Give up, and hope the result doesn't break
2231 if ( !ob_end_clean() ) {
2232 // Could not remove output buffer handler; abort now
2233 // to avoid getting in some kind of infinite loop.
2236 if ( $resetGzipEncoding ) {
2237 if ( $status['name'] == 'ob_gzhandler' ) {
2238 // Reset the 'Content-Encoding' field set by this handler
2239 // so we can start fresh.
2240 header_remove( 'Content-Encoding' );
2248 * More legible than passing a 'false' parameter to wfResetOutputBuffers():
2250 * Clear away output buffers, but keep the Content-Encoding header
2251 * produced by ob_gzhandler, if any.
2253 * This should be used for HTTP 304 responses, where you need to
2254 * preserve the Content-Encoding header of the real result, but
2255 * also need to suppress the output of ob_gzhandler to keep to spec
2256 * and avoid breaking Firefox in rare cases where the headers and
2257 * body are broken over two packets.
2259 function wfClearOutputBuffers() {
2260 wfResetOutputBuffers( false );
2264 * Converts an Accept-* header into an array mapping string values to quality
2267 * @param string $accept
2268 * @param string $def default
2269 * @return float[] Associative array of string => float pairs
2271 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
2272 # No arg means accept anything (per HTTP spec)
2274 return array( $def => 1.0 );
2279 $parts = explode( ',', $accept );
2281 foreach ( $parts as $part ) {
2282 # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
2283 $values = explode( ';', trim( $part ) );
2285 if ( count( $values ) == 1 ) {
2286 $prefs[$values[0]] = 1.0;
2287 } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
2288 $prefs[$values[0]] = floatval( $match[1] );
2296 * Checks if a given MIME type matches any of the keys in the given
2297 * array. Basic wildcards are accepted in the array keys.
2299 * Returns the matching MIME type (or wildcard) if a match, otherwise
2302 * @param string $type
2303 * @param array $avail
2307 function mimeTypeMatch( $type, $avail ) {
2308 if ( array_key_exists( $type, $avail ) ) {
2311 $parts = explode( '/', $type );
2312 if ( array_key_exists( $parts[0] . '/*', $avail ) ) {
2313 return $parts[0] . '/*';
2314 } elseif ( array_key_exists( '*/*', $avail ) ) {
2323 * Returns the 'best' match between a client's requested internet media types
2324 * and the server's list of available types. Each list should be an associative
2325 * array of type to preference (preference is a float between 0.0 and 1.0).
2326 * Wildcards in the types are acceptable.
2328 * @param array $cprefs client's acceptable type list
2329 * @param array $sprefs server's offered types
2332 * @todo FIXME: Doesn't handle params like 'text/plain; charset=UTF-8'
2333 * XXX: generalize to negotiate other stuff
2335 function wfNegotiateType( $cprefs, $sprefs ) {
2338 foreach ( array_keys( $sprefs ) as $type ) {
2339 $parts = explode( '/', $type );
2340 if ( $parts[1] != '*' ) {
2341 $ckey = mimeTypeMatch( $type, $cprefs );
2343 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
2348 foreach ( array_keys( $cprefs ) as $type ) {
2349 $parts = explode( '/', $type );
2350 if ( $parts[1] != '*' && !array_key_exists( $type, $sprefs ) ) {
2351 $skey = mimeTypeMatch( $type, $sprefs );
2353 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
2361 foreach ( array_keys( $combine ) as $type ) {
2362 if ( $combine[$type] > $bestq ) {
2364 $bestq = $combine[$type];
2372 * Reference-counted warning suppression
2376 function wfSuppressWarnings( $end = false ) {
2377 static $suppressCount = 0;
2378 static $originalLevel = false;
2381 if ( $suppressCount ) {
2383 if ( !$suppressCount ) {
2384 error_reporting( $originalLevel );
2388 if ( !$suppressCount ) {
2389 $originalLevel = error_reporting( E_ALL
& ~
(
2404 * Restore error level to previous value
2406 function wfRestoreWarnings() {
2407 wfSuppressWarnings( true );
2410 # Autodetect, convert and provide timestamps of various types
2413 * Unix time - the number of seconds since 1970-01-01 00:00:00 UTC
2415 define( 'TS_UNIX', 0 );
2418 * MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
2420 define( 'TS_MW', 1 );
2423 * MySQL DATETIME (YYYY-MM-DD HH:MM:SS)
2425 define( 'TS_DB', 2 );
2428 * RFC 2822 format, for E-mail and HTTP headers
2430 define( 'TS_RFC2822', 3 );
2433 * ISO 8601 format with no timezone: 1986-02-09T20:00:00Z
2435 * This is used by Special:Export
2437 define( 'TS_ISO_8601', 4 );
2440 * An Exif timestamp (YYYY:MM:DD HH:MM:SS)
2442 * @see http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the
2443 * DateTime tag and page 36 for the DateTimeOriginal and
2444 * DateTimeDigitized tags.
2446 define( 'TS_EXIF', 5 );
2449 * Oracle format time.
2451 define( 'TS_ORACLE', 6 );
2454 * Postgres format time.
2456 define( 'TS_POSTGRES', 7 );
2459 * ISO 8601 basic format with no timezone: 19860209T200000Z. This is used by ResourceLoader
2461 define( 'TS_ISO_8601_BASIC', 9 );
2464 * Get a timestamp string in one of various formats
2466 * @param $outputtype Mixed: A timestamp in one of the supported formats, the
2467 * function will autodetect which format is supplied and act
2469 * @param $ts Mixed: optional timestamp to convert, default 0 for the current time
2470 * @return Mixed: String / false The same date in the format specified in $outputtype or false
2472 function wfTimestamp( $outputtype = TS_UNIX
, $ts = 0 ) {
2474 $timestamp = new MWTimestamp( $ts );
2475 return $timestamp->getTimestamp( $outputtype );
2476 } catch ( TimestampException
$e ) {
2477 wfDebug( "wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n" );
2483 * Return a formatted timestamp, or null if input is null.
2484 * For dealing with nullable timestamp columns in the database.
2486 * @param int $outputtype
2490 function wfTimestampOrNull( $outputtype = TS_UNIX
, $ts = null ) {
2491 if ( is_null( $ts ) ) {
2494 return wfTimestamp( $outputtype, $ts );
2499 * Convenience function; returns MediaWiki timestamp for the present time.
2503 function wfTimestampNow() {
2505 return wfTimestamp( TS_MW
, time() );
2509 * Check if the operating system is Windows
2511 * @return bool True if it's Windows, false otherwise.
2513 function wfIsWindows() {
2514 static $isWindows = null;
2515 if ( $isWindows === null ) {
2516 $isWindows = substr( php_uname(), 0, 7 ) == 'Windows';
2522 * Check if we are running under HHVM
2526 function wfIsHHVM() {
2527 return defined( 'HHVM_VERSION' );
2531 * Swap two variables
2536 function swap( &$x, &$y ) {
2543 * Tries to get the system directory for temporary files. First
2544 * $wgTmpDirectory is checked, and then the TMPDIR, TMP, and TEMP
2545 * environment variables are then checked in sequence, and if none are
2546 * set try sys_get_temp_dir().
2548 * NOTE: When possible, use instead the tmpfile() function to create
2549 * temporary files to avoid race conditions on file creation, etc.
2553 function wfTempDir() {
2554 global $wgTmpDirectory;
2556 if ( $wgTmpDirectory !== false ) {
2557 return $wgTmpDirectory;
2560 $tmpDir = array_map( "getenv", array( 'TMPDIR', 'TMP', 'TEMP' ) );
2562 foreach ( $tmpDir as $tmp ) {
2563 if ( $tmp && file_exists( $tmp ) && is_dir( $tmp ) && is_writable( $tmp ) ) {
2567 return sys_get_temp_dir();
2571 * Make directory, and make all parent directories if they don't exist
2573 * @param string $dir full path to directory to create
2574 * @param int $mode Chmod value to use, default is $wgDirectoryMode
2575 * @param string $caller optional caller param for debugging.
2576 * @throws MWException
2579 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2580 global $wgDirectoryMode;
2582 if ( FileBackend
::isStoragePath( $dir ) ) { // sanity
2583 throw new MWException( __FUNCTION__
. " given storage path '$dir'." );
2586 if ( !is_null( $caller ) ) {
2587 wfDebug( "$caller: called wfMkdirParents($dir)\n" );
2590 if ( strval( $dir ) === '' ||
( file_exists( $dir ) && is_dir( $dir ) ) ) {
2594 $dir = str_replace( array( '\\', '/' ), DIRECTORY_SEPARATOR
, $dir );
2596 if ( is_null( $mode ) ) {
2597 $mode = $wgDirectoryMode;
2600 // Turn off the normal warning, we're doing our own below
2601 wfSuppressWarnings();
2602 $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2603 wfRestoreWarnings();
2606 //directory may have been created on another request since we last checked
2607 if ( is_dir( $dir ) ) {
2611 // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2612 wfLogWarning( sprintf( "failed to mkdir \"%s\" mode 0%o", $dir, $mode ) );
2618 * Remove a directory and all its content.
2619 * Does not hide error.
2621 function wfRecursiveRemoveDir( $dir ) {
2622 wfDebug( __FUNCTION__
. "( $dir )\n" );
2623 // taken from http://de3.php.net/manual/en/function.rmdir.php#98622
2624 if ( is_dir( $dir ) ) {
2625 $objects = scandir( $dir );
2626 foreach ( $objects as $object ) {
2627 if ( $object != "." && $object != ".." ) {
2628 if ( filetype( $dir . '/' . $object ) == "dir" ) {
2629 wfRecursiveRemoveDir( $dir . '/' . $object );
2631 unlink( $dir . '/' . $object );
2641 * @param number $nr The number to format
2642 * @param int $acc The number of digits after the decimal point, default 2
2643 * @param bool $round Whether or not to round the value, default true
2646 function wfPercent( $nr, $acc = 2, $round = true ) {
2647 $ret = sprintf( "%.${acc}f", $nr );
2648 return $round ?
round( $ret, $acc ) . '%' : "$ret%";
2652 * Safety wrapper around ini_get() for boolean settings.
2653 * The values returned from ini_get() are pre-normalized for settings
2654 * set via php.ini or php_flag/php_admin_flag... but *not*
2655 * for those set via php_value/php_admin_value.
2657 * It's fairly common for people to use php_value instead of php_flag,
2658 * which can leave you with an 'off' setting giving a false positive
2659 * for code that just takes the ini_get() return value as a boolean.
2661 * To make things extra interesting, setting via php_value accepts
2662 * "true" and "yes" as true, but php.ini and php_flag consider them false. :)
2663 * Unrecognized values go false... again opposite PHP's own coercion
2664 * from string to bool.
2666 * Luckily, 'properly' set settings will always come back as '0' or '1',
2667 * so we only have to worry about them and the 'improper' settings.
2669 * I frickin' hate PHP... :P
2671 * @param string $setting
2674 function wfIniGetBool( $setting ) {
2675 $val = strtolower( ini_get( $setting ) );
2676 // 'on' and 'true' can't have whitespace around them, but '1' can.
2680 ||
preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2684 * Windows-compatible version of escapeshellarg()
2685 * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
2686 * function puts single quotes in regardless of OS.
2688 * Also fixes the locale problems on Linux in PHP 5.2.6+ (bug backported to
2689 * earlier distro releases of PHP)
2691 * @param string [$args,...]
2694 function wfEscapeShellArg( /*...*/ ) {
2695 wfInitShellLocale();
2697 $args = func_get_args();
2700 foreach ( $args as $arg ) {
2707 if ( wfIsWindows() ) {
2708 // Escaping for an MSVC-style command line parser and CMD.EXE
2709 // @codingStandardsIgnoreStart For long URLs
2711 // * http://web.archive.org/web/20020708081031/http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
2712 // * http://technet.microsoft.com/en-us/library/cc723564.aspx
2715 // Double the backslashes before any double quotes. Escape the double quotes.
2716 // @codingStandardsIgnoreEnd
2717 $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE
);
2720 foreach ( $tokens as $token ) {
2721 if ( $iteration %
2 == 1 ) {
2722 // Delimiter, a double quote preceded by zero or more slashes
2723 $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
2724 } elseif ( $iteration %
4 == 2 ) {
2725 // ^ in $token will be outside quotes, need to be escaped
2726 $arg .= str_replace( '^', '^^', $token );
2727 } else { // $iteration % 4 == 0
2728 // ^ in $token will appear inside double quotes, so leave as is
2733 // Double the backslashes before the end of the string, because
2734 // we will soon add a quote
2736 if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
2737 $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
2740 // Add surrounding quotes
2741 $retVal .= '"' . $arg . '"';
2743 $retVal .= escapeshellarg( $arg );
2750 * Check if wfShellExec() is effectively disabled via php.ini config
2752 * @return bool|string False or one of (safemode,disabled)
2755 function wfShellExecDisabled() {
2756 static $disabled = null;
2757 if ( is_null( $disabled ) ) {
2759 if ( wfIniGetBool( 'safe_mode' ) ) {
2760 wfDebug( "wfShellExec can't run in safe_mode, PHP's exec functions are too broken.\n" );
2761 $disabled = 'safemode';
2763 $functions = explode( ',', ini_get( 'disable_functions' ) );
2764 $functions = array_map( 'trim', $functions );
2765 $functions = array_map( 'strtolower', $functions );
2766 if ( in_array( 'proc_open', $functions ) ) {
2767 wfDebug( "proc_open is in disabled_functions\n" );
2768 $disabled = 'disabled';
2776 * Execute a shell command, with time and memory limits mirrored from the PHP
2777 * configuration if supported.
2779 * @param string $cmd Command line, properly escaped for shell.
2780 * @param &$retval null|Mixed optional, will receive the program's exit code.
2781 * (non-zero is usually failure). If there is an error from
2782 * read, select, or proc_open(), this will be set to -1.
2783 * @param array $environ optional environment variables which should be
2784 * added to the executed command environment.
2785 * @param array $limits optional array with limits(filesize, memory, time, walltime)
2786 * this overwrites the global wgMaxShell* limits.
2787 * @param array $options Array of options:
2788 * - duplicateStderr: Set this to true to duplicate stderr to stdout,
2789 * including errors from limit.sh
2791 * @return string collected stdout as a string
2793 function wfShellExec( $cmd, &$retval = null, $environ = array(),
2794 $limits = array(), $options = array()
2796 global $IP, $wgMaxShellMemory, $wgMaxShellFileSize, $wgMaxShellTime,
2797 $wgMaxShellWallClockTime, $wgShellCgroup;
2799 $disabled = wfShellExecDisabled();
2802 return $disabled == 'safemode' ?
2803 'Unable to run external programs in safe mode.' :
2804 'Unable to run external programs, proc_open() is disabled.';
2807 $includeStderr = isset( $options['duplicateStderr'] ) && $options['duplicateStderr'];
2809 wfInitShellLocale();
2812 foreach ( $environ as $k => $v ) {
2813 if ( wfIsWindows() ) {
2814 /* Surrounding a set in quotes (method used by wfEscapeShellArg) makes the quotes themselves
2815 * appear in the environment variable, so we must use carat escaping as documented in
2816 * http://technet.microsoft.com/en-us/library/cc723564.aspx
2817 * Note however that the quote isn't listed there, but is needed, and the parentheses
2818 * are listed there but doesn't appear to need it.
2820 $envcmd .= "set $k=" . preg_replace( '/([&|()<>^"])/', '^\\1', $v ) . '&& ';
2822 /* Assume this is a POSIX shell, thus required to accept variable assignments before the command
2823 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_09_01
2825 $envcmd .= "$k=" . escapeshellarg( $v ) . ' ';
2828 $cmd = $envcmd . $cmd;
2830 $useLogPipe = false;
2831 if ( php_uname( 's' ) == 'Linux' ) {
2832 $time = intval ( isset( $limits['time'] ) ?
$limits['time'] : $wgMaxShellTime );
2833 if ( isset( $limits['walltime'] ) ) {
2834 $wallTime = intval( $limits['walltime'] );
2835 } elseif ( isset( $limits['time'] ) ) {
2838 $wallTime = intval( $wgMaxShellWallClockTime );
2840 $mem = intval ( isset( $limits['memory'] ) ?
$limits['memory'] : $wgMaxShellMemory );
2841 $filesize = intval ( isset( $limits['filesize'] ) ?
$limits['filesize'] : $wgMaxShellFileSize );
2843 if ( $time > 0 ||
$mem > 0 ||
$filesize > 0 ||
$wallTime > 0 ) {
2844 $cmd = '/bin/bash ' . escapeshellarg( "$IP/includes/limit.sh" ) . ' ' .
2845 escapeshellarg( $cmd ) . ' ' .
2847 "MW_INCLUDE_STDERR=" . ( $includeStderr ?
'1' : '' ) . ';' .
2848 "MW_CPU_LIMIT=$time; " .
2849 'MW_CGROUP=' . escapeshellarg( $wgShellCgroup ) . '; ' .
2850 "MW_MEM_LIMIT=$mem; " .
2851 "MW_FILE_SIZE_LIMIT=$filesize; " .
2852 "MW_WALL_CLOCK_LIMIT=$wallTime; " .
2853 "MW_USE_LOG_PIPE=yes"
2856 } elseif ( $includeStderr ) {
2859 } elseif ( $includeStderr ) {
2862 wfDebug( "wfShellExec: $cmd\n" );
2865 0 => array( 'file', 'php://stdin', 'r' ),
2866 1 => array( 'pipe', 'w' ),
2867 2 => array( 'file', 'php://stderr', 'w' ) );
2868 if ( $useLogPipe ) {
2869 $desc[3] = array( 'pipe', 'w' );
2872 # TODO/FIXME: This is a bad hack to workaround an HHVM bug that prevents
2873 # proc_open() from opening stdin/stdout, so use /dev/null *for now*
2874 # See bug 56597 / https://github.com/facebook/hhvm/issues/1247 for more info
2876 $desc[0] = array( 'file', '/dev/null', 'r' );
2877 $desc[2] = array( 'file', '/dev/null', 'w' );
2881 $proc = proc_open( $cmd, $desc, $pipes );
2883 wfDebugLog( 'exec', "proc_open() failed: $cmd" );
2887 $outBuffer = $logBuffer = '';
2888 $emptyArray = array();
2892 // According to the documentation, it is possible for stream_select()
2893 // to fail due to EINTR. I haven't managed to induce this in testing
2894 // despite sending various signals. If it did happen, the error
2895 // message would take the form:
2897 // stream_select(): unable to select [4]: Interrupted system call (max_fd=5)
2899 // where [4] is the value of the macro EINTR and "Interrupted system
2900 // call" is string which according to the Linux manual is "possibly"
2901 // localised according to LC_MESSAGES.
2902 $eintr = defined( 'SOCKET_EINTR' ) ? SOCKET_EINTR
: 4;
2903 $eintrMessage = "stream_select(): unable to select [$eintr]";
2905 // Build a table mapping resource IDs to pipe FDs to work around a
2906 // PHP 5.3 issue in which stream_select() does not preserve array keys
2907 // <https://bugs.php.net/bug.php?id=53427>.
2909 foreach ( $pipes as $fd => $pipe ) {
2910 $fds[(int)$pipe] = $fd;
2914 $status = proc_get_status( $proc );
2915 if ( !$status['running'] ) {
2920 $readyPipes = $pipes;
2923 @trigger_error
( '' );
2924 if ( @stream_select
( $readyPipes, $emptyArray, $emptyArray, null ) === false ) {
2925 $error = error_get_last();
2926 if ( strncmp( $error['message'], $eintrMessage, strlen( $eintrMessage ) ) == 0 ) {
2929 trigger_error( $error['message'], E_USER_WARNING
);
2930 $logMsg = $error['message'];
2934 foreach ( $readyPipes as $pipe ) {
2935 $block = fread( $pipe, 65536 );
2936 $fd = $fds[(int)$pipe];
2937 if ( $block === '' ) {
2939 fclose( $pipes[$fd] );
2940 unset( $pipes[$fd] );
2944 } elseif ( $block === false ) {
2946 $logMsg = "Error reading from pipe";
2948 } elseif ( $fd == 1 ) {
2950 $outBuffer .= $block;
2951 } elseif ( $fd == 3 ) {
2953 $logBuffer .= $block;
2954 if ( strpos( $block, "\n" ) !== false ) {
2955 $lines = explode( "\n", $logBuffer );
2956 $logBuffer = array_pop( $lines );
2957 foreach ( $lines as $line ) {
2958 wfDebugLog( 'exec', $line );
2965 foreach ( $pipes as $pipe ) {
2969 // Use the status previously collected if possible, since proc_get_status()
2970 // just calls waitpid() which will not return anything useful the second time.
2971 if ( $status === false ) {
2972 $status = proc_get_status( $proc );
2975 if ( $logMsg !== false ) {
2976 // Read/select error
2978 proc_close( $proc );
2979 } elseif ( $status['signaled'] ) {
2980 $logMsg = "Exited with signal {$status['termsig']}";
2981 $retval = 128 +
$status['termsig'];
2982 proc_close( $proc );
2984 if ( $status['running'] ) {
2985 $retval = proc_close( $proc );
2987 $retval = $status['exitcode'];
2988 proc_close( $proc );
2990 if ( $retval == 127 ) {
2991 $logMsg = "Possibly missing executable file";
2992 } elseif ( $retval >= 129 && $retval <= 192 ) {
2993 $logMsg = "Probably exited with signal " . ( $retval - 128 );
2997 if ( $logMsg !== false ) {
2998 wfDebugLog( 'exec', "$logMsg: $cmd" );
3005 * Execute a shell command, returning both stdout and stderr. Convenience
3006 * function, as all the arguments to wfShellExec can become unwieldy.
3008 * @note This also includes errors from limit.sh, e.g. if $wgMaxShellFileSize is exceeded.
3009 * @param string $cmd Command line, properly escaped for shell.
3010 * @param &$retval null|Mixed optional, will receive the program's exit code.
3011 * (non-zero is usually failure)
3012 * @param array $environ optional environment variables which should be
3013 * added to the executed command environment.
3014 * @param array $limits optional array with limits(filesize, memory, time, walltime)
3015 * this overwrites the global wgShellMax* limits.
3016 * @return string collected stdout and stderr as a string
3018 function wfShellExecWithStderr( $cmd, &$retval = null, $environ = array(), $limits = array() ) {
3019 return wfShellExec( $cmd, $retval, $environ, $limits, array( 'duplicateStderr' => true ) );
3023 * Workaround for http://bugs.php.net/bug.php?id=45132
3024 * escapeshellarg() destroys non-ASCII characters if LANG is not a UTF-8 locale
3026 function wfInitShellLocale() {
3027 static $done = false;
3032 global $wgShellLocale;
3033 if ( !wfIniGetBool( 'safe_mode' ) ) {
3034 putenv( "LC_CTYPE=$wgShellLocale" );
3035 setlocale( LC_CTYPE
, $wgShellLocale );
3040 * Alias to wfShellWikiCmd()
3042 * @see wfShellWikiCmd()
3044 function wfShellMaintenanceCmd( $script, array $parameters = array(), array $options = array() ) {
3045 return wfShellWikiCmd( $script, $parameters, $options );
3049 * Generate a shell-escaped command line string to run a MediaWiki cli script.
3050 * Note that $parameters should be a flat array and an option with an argument
3051 * should consist of two consecutive items in the array (do not use "--option value").
3053 * @param string $script MediaWiki cli script path
3054 * @param array $parameters Arguments and options to the script
3055 * @param array $options Associative array of options:
3056 * 'php': The path to the php executable
3057 * 'wrapper': Path to a PHP wrapper to handle the maintenance script
3060 function wfShellWikiCmd( $script, array $parameters = array(), array $options = array() ) {
3062 // Give site config file a chance to run the script in a wrapper.
3063 // The caller may likely want to call wfBasename() on $script.
3064 wfRunHooks( 'wfShellWikiCmd', array( &$script, &$parameters, &$options ) );
3065 $cmd = isset( $options['php'] ) ?
array( $options['php'] ) : array( $wgPhpCli );
3066 if ( isset( $options['wrapper'] ) ) {
3067 $cmd[] = $options['wrapper'];
3070 // Escape each parameter for shell
3071 return implode( " ", array_map( 'wfEscapeShellArg', array_merge( $cmd, $parameters ) ) );
3075 * wfMerge attempts to merge differences between three texts.
3076 * Returns true for a clean merge and false for failure or a conflict.
3078 * @param string $old
3079 * @param string $mine
3080 * @param string $yours
3081 * @param string $result
3084 function wfMerge( $old, $mine, $yours, &$result ) {
3087 # This check may also protect against code injection in
3088 # case of broken installations.
3089 wfSuppressWarnings();
3090 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
3091 wfRestoreWarnings();
3093 if ( !$haveDiff3 ) {
3094 wfDebug( "diff3 not found\n" );
3098 # Make temporary files
3100 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
3101 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
3102 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
3104 # NOTE: diff3 issues a warning to stderr if any of the files does not end with
3105 # a newline character. To avoid this, we normalize the trailing whitespace before
3106 # creating the diff.
3108 fwrite( $oldtextFile, rtrim( $old ) . "\n" );
3109 fclose( $oldtextFile );
3110 fwrite( $mytextFile, rtrim( $mine ) . "\n" );
3111 fclose( $mytextFile );
3112 fwrite( $yourtextFile, rtrim( $yours ) . "\n" );
3113 fclose( $yourtextFile );
3115 # Check for a conflict
3116 $cmd = wfEscapeShellArg( $wgDiff3 ) . ' -a --overlap-only ' .
3117 wfEscapeShellArg( $mytextName ) . ' ' .
3118 wfEscapeShellArg( $oldtextName ) . ' ' .
3119 wfEscapeShellArg( $yourtextName );
3120 $handle = popen( $cmd, 'r' );
3122 if ( fgets( $handle, 1024 ) ) {
3130 $cmd = wfEscapeShellArg( $wgDiff3 ) . ' -a -e --merge ' .
3131 wfEscapeShellArg( $mytextName, $oldtextName, $yourtextName );
3132 $handle = popen( $cmd, 'r' );
3135 $data = fread( $handle, 8192 );
3136 if ( strlen( $data ) == 0 ) {
3142 unlink( $mytextName );
3143 unlink( $oldtextName );
3144 unlink( $yourtextName );
3146 if ( $result === '' && $old !== '' && !$conflict ) {
3147 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
3154 * Returns unified plain-text diff of two texts.
3155 * Useful for machine processing of diffs.
3157 * @param string $before the text before the changes.
3158 * @param string $after the text after the changes.
3159 * @param string $params command-line options for the diff command.
3160 * @return string Unified diff of $before and $after
3162 function wfDiff( $before, $after, $params = '-u' ) {
3163 if ( $before == $after ) {
3168 wfSuppressWarnings();
3169 $haveDiff = $wgDiff && file_exists( $wgDiff );
3170 wfRestoreWarnings();
3172 # This check may also protect against code injection in
3173 # case of broken installations.
3175 wfDebug( "diff executable not found\n" );
3176 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
3177 $format = new UnifiedDiffFormatter();
3178 return $format->format( $diffs );
3181 # Make temporary files
3183 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
3184 $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
3186 fwrite( $oldtextFile, $before );
3187 fclose( $oldtextFile );
3188 fwrite( $newtextFile, $after );
3189 fclose( $newtextFile );
3191 // Get the diff of the two files
3192 $cmd = "$wgDiff " . $params . ' ' . wfEscapeShellArg( $oldtextName, $newtextName );
3194 $h = popen( $cmd, 'r' );
3199 $data = fread( $h, 8192 );
3200 if ( strlen( $data ) == 0 ) {
3208 unlink( $oldtextName );
3209 unlink( $newtextName );
3211 // Kill the --- and +++ lines. They're not useful.
3212 $diff_lines = explode( "\n", $diff );
3213 if ( strpos( $diff_lines[0], '---' ) === 0 ) {
3214 unset( $diff_lines[0] );
3216 if ( strpos( $diff_lines[1], '+++' ) === 0 ) {
3217 unset( $diff_lines[1] );
3220 $diff = implode( "\n", $diff_lines );
3226 * This function works like "use VERSION" in Perl, the program will die with a
3227 * backtrace if the current version of PHP is less than the version provided
3229 * This is useful for extensions which due to their nature are not kept in sync
3230 * with releases, and might depend on other versions of PHP than the main code
3232 * Note: PHP might die due to parsing errors in some cases before it ever
3233 * manages to call this function, such is life
3235 * @see perldoc -f use
3237 * @param string|number $req_ver The version to check, can be a string, an integer, or
3239 * @throws MWException
3241 function wfUsePHP( $req_ver ) {
3242 $php_ver = PHP_VERSION
;
3244 if ( version_compare( $php_ver, (string)$req_ver, '<' ) ) {
3245 throw new MWException( "PHP $req_ver required--this is only $php_ver" );
3250 * This function works like "use VERSION" in Perl except it checks the version
3251 * of MediaWiki, the program will die with a backtrace if the current version
3252 * of MediaWiki is less than the version provided.
3254 * This is useful for extensions which due to their nature are not kept in sync
3257 * Note: Due to the behavior of PHP's version_compare() which is used in this
3258 * function, if you want to allow the 'wmf' development versions add a 'c' (or
3259 * any single letter other than 'a', 'b' or 'p') as a post-fix to your
3260 * targeted version number. For example if you wanted to allow any variation
3261 * of 1.22 use `wfUseMW( '1.22c' )`. Using an 'a' or 'b' instead of 'c' will
3262 * not result in the same comparison due to the internal logic of
3263 * version_compare().
3265 * @see perldoc -f use
3267 * @param string|number $req_ver The version to check, can be a string, an integer, or
3269 * @throws MWException
3271 function wfUseMW( $req_ver ) {
3274 if ( version_compare( $wgVersion, (string)$req_ver, '<' ) ) {
3275 throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
3280 * Return the final portion of a pathname.
3281 * Reimplemented because PHP5's "basename()" is buggy with multibyte text.
3282 * http://bugs.php.net/bug.php?id=33898
3284 * PHP's basename() only considers '\' a pathchar on Windows and Netware.
3285 * We'll consider it so always, as we don't want '\s' in our Unix paths either.
3287 * @param string $path
3288 * @param string $suffix to remove if present
3291 function wfBaseName( $path, $suffix = '' ) {
3292 if ( $suffix == '' ) {
3295 $encSuffix = '(?:' . preg_quote( $suffix, '#' ) . ')?';
3299 if ( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
3307 * Generate a relative path name to the given file.
3308 * May explode on non-matching case-insensitive paths,
3309 * funky symlinks, etc.
3311 * @param string $path absolute destination path including target filename
3312 * @param string $from Absolute source path, directory only
3315 function wfRelativePath( $path, $from ) {
3316 // Normalize mixed input on Windows...
3317 $path = str_replace( '/', DIRECTORY_SEPARATOR
, $path );
3318 $from = str_replace( '/', DIRECTORY_SEPARATOR
, $from );
3320 // Trim trailing slashes -- fix for drive root
3321 $path = rtrim( $path, DIRECTORY_SEPARATOR
);
3322 $from = rtrim( $from, DIRECTORY_SEPARATOR
);
3324 $pieces = explode( DIRECTORY_SEPARATOR
, dirname( $path ) );
3325 $against = explode( DIRECTORY_SEPARATOR
, $from );
3327 if ( $pieces[0] !== $against[0] ) {
3328 // Non-matching Windows drive letters?
3329 // Return a full path.
3333 // Trim off common prefix
3334 while ( count( $pieces ) && count( $against )
3335 && $pieces[0] == $against[0] ) {
3336 array_shift( $pieces );
3337 array_shift( $against );
3340 // relative dots to bump us to the parent
3341 while ( count( $against ) ) {
3342 array_unshift( $pieces, '..' );
3343 array_shift( $against );
3346 array_push( $pieces, wfBaseName( $path ) );
3348 return implode( DIRECTORY_SEPARATOR
, $pieces );
3352 * Convert an arbitrarily-long digit string from one numeric base
3353 * to another, optionally zero-padding to a minimum column width.
3355 * Supports base 2 through 36; digit values 10-36 are represented
3356 * as lowercase letters a-z. Input is case-insensitive.
3358 * @param string $input Input number
3359 * @param int $sourceBase Base of the input number
3360 * @param int $destBase Desired base of the output
3361 * @param int $pad Minimum number of digits in the output (pad with zeroes)
3362 * @param bool $lowercase Whether to output in lowercase or uppercase
3363 * @param string $engine Either "gmp", "bcmath", or "php"
3364 * @return string|bool The output number as a string, or false on error
3366 function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1,
3367 $lowercase = true, $engine = 'auto'
3369 $input = (string)$input;
3375 $sourceBase != (int)$sourceBase ||
3376 $destBase != (int)$destBase ||
3377 $pad != (int)$pad ||
3379 "/^[" . substr( '0123456789abcdefghijklmnopqrstuvwxyz', 0, $sourceBase ) . "]+$/i",
3386 static $baseChars = array(
3387 10 => 'a', 11 => 'b', 12 => 'c', 13 => 'd', 14 => 'e', 15 => 'f',
3388 16 => 'g', 17 => 'h', 18 => 'i', 19 => 'j', 20 => 'k', 21 => 'l',
3389 22 => 'm', 23 => 'n', 24 => 'o', 25 => 'p', 26 => 'q', 27 => 'r',
3390 28 => 's', 29 => 't', 30 => 'u', 31 => 'v', 32 => 'w', 33 => 'x',
3391 34 => 'y', 35 => 'z',
3393 '0' => 0, '1' => 1, '2' => 2, '3' => 3, '4' => 4, '5' => 5,
3394 '6' => 6, '7' => 7, '8' => 8, '9' => 9, 'a' => 10, 'b' => 11,
3395 'c' => 12, 'd' => 13, 'e' => 14, 'f' => 15, 'g' => 16, 'h' => 17,
3396 'i' => 18, 'j' => 19, 'k' => 20, 'l' => 21, 'm' => 22, 'n' => 23,
3397 'o' => 24, 'p' => 25, 'q' => 26, 'r' => 27, 's' => 28, 't' => 29,
3398 'u' => 30, 'v' => 31, 'w' => 32, 'x' => 33, 'y' => 34, 'z' => 35
3401 if ( extension_loaded( 'gmp' ) && ( $engine == 'auto' ||
$engine == 'gmp' ) ) {
3402 $result = gmp_strval( gmp_init( $input, $sourceBase ), $destBase );
3403 } elseif ( extension_loaded( 'bcmath' ) && ( $engine == 'auto' ||
$engine == 'bcmath' ) ) {
3405 foreach ( str_split( strtolower( $input ) ) as $char ) {
3406 $decimal = bcmul( $decimal, $sourceBase );
3407 $decimal = bcadd( $decimal, $baseChars[$char] );
3410 for ( $result = ''; bccomp( $decimal, 0 ); $decimal = bcdiv( $decimal, $destBase, 0 ) ) {
3411 $result .= $baseChars[bcmod( $decimal, $destBase )];
3414 $result = strrev( $result );
3416 $inDigits = array();
3417 foreach ( str_split( strtolower( $input ) ) as $char ) {
3418 $inDigits[] = $baseChars[$char];
3421 // Iterate over the input, modulo-ing out an output digit
3422 // at a time until input is gone.
3424 while ( $inDigits ) {
3426 $workDigits = array();
3429 foreach ( $inDigits as $digit ) {
3430 $work *= $sourceBase;
3433 if ( $workDigits ||
$work >= $destBase ) {
3434 $workDigits[] = (int)( $work / $destBase );
3439 // All that division leaves us with a remainder,
3440 // which is conveniently our next output digit.
3441 $result .= $baseChars[$work];
3444 $inDigits = $workDigits;
3447 $result = strrev( $result );
3450 if ( !$lowercase ) {
3451 $result = strtoupper( $result );
3454 return str_pad( $result, $pad, '0', STR_PAD_LEFT
);
3458 * Check if there is sufficient entropy in php's built-in session generation
3460 * @return bool true = there is sufficient entropy
3462 function wfCheckEntropy() {
3464 ( wfIsWindows() && version_compare( PHP_VERSION
, '5.3.3', '>=' ) )
3465 ||
ini_get( 'session.entropy_file' )
3467 && intval( ini_get( 'session.entropy_length' ) ) >= 32;
3471 * Override session_id before session startup if php's built-in
3472 * session generation code is not secure.
3474 function wfFixSessionID() {
3475 // If the cookie or session id is already set we already have a session and should abort
3476 if ( isset( $_COOKIE[session_name()] ) ||
session_id() ) {
3480 // PHP's built-in session entropy is enabled if:
3481 // - entropy_file is set or you're on Windows with php 5.3.3+
3482 // - AND entropy_length is > 0
3483 // We treat it as disabled if it doesn't have an entropy length of at least 32
3484 $entropyEnabled = wfCheckEntropy();
3486 // If built-in entropy is not enabled or not sufficient override PHP's
3487 // built in session id generation code
3488 if ( !$entropyEnabled ) {
3489 wfDebug( __METHOD__
. ": PHP's built in entropy is disabled or not sufficient, " .
3490 "overriding session id generation using our cryptrand source.\n" );
3491 session_id( MWCryptRand
::generateHex( 32 ) );
3496 * Reset the session_id
3500 function wfResetSessionID() {
3501 global $wgCookieSecure;
3502 $oldSessionId = session_id();
3503 $cookieParams = session_get_cookie_params();
3504 if ( wfCheckEntropy() && $wgCookieSecure == $cookieParams['secure'] ) {
3505 session_regenerate_id( false );
3509 wfSetupSession( MWCryptRand
::generateHex( 32 ) );
3512 $newSessionId = session_id();
3513 wfRunHooks( 'ResetSessionID', array( $oldSessionId, $newSessionId ) );
3517 * Initialise php session
3519 * @param bool $sessionId
3521 function wfSetupSession( $sessionId = false ) {
3522 global $wgSessionsInMemcached, $wgSessionsInObjectCache, $wgCookiePath, $wgCookieDomain,
3523 $wgCookieSecure, $wgCookieHttpOnly, $wgSessionHandler;
3524 if ( $wgSessionsInObjectCache ||
$wgSessionsInMemcached ) {
3525 ObjectCacheSessionHandler
::install();
3526 } elseif ( $wgSessionHandler && $wgSessionHandler != ini_get( 'session.save_handler' ) ) {
3527 # Only set this if $wgSessionHandler isn't null and session.save_handler
3528 # hasn't already been set to the desired value (that causes errors)
3529 ini_set( 'session.save_handler', $wgSessionHandler );
3531 session_set_cookie_params(
3532 0, $wgCookiePath, $wgCookieDomain, $wgCookieSecure, $wgCookieHttpOnly );
3533 session_cache_limiter( 'private, must-revalidate' );
3535 session_id( $sessionId );
3539 wfSuppressWarnings();
3541 wfRestoreWarnings();
3545 * Get an object from the precompiled serialized directory
3547 * @param string $name
3548 * @return mixed The variable on success, false on failure
3550 function wfGetPrecompiledData( $name ) {
3553 $file = "$IP/serialized/$name";
3554 if ( file_exists( $file ) ) {
3555 $blob = file_get_contents( $file );
3557 return unserialize( $blob );
3566 * @param string [$args,...]
3569 function wfMemcKey( /*...*/ ) {
3570 global $wgCachePrefix;
3571 $prefix = $wgCachePrefix === false ?
wfWikiID() : $wgCachePrefix;
3572 $args = func_get_args();
3573 $key = $prefix . ':' . implode( ':', $args );
3574 $key = str_replace( ' ', '_', $key );
3579 * Get a cache key for a foreign DB
3582 * @param string $prefix
3583 * @param string [$args,...]
3586 function wfForeignMemcKey( $db, $prefix /*...*/ ) {
3587 $args = array_slice( func_get_args(), 2 );
3589 $key = "$db-$prefix:" . implode( ':', $args );
3591 $key = $db . ':' . implode( ':', $args );
3593 return str_replace( ' ', '_', $key );
3597 * Get an ASCII string identifying this wiki
3598 * This is used as a prefix in memcached keys
3602 function wfWikiID() {
3603 global $wgDBprefix, $wgDBname;
3604 if ( $wgDBprefix ) {
3605 return "$wgDBname-$wgDBprefix";
3612 * Split a wiki ID into DB name and table prefix
3614 * @param string $wiki
3618 function wfSplitWikiID( $wiki ) {
3619 $bits = explode( '-', $wiki, 2 );
3620 if ( count( $bits ) < 2 ) {
3627 * Get a Database object.
3629 * @param int $db Index of the connection to get. May be DB_MASTER for the
3630 * master (for write queries), DB_SLAVE for potentially lagged read
3631 * queries, or an integer >= 0 for a particular server.
3633 * @param string|string[] $groups Query groups. An array of group names that this query
3634 * belongs to. May contain a single string if the query is only
3637 * @param string|bool $wiki The wiki ID, or false for the current wiki
3639 * Note: multiple calls to wfGetDB(DB_SLAVE) during the course of one request
3640 * will always return the same object, unless the underlying connection or load
3641 * balancer is manually destroyed.
3643 * Note 2: use $this->getDB() in maintenance scripts that may be invoked by
3644 * updater to ensure that a proper database is being updated.
3646 * @return DatabaseBase
3648 function &wfGetDB( $db, $groups = array(), $wiki = false ) {
3649 return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
3653 * Get a load balancer object.
3655 * @param string|bool $wiki wiki ID, or false for the current wiki
3656 * @return LoadBalancer
3658 function wfGetLB( $wiki = false ) {
3659 return wfGetLBFactory()->getMainLB( $wiki );
3663 * Get the load balancer factory object
3667 function &wfGetLBFactory() {
3668 return LBFactory
::singleton();
3673 * Shortcut for RepoGroup::singleton()->findFile()
3675 * @param string $title or Title object
3676 * @param array $options Associative array of options:
3677 * time: requested time for an archived image, or false for the
3678 * current version. An image object will be returned which was
3679 * created at the specified time.
3681 * ignoreRedirect: If true, do not follow file redirects
3683 * private: If true, return restricted (deleted) files if the current
3684 * user is allowed to view them. Otherwise, such files will not
3687 * bypassCache: If true, do not use the process-local cache of File objects
3689 * @return File, or false if the file does not exist
3691 function wfFindFile( $title, $options = array() ) {
3692 return RepoGroup
::singleton()->findFile( $title, $options );
3696 * Get an object referring to a locally registered file.
3697 * Returns a valid placeholder object if the file does not exist.
3699 * @param Title|string $title
3700 * @return LocalFile|null A File, or null if passed an invalid Title
3702 function wfLocalFile( $title ) {
3703 return RepoGroup
::singleton()->getLocalRepo()->newFile( $title );
3707 * Should low-performance queries be disabled?
3710 * @codeCoverageIgnore
3712 function wfQueriesMustScale() {
3713 global $wgMiserMode;
3715 ||
( SiteStats
::pages() > 100000
3716 && SiteStats
::edits() > 1000000
3717 && SiteStats
::users() > 10000 );
3721 * Get the path to a specified script file, respecting file
3722 * extensions; this is a wrapper around $wgScriptExtension etc.
3723 * except for 'index' and 'load' which use $wgScript/$wgLoadScript
3725 * @param string $script script filename, sans extension
3728 function wfScript( $script = 'index' ) {
3729 global $wgScriptPath, $wgScriptExtension, $wgScript, $wgLoadScript;
3730 if ( $script === 'index' ) {
3732 } elseif ( $script === 'load' ) {
3733 return $wgLoadScript;
3735 return "{$wgScriptPath}/{$script}{$wgScriptExtension}";
3740 * Get the script URL.
3742 * @return string script URL
3744 function wfGetScriptUrl() {
3745 if ( isset( $_SERVER['SCRIPT_NAME'] ) ) {
3747 # as it was called, minus the query string.
3749 # Some sites use Apache rewrite rules to handle subdomains,
3750 # and have PHP set up in a weird way that causes PHP_SELF
3751 # to contain the rewritten URL instead of the one that the
3752 # outside world sees.
3754 # If in this mode, use SCRIPT_URL instead, which mod_rewrite
3755 # provides containing the "before" URL.
3756 return $_SERVER['SCRIPT_NAME'];
3758 return $_SERVER['URL'];
3763 * Convenience function converts boolean values into "true"
3764 * or "false" (string) values
3766 * @param bool $value
3769 function wfBoolToStr( $value ) {
3770 return $value ?
'true' : 'false';
3774 * Get a platform-independent path to the null file, e.g. /dev/null
3778 function wfGetNull() {
3779 return wfIsWindows() ?
'NUL' : '/dev/null';
3783 * Modern version of wfWaitForSlaves(). Instead of looking at replication lag
3784 * and waiting for it to go down, this waits for the slaves to catch up to the
3785 * master position. Use this when updating very large numbers of rows, as
3786 * in maintenance scripts, to avoid causing too much lag. Of course, this is
3787 * a no-op if there are no slaves.
3789 * @param int|bool $maxLag (deprecated)
3790 * @param string|bool $wiki Wiki identifier accepted by wfGetLB
3791 * @param string|bool $cluster Cluster name accepted by LBFactory. Default: false.
3793 function wfWaitForSlaves( $maxLag = false, $wiki = false, $cluster = false ) {
3794 if ( $cluster !== false ) {
3795 $lb = wfGetLBFactory()->getExternalLB( $cluster );
3797 $lb = wfGetLB( $wiki );
3800 // bug 27975 - Don't try to wait for slaves if there are none
3801 // Prevents permission error when getting master position
3802 if ( $lb->getServerCount() > 1 ) {
3803 $dbw = $lb->getConnection( DB_MASTER
, array(), $wiki );
3804 $pos = $dbw->getMasterPos();
3805 // The DBMS may not support getMasterPos() or the whole
3806 // load balancer might be fake (e.g. $wgAllDBsAreLocalhost).
3807 if ( $pos !== false ) {
3808 $lb->waitForAll( $pos );
3814 * Count down from $seconds to zero on the terminal, with a one-second pause
3815 * between showing each number. For use in command-line scripts.
3817 * @codeCoverageIgnore
3818 * @param int $seconds
3820 function wfCountDown( $seconds ) {
3821 for ( $i = $seconds; $i >= 0; $i-- ) {
3822 if ( $i != $seconds ) {
3823 echo str_repeat( "\x08", strlen( $i +
1 ) );
3835 * Replace all invalid characters with -
3836 * Additional characters can be defined in $wgIllegalFileChars (see bug 20489)
3837 * By default, $wgIllegalFileChars = ':'
3839 * @param string $name Filename to process
3842 function wfStripIllegalFilenameChars( $name ) {
3843 global $wgIllegalFileChars;
3844 $illegalFileChars = $wgIllegalFileChars ?
"|[" . $wgIllegalFileChars . "]" : '';
3845 $name = wfBaseName( $name );
3846 $name = preg_replace(
3847 "/[^" . Title
::legalChars() . "]" . $illegalFileChars . "/",
3855 * Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit;
3857 * @return int Value the memory limit was set to.
3859 function wfMemoryLimit() {
3860 global $wgMemoryLimit;
3861 $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
3862 if ( $memlimit != -1 ) {
3863 $conflimit = wfShorthandToInteger( $wgMemoryLimit );
3864 if ( $conflimit == -1 ) {
3865 wfDebug( "Removing PHP's memory limit\n" );
3866 wfSuppressWarnings();
3867 ini_set( 'memory_limit', $conflimit );
3868 wfRestoreWarnings();
3870 } elseif ( $conflimit > $memlimit ) {
3871 wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
3872 wfSuppressWarnings();
3873 ini_set( 'memory_limit', $conflimit );
3874 wfRestoreWarnings();
3882 * Converts shorthand byte notation to integer form
3884 * @param string $string
3887 function wfShorthandToInteger( $string = '' ) {
3888 $string = trim( $string );
3889 if ( $string === '' ) {
3892 $last = $string[strlen( $string ) - 1];
3893 $val = intval( $string );
3898 // break intentionally missing
3902 // break intentionally missing
3912 * Get the normalised IETF language tag
3913 * See unit test for examples.
3915 * @param string $code The language code.
3916 * @return string The language code which complying with BCP 47 standards.
3918 function wfBCP47( $code ) {
3919 $codeSegment = explode( '-', $code );
3921 foreach ( $codeSegment as $segNo => $seg ) {
3922 // when previous segment is x, it is a private segment and should be lc
3923 if ( $segNo > 0 && strtolower( $codeSegment[( $segNo - 1 )] ) == 'x' ) {
3924 $codeBCP[$segNo] = strtolower( $seg );
3925 // ISO 3166 country code
3926 } elseif ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) {
3927 $codeBCP[$segNo] = strtoupper( $seg );
3928 // ISO 15924 script code
3929 } elseif ( ( strlen( $seg ) == 4 ) && ( $segNo > 0 ) ) {
3930 $codeBCP[$segNo] = ucfirst( strtolower( $seg ) );
3931 // Use lowercase for other cases
3933 $codeBCP[$segNo] = strtolower( $seg );
3936 $langCode = implode( '-', $codeBCP );
3941 * Get a cache object.
3943 * @param $inputType integer Cache type, one the the CACHE_* constants.
3946 function wfGetCache( $inputType ) {
3947 return ObjectCache
::getInstance( $inputType );
3951 * Get the main cache object
3955 function wfGetMainCache() {
3956 global $wgMainCacheType;
3957 return ObjectCache
::getInstance( $wgMainCacheType );
3961 * Get the cache object used by the message cache
3965 function wfGetMessageCacheStorage() {
3966 global $wgMessageCacheType;
3967 return ObjectCache
::getInstance( $wgMessageCacheType );
3971 * Get the cache object used by the parser cache
3975 function wfGetParserCacheStorage() {
3976 global $wgParserCacheType;
3977 return ObjectCache
::getInstance( $wgParserCacheType );
3981 * Get the cache object used by the language converter
3985 function wfGetLangConverterCacheStorage() {
3986 global $wgLanguageConverterCacheType;
3987 return ObjectCache
::getInstance( $wgLanguageConverterCacheType );
3991 * Call hook functions defined in $wgHooks
3993 * @param string $event event name
3994 * @param array $args parameters passed to hook functions
3995 * @param string|null $deprecatedVersion optionally mark hook as deprecated with version number
3997 * @return bool True if no handler aborted the hook
3999 function wfRunHooks( $event, array $args = array(), $deprecatedVersion = null ) {
4000 return Hooks
::run( $event, $args, $deprecatedVersion );
4004 * Wrapper around php's unpack.
4006 * @param string $format The format string (See php's docs)
4007 * @param string $data A binary string of binary data
4008 * @param int|bool $length The minimum length of $data or false. This is to
4009 * prevent reading beyond the end of $data. false to disable the check.
4011 * Also be careful when using this function to read unsigned 32 bit integer
4012 * because php might make it negative.
4014 * @throws MWException if $data not long enough, or if unpack fails
4015 * @return array Associative array of the extracted data
4017 function wfUnpack( $format, $data, $length = false ) {
4018 if ( $length !== false ) {
4019 $realLen = strlen( $data );
4020 if ( $realLen < $length ) {
4021 throw new MWException( "Tried to use wfUnpack on a "
4022 . "string of length $realLen, but needed one "
4023 . "of at least length $length."
4028 wfSuppressWarnings();
4029 $result = unpack( $format, $data );
4030 wfRestoreWarnings();
4032 if ( $result === false ) {
4033 // If it cannot extract the packed data.
4034 throw new MWException( "unpack could not unpack binary data" );
4040 * Determine if an image exists on the 'bad image list'.
4042 * The format of MediaWiki:Bad_image_list is as follows:
4043 * * Only list items (lines starting with "*") are considered
4044 * * The first link on a line must be a link to a bad image
4045 * * Any subsequent links on the same line are considered to be exceptions,
4046 * i.e. articles where the image may occur inline.
4048 * @param string $name the image name to check
4049 * @param Title|bool $contextTitle The page on which the image occurs, if known
4050 * @param string $blacklist wikitext of a file blacklist
4053 function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
4054 static $badImageCache = null; // based on bad_image_list msg
4055 wfProfileIn( __METHOD__
);
4058 $redirectTitle = RepoGroup
::singleton()->checkRedirect( Title
::makeTitle( NS_FILE
, $name ) );
4059 if ( $redirectTitle ) {
4060 $name = $redirectTitle->getDBkey();
4063 # Run the extension hook
4065 if ( !wfRunHooks( 'BadImage', array( $name, &$bad ) ) ) {
4066 wfProfileOut( __METHOD__
);
4070 $cacheable = ( $blacklist === null );
4071 if ( $cacheable && $badImageCache !== null ) {
4072 $badImages = $badImageCache;
4073 } else { // cache miss
4074 if ( $blacklist === null ) {
4075 $blacklist = wfMessage( 'bad_image_list' )->inContentLanguage()->plain(); // site list
4077 # Build the list now
4078 $badImages = array();
4079 $lines = explode( "\n", $blacklist );
4080 foreach ( $lines as $line ) {
4082 if ( substr( $line, 0, 1 ) !== '*' ) {
4088 if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
4092 $exceptions = array();
4093 $imageDBkey = false;
4094 foreach ( $m[1] as $i => $titleText ) {
4095 $title = Title
::newFromText( $titleText );
4096 if ( !is_null( $title ) ) {
4098 $imageDBkey = $title->getDBkey();
4100 $exceptions[$title->getPrefixedDBkey()] = true;
4105 if ( $imageDBkey !== false ) {
4106 $badImages[$imageDBkey] = $exceptions;
4110 $badImageCache = $badImages;
4114 $contextKey = $contextTitle ?
$contextTitle->getPrefixedDBkey() : false;
4115 $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
4116 wfProfileOut( __METHOD__
);
4121 * Determine whether the client at a given source IP is likely to be able to
4122 * access the wiki via HTTPS.
4124 * @param string $ip The IPv4/6 address in the normal human-readable form
4127 function wfCanIPUseHTTPS( $ip ) {
4129 wfRunHooks( 'CanIPUseHTTPS', array( $ip, &$canDo ) );
4134 * Work out the IP address based on various globals
4135 * For trusted proxies, use the XFF client IP (first of the chain)
4137 * @deprecated in 1.19; call $wgRequest->getIP() directly.
4140 function wfGetIP() {
4141 wfDeprecated( __METHOD__
, '1.19' );
4143 return $wgRequest->getIP();
4147 * Checks if an IP is a trusted proxy provider.
4148 * Useful to tell if X-Forwarded-For data is possibly bogus.
4149 * Squid cache servers for the site are whitelisted.
4154 function wfIsTrustedProxy( $ip ) {
4155 $trusted = wfIsConfiguredProxy( $ip );
4156 wfRunHooks( 'IsTrustedProxy', array( &$ip, &$trusted ) );
4161 * Checks if an IP matches a proxy we've configured.
4165 * @since 1.23 Supports CIDR ranges in $wgSquidServersNoPurge
4167 function wfIsConfiguredProxy( $ip ) {
4168 global $wgSquidServers, $wgSquidServersNoPurge;
4170 // quick check of known proxy servers
4171 $trusted = in_array( $ip, $wgSquidServers )
4172 ||
in_array( $ip, $wgSquidServersNoPurge );
4175 // slightly slower check to see if the ip is listed directly or in a CIDR
4176 // block in $wgSquidServersNoPurge
4177 foreach ( $wgSquidServersNoPurge as $block ) {
4178 if ( strpos( $block, '/' ) !== false && IP
::isInRange( $ip, $block ) ) {