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 );
87 if ( !function_exists( 'mb_strrpos' ) ) {
92 function mb_strrpos( $haystack, $needle, $offset = 0, $encoding = '' ) {
93 return Fallback
::mb_strrpos( $haystack, $needle, $offset, $encoding );
97 // Support for Wietse Venema's taint feature
98 if ( !function_exists( 'istainted' ) ) {
100 * @codeCoverageIgnore
103 function istainted( $var ) {
106 /** @codeCoverageIgnore */
107 function taint( $var, $level = 0 ) {}
108 /** @codeCoverageIgnore */
109 function untaint( $var, $level = 0 ) {}
110 define( 'TC_HTML', 1 );
111 define( 'TC_SHELL', 1 );
112 define( 'TC_MYSQL', 1 );
113 define( 'TC_PCRE', 1 );
114 define( 'TC_SELF', 1 );
119 * Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
124 function wfArrayDiff2( $a, $b ) {
125 return array_udiff( $a, $b, 'wfArrayDiff2_cmp' );
133 function wfArrayDiff2_cmp( $a, $b ) {
134 if ( !is_array( $a ) ) {
135 return strcmp( $a, $b );
136 } elseif ( count( $a ) !== count( $b ) ) {
137 return count( $a ) < count( $b ) ?
-1 : 1;
141 while ( ( list( , $valueA ) = each( $a ) ) && ( list( , $valueB ) = each( $b ) ) ) {
142 $cmp = strcmp( $valueA, $valueB );
153 * Returns an array where the values in the first array are replaced by the
154 * values in the second array with the corresponding keys
160 function wfArrayLookup( $a, $b ) {
161 return array_flip( array_intersect( array_flip( $a ), array_keys( $b ) ) );
165 * Appends to second array if $value differs from that in $default
167 * @param $key String|Int
168 * @param $value Mixed
169 * @param $default Mixed
170 * @param array $changed to alter
171 * @throws MWException
173 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
174 if ( is_null( $changed ) ) {
175 throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' );
177 if ( $default[$key] !== $value ) {
178 $changed[$key] = $value;
183 * Backwards array plus for people who haven't bothered to read the PHP manual
184 * XXX: will not darn your socks for you.
186 * @param $array1 Array
187 * @param [$array2, [...]] Arrays
190 function wfArrayMerge( $array1/* ... */ ) {
191 $args = func_get_args();
192 $args = array_reverse( $args, true );
194 foreach ( $args as $arg ) {
201 * Merge arrays in the style of getUserPermissionsErrors, with duplicate removal
203 * wfMergeErrorArrays(
204 * array( array( 'x' ) ),
205 * array( array( 'x', '2' ) ),
206 * array( array( 'x' ) ),
207 * array( array( 'y' ) )
218 function wfMergeErrorArrays( /*...*/ ) {
219 $args = func_get_args();
221 foreach ( $args as $errors ) {
222 foreach ( $errors as $params ) {
223 # @todo FIXME: Sometimes get nested arrays for $params,
224 # which leads to E_NOTICEs
225 $spec = implode( "\t", $params );
226 $out[$spec] = $params;
229 return array_values( $out );
233 * Insert array into another array after the specified *KEY*
235 * @param array $array The array.
236 * @param array $insert The array to insert.
237 * @param $after Mixed: The key to insert after
240 function wfArrayInsertAfter( array $array, array $insert, $after ) {
241 // Find the offset of the element to insert after.
242 $keys = array_keys( $array );
243 $offsetByKey = array_flip( $keys );
245 $offset = $offsetByKey[$after];
247 // Insert at the specified offset
248 $before = array_slice( $array, 0, $offset +
1, true );
249 $after = array_slice( $array, $offset +
1, count( $array ) - $offset, true );
251 $output = $before +
$insert +
$after;
257 * Recursively converts the parameter (an object) to an array with the same data
259 * @param $objOrArray Object|Array
260 * @param $recursive Bool
263 function wfObjectToArray( $objOrArray, $recursive = true ) {
265 if ( is_object( $objOrArray ) ) {
266 $objOrArray = get_object_vars( $objOrArray );
268 foreach ( $objOrArray as $key => $value ) {
269 if ( $recursive && ( is_object( $value ) ||
is_array( $value ) ) ) {
270 $value = wfObjectToArray( $value );
273 $array[$key] = $value;
280 * Wrapper around array_map() which also taints variables
282 * @param $function Callback
283 * @param $input Array
286 function wfArrayMap( $function, $input ) {
287 $ret = array_map( $function, $input );
288 foreach ( $ret as $key => $value ) {
289 $taint = istainted( $input[$key] );
291 taint( $ret[$key], $taint );
298 * Get a random decimal value between 0 and 1, in a way
299 * not likely to give duplicate values for any realistic
300 * number of articles.
304 function wfRandom() {
305 # The maximum random value is "only" 2^31-1, so get two random
306 # values to reduce the chance of dupes
307 $max = mt_getrandmax() +
1;
308 $rand = number_format( ( mt_rand() * $max +
mt_rand() )
309 / $max / $max, 12, '.', '' );
314 * Get a random string containing a number of pseudo-random hex
316 * @note This is not secure, if you are trying to generate some sort
317 * of token please use MWCryptRand instead.
319 * @param int $length The length of the string to generate
323 function wfRandomString( $length = 32 ) {
325 for ( $n = 0; $n < $length; $n +
= 7 ) {
326 $str .= sprintf( '%07x', mt_rand() & 0xfffffff );
328 return substr( $str, 0, $length );
332 * We want some things to be included as literal characters in our title URLs
333 * for prettiness, which urlencode encodes by default. According to RFC 1738,
334 * all of the following should be safe:
338 * But + is not safe because it's used to indicate a space; &= are only safe in
339 * paths and not in queries (and we don't distinguish here); ' seems kind of
340 * scary; and urlencode() doesn't touch -_. to begin with. Plus, although /
341 * is reserved, we don't care. So the list we unescape is:
345 * However, IIS7 redirects fail when the url contains a colon (Bug 22709),
346 * so no fancy : for IIS7.
348 * %2F in the page titles seems to fatally break for some reason.
353 function wfUrlencode( $s ) {
355 if ( is_null( $s ) ) {
360 if ( is_null( $needle ) ) {
361 $needle = array( '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F' );
362 if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) ||
( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false ) ) {
367 $s = urlencode( $s );
370 array( ';', '@', '$', '!', '*', '(', ')', ',', '/', ':' ),
378 * This function takes two arrays as input, and returns a CGI-style string, e.g.
379 * "days=7&limit=100". Options in the first array override options in the second.
380 * Options set to null or false will not be output.
382 * @param array $array1 ( String|Array )
383 * @param array $array2 ( String|Array )
384 * @param $prefix String
387 function wfArrayToCgi( $array1, $array2 = null, $prefix = '' ) {
388 if ( !is_null( $array2 ) ) {
389 $array1 = $array1 +
$array2;
393 foreach ( $array1 as $key => $value ) {
394 if ( !is_null( $value ) && $value !== false ) {
398 if ( $prefix !== '' ) {
399 $key = $prefix . "[$key]";
401 if ( is_array( $value ) ) {
403 foreach ( $value as $k => $v ) {
404 $cgi .= $firstTime ?
'' : '&';
405 if ( is_array( $v ) ) {
406 $cgi .= wfArrayToCgi( $v, null, $key . "[$k]" );
408 $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v );
413 if ( is_object( $value ) ) {
414 $value = $value->__toString();
416 $cgi .= urlencode( $key ) . '=' . urlencode( $value );
424 * This is the logical opposite of wfArrayToCgi(): it accepts a query string as
425 * its argument and returns the same string in array form. This allows compatibility
426 * with legacy functions that accept raw query strings instead of nice
427 * arrays. Of course, keys and values are urldecode()d.
429 * @param string $query query string
430 * @return array Array version of input
432 function wfCgiToArray( $query ) {
433 if ( isset( $query[0] ) && $query[0] == '?' ) {
434 $query = substr( $query, 1 );
436 $bits = explode( '&', $query );
438 foreach ( $bits as $bit ) {
442 if ( strpos( $bit, '=' ) === false ) {
443 // Pieces like &qwerty become 'qwerty' => '' (at least this is what php does)
447 list( $key, $value ) = explode( '=', $bit );
449 $key = urldecode( $key );
450 $value = urldecode( $value );
451 if ( strpos( $key, '[' ) !== false ) {
452 $keys = array_reverse( explode( '[', $key ) );
453 $key = array_pop( $keys );
455 foreach ( $keys as $k ) {
456 $k = substr( $k, 0, -1 );
457 $temp = array( $k => $temp );
459 if ( isset( $ret[$key] ) ) {
460 $ret[$key] = array_merge( $ret[$key], $temp );
472 * Append a query string to an existing URL, which may or may not already
473 * have query string parameters already. If so, they will be combined.
476 * @param $query Mixed: string or associative array
479 function wfAppendQuery( $url, $query ) {
480 if ( is_array( $query ) ) {
481 $query = wfArrayToCgi( $query );
483 if ( $query != '' ) {
484 if ( false === strpos( $url, '?' ) ) {
495 * Expand a potentially local URL to a fully-qualified URL. Assumes $wgServer
498 * The meaning of the PROTO_* constants is as follows:
499 * PROTO_HTTP: Output a URL starting with http://
500 * PROTO_HTTPS: Output a URL starting with https://
501 * PROTO_RELATIVE: Output a URL starting with // (protocol-relative URL)
502 * PROTO_CURRENT: Output a URL starting with either http:// or https:// , depending on which protocol was used for the current incoming request
503 * PROTO_CANONICAL: For URLs without a domain, like /w/index.php , use $wgCanonicalServer. For protocol-relative URLs, use the protocol of $wgCanonicalServer
504 * PROTO_INTERNAL: Like PROTO_CANONICAL, but uses $wgInternalServer instead of $wgCanonicalServer
506 * @todo this won't work with current-path-relative URLs
507 * like "subdir/foo.html", etc.
509 * @param string $url either fully-qualified or a local path + query
510 * @param $defaultProto Mixed: one of the PROTO_* constants. Determines the
511 * protocol to use if $url or $wgServer is
513 * @return string Fully-qualified URL, current-path-relative URL or false if
514 * no valid URL can be constructed
516 function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT
) {
517 global $wgServer, $wgCanonicalServer, $wgInternalServer;
518 $serverUrl = $wgServer;
519 if ( $defaultProto === PROTO_CANONICAL
) {
520 $serverUrl = $wgCanonicalServer;
522 // Make $wgInternalServer fall back to $wgServer if not set
523 if ( $defaultProto === PROTO_INTERNAL
&& $wgInternalServer !== false ) {
524 $serverUrl = $wgInternalServer;
526 if ( $defaultProto === PROTO_CURRENT
) {
527 $defaultProto = WebRequest
::detectProtocol() . '://';
530 // Analyze $serverUrl to obtain its protocol
531 $bits = wfParseUrl( $serverUrl );
532 $serverHasProto = $bits && $bits['scheme'] != '';
534 if ( $defaultProto === PROTO_CANONICAL ||
$defaultProto === PROTO_INTERNAL
) {
535 if ( $serverHasProto ) {
536 $defaultProto = $bits['scheme'] . '://';
538 // $wgCanonicalServer or $wgInternalServer doesn't have a protocol. This really isn't supposed to happen
539 // Fall back to HTTP in this ridiculous case
540 $defaultProto = PROTO_HTTP
;
544 $defaultProtoWithoutSlashes = substr( $defaultProto, 0, -2 );
546 if ( substr( $url, 0, 2 ) == '//' ) {
547 $url = $defaultProtoWithoutSlashes . $url;
548 } elseif ( substr( $url, 0, 1 ) == '/' ) {
549 // If $serverUrl is protocol-relative, prepend $defaultProtoWithoutSlashes, otherwise leave it alone
550 $url = ( $serverHasProto ?
'' : $defaultProtoWithoutSlashes ) . $serverUrl . $url;
553 $bits = wfParseUrl( $url );
554 if ( $bits && isset( $bits['path'] ) ) {
555 $bits['path'] = wfRemoveDotSegments( $bits['path'] );
556 return wfAssembleUrl( $bits );
560 } elseif ( substr( $url, 0, 1 ) != '/' ) {
561 # URL is a relative path
562 return wfRemoveDotSegments( $url );
565 # Expanded URL is not valid.
570 * This function will reassemble a URL parsed with wfParseURL. This is useful
571 * if you need to edit part of a URL and put it back together.
573 * This is the basic structure used (brackets contain keys for $urlParts):
574 * [scheme][delimiter][user]:[pass]@[host]:[port][path]?[query]#[fragment]
576 * @todo Need to integrate this into wfExpandUrl (bug 32168)
579 * @param array $urlParts URL parts, as output from wfParseUrl
580 * @return string URL assembled from its component parts
582 function wfAssembleUrl( $urlParts ) {
585 if ( isset( $urlParts['delimiter'] ) ) {
586 if ( isset( $urlParts['scheme'] ) ) {
587 $result .= $urlParts['scheme'];
590 $result .= $urlParts['delimiter'];
593 if ( isset( $urlParts['host'] ) ) {
594 if ( isset( $urlParts['user'] ) ) {
595 $result .= $urlParts['user'];
596 if ( isset( $urlParts['pass'] ) ) {
597 $result .= ':' . $urlParts['pass'];
602 $result .= $urlParts['host'];
604 if ( isset( $urlParts['port'] ) ) {
605 $result .= ':' . $urlParts['port'];
609 if ( isset( $urlParts['path'] ) ) {
610 $result .= $urlParts['path'];
613 if ( isset( $urlParts['query'] ) ) {
614 $result .= '?' . $urlParts['query'];
617 if ( isset( $urlParts['fragment'] ) ) {
618 $result .= '#' . $urlParts['fragment'];
625 * Remove all dot-segments in the provided URL path. For example,
626 * '/a/./b/../c/' becomes '/a/c/'. For details on the algorithm, please see
627 * RFC3986 section 5.2.4.
629 * @todo Need to integrate this into wfExpandUrl (bug 32168)
631 * @param string $urlPath URL path, potentially containing dot-segments
632 * @return string URL path with all dot-segments removed
634 function wfRemoveDotSegments( $urlPath ) {
637 $inputLength = strlen( $urlPath );
639 while ( $inputOffset < $inputLength ) {
640 $prefixLengthOne = substr( $urlPath, $inputOffset, 1 );
641 $prefixLengthTwo = substr( $urlPath, $inputOffset, 2 );
642 $prefixLengthThree = substr( $urlPath, $inputOffset, 3 );
643 $prefixLengthFour = substr( $urlPath, $inputOffset, 4 );
646 if ( $prefixLengthTwo == './' ) {
647 # Step A, remove leading "./"
649 } elseif ( $prefixLengthThree == '../' ) {
650 # Step A, remove leading "../"
652 } elseif ( ( $prefixLengthTwo == '/.' ) && ( $inputOffset +
2 == $inputLength ) ) {
653 # Step B, replace leading "/.$" with "/"
655 $urlPath[$inputOffset] = '/';
656 } elseif ( $prefixLengthThree == '/./' ) {
657 # Step B, replace leading "/./" with "/"
659 } elseif ( $prefixLengthThree == '/..' && ( $inputOffset +
3 == $inputLength ) ) {
660 # Step C, replace leading "/..$" with "/" and
661 # remove last path component in output
663 $urlPath[$inputOffset] = '/';
665 } elseif ( $prefixLengthFour == '/../' ) {
666 # Step C, replace leading "/../" with "/" and
667 # remove last path component in output
670 } elseif ( ( $prefixLengthOne == '.' ) && ( $inputOffset +
1 == $inputLength ) ) {
671 # Step D, remove "^.$"
673 } elseif ( ( $prefixLengthTwo == '..' ) && ( $inputOffset +
2 == $inputLength ) ) {
674 # Step D, remove "^..$"
677 # Step E, move leading path segment to output
678 if ( $prefixLengthOne == '/' ) {
679 $slashPos = strpos( $urlPath, '/', $inputOffset +
1 );
681 $slashPos = strpos( $urlPath, '/', $inputOffset );
683 if ( $slashPos === false ) {
684 $output .= substr( $urlPath, $inputOffset );
685 $inputOffset = $inputLength;
687 $output .= substr( $urlPath, $inputOffset, $slashPos - $inputOffset );
688 $inputOffset +
= $slashPos - $inputOffset;
693 $slashPos = strrpos( $output, '/' );
694 if ( $slashPos === false ) {
697 $output = substr( $output, 0, $slashPos );
706 * Returns a regular expression of url protocols
708 * @param bool $includeProtocolRelative If false, remove '//' from the returned protocol list.
709 * DO NOT USE this directly, use wfUrlProtocolsWithoutProtRel() instead
712 function wfUrlProtocols( $includeProtocolRelative = true ) {
713 global $wgUrlProtocols;
715 // Cache return values separately based on $includeProtocolRelative
716 static $withProtRel = null, $withoutProtRel = null;
717 $cachedValue = $includeProtocolRelative ?
$withProtRel : $withoutProtRel;
718 if ( !is_null( $cachedValue ) ) {
722 // Support old-style $wgUrlProtocols strings, for backwards compatibility
723 // with LocalSettings files from 1.5
724 if ( is_array( $wgUrlProtocols ) ) {
725 $protocols = array();
726 foreach ( $wgUrlProtocols as $protocol ) {
727 // Filter out '//' if !$includeProtocolRelative
728 if ( $includeProtocolRelative ||
$protocol !== '//' ) {
729 $protocols[] = preg_quote( $protocol, '/' );
733 $retval = implode( '|', $protocols );
735 // Ignore $includeProtocolRelative in this case
736 // This case exists for pre-1.6 compatibility, and we can safely assume
737 // that '//' won't appear in a pre-1.6 config because protocol-relative
738 // URLs weren't supported until 1.18
739 $retval = $wgUrlProtocols;
742 // Cache return value
743 if ( $includeProtocolRelative ) {
744 $withProtRel = $retval;
746 $withoutProtRel = $retval;
752 * Like wfUrlProtocols(), but excludes '//' from the protocol list. Use this if
753 * you need a regex that matches all URL protocols but does not match protocol-
757 function wfUrlProtocolsWithoutProtRel() {
758 return wfUrlProtocols( false );
762 * parse_url() work-alike, but non-broken. Differences:
764 * 1) Does not raise warnings on bad URLs (just returns false)
765 * 2) Handles protocols that don't use :// (e.g., mailto: and news: , as well as protocol-relative URLs) correctly
766 * 3) Adds a "delimiter" element to the array, either '://', ':' or '//' (see (2))
768 * @param string $url a URL to parse
769 * @return Array: bits of the URL in an associative array, per PHP docs
771 function wfParseUrl( $url ) {
772 global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
774 // Protocol-relative URLs are handled really badly by parse_url(). It's so bad that the easiest
775 // way to handle them is to just prepend 'http:' and strip the protocol out later
776 $wasRelative = substr( $url, 0, 2 ) == '//';
777 if ( $wasRelative ) {
780 wfSuppressWarnings();
781 $bits = parse_url( $url );
783 // parse_url() returns an array without scheme for some invalid URLs, e.g.
784 // parse_url("%0Ahttp://example.com") == array( 'host' => '%0Ahttp', 'path' => 'example.com' )
785 if ( !$bits ||
!isset( $bits['scheme'] ) ) {
789 // parse_url() incorrectly handles schemes case-sensitively. Convert it to lowercase.
790 $bits['scheme'] = strtolower( $bits['scheme'] );
792 // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
793 if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
794 $bits['delimiter'] = '://';
795 } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
796 $bits['delimiter'] = ':';
797 // parse_url detects for news: and mailto: the host part of an url as path
798 // We have to correct this wrong detection
799 if ( isset( $bits['path'] ) ) {
800 $bits['host'] = $bits['path'];
807 /* Provide an empty host for eg. file:/// urls (see bug 28627) */
808 if ( !isset( $bits['host'] ) ) {
812 if ( isset( $bits['path'] ) ) {
813 /* parse_url loses the third / for file:///c:/ urls (but not on variants) */
814 if ( substr( $bits['path'], 0, 1 ) !== '/' ) {
815 $bits['path'] = '/' . $bits['path'];
822 // If the URL was protocol-relative, fix scheme and delimiter
823 if ( $wasRelative ) {
824 $bits['scheme'] = '';
825 $bits['delimiter'] = '//';
831 * Take a URL, make sure it's expanded to fully qualified, and replace any
832 * encoded non-ASCII Unicode characters with their UTF-8 original forms
833 * for more compact display and legibility for local audiences.
835 * @todo handle punycode domains too
840 function wfExpandIRI( $url ) {
841 return preg_replace_callback( '/((?:%[89A-F][0-9A-F])+)/i', 'wfExpandIRI_callback', wfExpandUrl( $url ) );
845 * Private callback for wfExpandIRI
846 * @param array $matches
849 function wfExpandIRI_callback( $matches ) {
850 return urldecode( $matches[1] );
854 * Make URL indexes, appropriate for the el_index field of externallinks.
859 function wfMakeUrlIndexes( $url ) {
860 $bits = wfParseUrl( $url );
862 // Reverse the labels in the hostname, convert to lower case
863 // For emails reverse domainpart only
864 if ( $bits['scheme'] == 'mailto' ) {
865 $mailparts = explode( '@', $bits['host'], 2 );
866 if ( count( $mailparts ) === 2 ) {
867 $domainpart = strtolower( implode( '.', array_reverse( explode( '.', $mailparts[1] ) ) ) );
869 // No domain specified, don't mangle it
872 $reversedHost = $domainpart . '@' . $mailparts[0];
874 $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) );
876 // Add an extra dot to the end
877 // Why? Is it in wrong place in mailto links?
878 if ( substr( $reversedHost, -1, 1 ) !== '.' ) {
879 $reversedHost .= '.';
881 // Reconstruct the pseudo-URL
882 $prot = $bits['scheme'];
883 $index = $prot . $bits['delimiter'] . $reversedHost;
884 // Leave out user and password. Add the port, path, query and fragment
885 if ( isset( $bits['port'] ) ) {
886 $index .= ':' . $bits['port'];
888 if ( isset( $bits['path'] ) ) {
889 $index .= $bits['path'];
893 if ( isset( $bits['query'] ) ) {
894 $index .= '?' . $bits['query'];
896 if ( isset( $bits['fragment'] ) ) {
897 $index .= '#' . $bits['fragment'];
901 return array( "http:$index", "https:$index" );
903 return array( $index );
908 * Check whether a given URL has a domain that occurs in a given set of domains
909 * @param string $url URL
910 * @param array $domains Array of domains (strings)
911 * @return bool True if the host part of $url ends in one of the strings in $domains
913 function wfMatchesDomainList( $url, $domains ) {
914 $bits = wfParseUrl( $url );
915 if ( is_array( $bits ) && isset( $bits['host'] ) ) {
916 foreach ( (array)$domains as $domain ) {
917 // FIXME: This gives false positives. http://nds-nl.wikipedia.org will match nl.wikipedia.org
918 // We should use something that interprets dots instead
919 if ( substr( $bits['host'], -strlen( $domain ) ) === $domain ) {
928 * Sends a line to the debug log if enabled or, optionally, to a comment in output.
929 * In normal operation this is a NOP.
931 * Controlling globals:
932 * $wgDebugLogFile - points to the log file
933 * $wgProfileOnly - if set, normal debug messages will not be recorded.
934 * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
935 * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
937 * @param $text String
938 * @param bool $logonly set true to avoid appearing in HTML when $wgDebugComments is set
940 function wfDebug( $text, $logonly = false ) {
941 global $wgDebugLogFile, $wgProfileOnly, $wgDebugRawPage, $wgDebugLogPrefix;
943 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
947 $timer = wfDebugTimer();
948 if ( $timer !== '' ) {
949 $text = preg_replace( '/[^\n]/', $timer . '\0', $text, 1 );
953 MWDebug
::debugMsg( $text );
956 if ( wfRunHooks( 'Debug', array( $text, null /* no log group */ ) ) ) {
957 if ( $wgDebugLogFile != '' && !$wgProfileOnly ) {
958 # Strip unprintables; they can switch terminal modes when binary data
959 # gets dumped, which is pretty annoying.
960 $text = preg_replace( '![\x00-\x08\x0b\x0c\x0e-\x1f]!', ' ', $text );
961 $text = $wgDebugLogPrefix . $text;
962 wfErrorLog( $text, $wgDebugLogFile );
968 * Returns true if debug logging should be suppressed if $wgDebugRawPage = false
971 function wfIsDebugRawPage() {
973 if ( $cache !== null ) {
976 # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
977 if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
979 isset( $_SERVER['SCRIPT_NAME'] )
980 && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
991 * Get microsecond timestamps for debug logs
995 function wfDebugTimer() {
996 global $wgDebugTimestamps, $wgRequestTime;
998 if ( !$wgDebugTimestamps ) {
1002 $prefix = sprintf( "%6.4f", microtime( true ) - $wgRequestTime );
1003 $mem = sprintf( "%5.1fM", ( memory_get_usage( true ) / ( 1024 * 1024 ) ) );
1004 return "$prefix $mem ";
1008 * Send a line giving PHP memory usage.
1010 * @param bool $exact print exact values instead of kilobytes (default: false)
1012 function wfDebugMem( $exact = false ) {
1013 $mem = memory_get_usage();
1015 $mem = floor( $mem / 1024 ) . ' kilobytes';
1019 wfDebug( "Memory usage: $mem\n" );
1023 * Send a line to a supplementary debug log file, if configured, or main debug log if not.
1024 * $wgDebugLogGroups[$logGroup] should be set to a filename to send to a separate log.
1026 * @param $logGroup String
1027 * @param $text String
1028 * @param bool $public whether to log the event in the public log if no private
1029 * log file is specified, (default true)
1031 function wfDebugLog( $logGroup, $text, $public = true ) {
1032 global $wgDebugLogGroups;
1033 $text = trim( $text ) . "\n";
1034 if ( isset( $wgDebugLogGroups[$logGroup] ) ) {
1035 $time = wfTimestamp( TS_DB
);
1037 $host = wfHostname();
1038 if ( wfRunHooks( 'Debug', array( $text, $logGroup ) ) ) {
1039 wfErrorLog( "$time $host $wiki: $text", $wgDebugLogGroups[$logGroup] );
1041 } elseif ( $public === true ) {
1042 wfDebug( "[$logGroup] $text", true );
1047 * Log for database errors
1049 * @param string $text database error message.
1051 function wfLogDBError( $text ) {
1052 global $wgDBerrorLog, $wgDBerrorLogTZ;
1053 static $logDBErrorTimeZoneObject = null;
1055 if ( $wgDBerrorLog ) {
1056 $host = wfHostname();
1059 if ( $wgDBerrorLogTZ && !$logDBErrorTimeZoneObject ) {
1060 $logDBErrorTimeZoneObject = new DateTimeZone( $wgDBerrorLogTZ );
1063 // Workaround for https://bugs.php.net/bug.php?id=52063
1064 // Can be removed when min PHP > 5.3.2
1065 if ( $logDBErrorTimeZoneObject === null ) {
1066 $d = date_create( "now" );
1068 $d = date_create( "now", $logDBErrorTimeZoneObject );
1071 $date = $d->format( 'D M j G:i:s T Y' );
1073 $text = "$date\t$host\t$wiki\t$text";
1074 wfErrorLog( $text, $wgDBerrorLog );
1079 * Throws a warning that $function is deprecated
1081 * @param $function String
1082 * @param string|bool $version Version of MediaWiki that the function was deprecated in (Added in 1.19).
1083 * @param string|bool $component Added in 1.19.
1084 * @param $callerOffset integer: How far up the call stack is the original
1085 * caller. 2 = function that called the function that called
1086 * wfDeprecated (Added in 1.20)
1090 function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) {
1091 MWDebug
::deprecated( $function, $version, $component, $callerOffset +
1 );
1095 * Send a warning either to the debug log or in a PHP error depending on
1096 * $wgDevelopmentWarnings. To log warnings in production, use wfLogWarning() instead.
1098 * @param string $msg message to send
1099 * @param $callerOffset Integer: number of items to go back in the backtrace to
1100 * find the correct caller (1 = function calling wfWarn, ...)
1101 * @param $level Integer: PHP error level; defaults to E_USER_NOTICE;
1102 * only used when $wgDevelopmentWarnings is true
1104 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE
) {
1105 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'auto' );
1109 * Send a warning as a PHP error and the debug log. This is intended for logging
1110 * warnings in production. For logging development warnings, use WfWarn instead.
1112 * @param $msg String: message to send
1113 * @param $callerOffset Integer: number of items to go back in the backtrace to
1114 * find the correct caller (1 = function calling wfLogWarning, ...)
1115 * @param $level Integer: PHP error level; defaults to E_USER_WARNING
1117 function wfLogWarning( $msg, $callerOffset = 1, $level = E_USER_WARNING
) {
1118 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'production' );
1122 * Log to a file without getting "file size exceeded" signals.
1124 * Can also log to TCP or UDP with the syntax udp://host:port/prefix. This will
1125 * send lines to the specified port, prefixed by the specified prefix and a space.
1127 * @param $text String
1128 * @param string $file filename
1129 * @throws MWException
1131 function wfErrorLog( $text, $file ) {
1132 if ( substr( $file, 0, 4 ) == 'udp:' ) {
1133 # Needs the sockets extension
1134 if ( preg_match( '!^(tcp|udp):(?://)?\[([0-9a-fA-F:]+)\]:(\d+)(?:/(.*))?$!', $file, $m ) ) {
1135 // IPv6 bracketed host
1137 $port = intval( $m[3] );
1138 $prefix = isset( $m[4] ) ?
$m[4] : false;
1140 } elseif ( preg_match( '!^(tcp|udp):(?://)?([a-zA-Z0-9.-]+):(\d+)(?:/(.*))?$!', $file, $m ) ) {
1142 if ( !IP
::isIPv4( $host ) ) {
1143 $host = gethostbyname( $host );
1145 $port = intval( $m[3] );
1146 $prefix = isset( $m[4] ) ?
$m[4] : false;
1149 throw new MWException( __METHOD__
. ': Invalid UDP specification' );
1152 // Clean it up for the multiplexer
1153 if ( strval( $prefix ) !== '' ) {
1154 $text = preg_replace( '/^/m', $prefix . ' ', $text );
1157 if ( strlen( $text ) > 65506 ) {
1158 $text = substr( $text, 0, 65506 );
1161 if ( substr( $text, -1 ) != "\n" ) {
1164 } elseif ( strlen( $text ) > 65507 ) {
1165 $text = substr( $text, 0, 65507 );
1168 $sock = socket_create( $domain, SOCK_DGRAM
, SOL_UDP
);
1173 socket_sendto( $sock, $text, strlen( $text ), 0, $host, $port );
1174 socket_close( $sock );
1176 wfSuppressWarnings();
1177 $exists = file_exists( $file );
1178 $size = $exists ?
filesize( $file ) : false;
1179 if ( !$exists ||
( $size !== false && $size +
strlen( $text ) < 0x7fffffff ) ) {
1180 file_put_contents( $file, $text, FILE_APPEND
);
1182 wfRestoreWarnings();
1189 function wfLogProfilingData() {
1190 global $wgRequestTime, $wgDebugLogFile, $wgDebugRawPage, $wgRequest;
1191 global $wgProfileLimit, $wgUser;
1193 StatCounter
::singleton()->flush();
1195 $profiler = Profiler
::instance();
1197 # Profiling must actually be enabled...
1198 if ( $profiler->isStub() ) {
1202 // Get total page request time and only show pages that longer than
1203 // $wgProfileLimit time (default is 0)
1204 $elapsed = microtime( true ) - $wgRequestTime;
1205 if ( $elapsed <= $wgProfileLimit ) {
1209 $profiler->logData();
1211 // Check whether this should be logged in the debug file.
1212 if ( $wgDebugLogFile == '' ||
( !$wgDebugRawPage && wfIsDebugRawPage() ) ) {
1217 if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1218 $forward = ' forwarded for ' . $_SERVER['HTTP_X_FORWARDED_FOR'];
1220 if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1221 $forward .= ' client IP ' . $_SERVER['HTTP_CLIENT_IP'];
1223 if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1224 $forward .= ' from ' . $_SERVER['HTTP_FROM'];
1227 $forward = "\t(proxied via {$_SERVER['REMOTE_ADDR']}{$forward})";
1229 // Don't load $wgUser at this late stage just for statistics purposes
1230 // @todo FIXME: We can detect some anons even if it is not loaded. See User::getId()
1231 if ( $wgUser->isItemLoaded( 'id' ) && $wgUser->isAnon() ) {
1232 $forward .= ' anon';
1235 // Command line script uses a FauxRequest object which does not have
1236 // any knowledge about an URL and throw an exception instead.
1238 $requestUrl = $wgRequest->getRequestURL();
1239 } catch ( MWException
$e ) {
1240 $requestUrl = 'n/a';
1243 $log = sprintf( "%s\t%04.3f\t%s\n",
1244 gmdate( 'YmdHis' ), $elapsed,
1245 urldecode( $requestUrl . $forward ) );
1247 wfErrorLog( $log . $profiler->getOutput(), $wgDebugLogFile );
1251 * Increment a statistics counter
1253 * @param $key String
1257 function wfIncrStats( $key, $count = 1 ) {
1258 StatCounter
::singleton()->incr( $key, $count );
1262 * Check if the wiki read-only lock file is present. This can be used to lock
1263 * off editing functions, but doesn't guarantee that the database will not be
1268 function wfReadOnly() {
1269 global $wgReadOnlyFile, $wgReadOnly;
1271 if ( !is_null( $wgReadOnly ) ) {
1272 return (bool)$wgReadOnly;
1274 if ( $wgReadOnlyFile == '' ) {
1277 // Set $wgReadOnly for faster access next time
1278 if ( is_file( $wgReadOnlyFile ) ) {
1279 $wgReadOnly = file_get_contents( $wgReadOnlyFile );
1281 $wgReadOnly = false;
1283 return (bool)$wgReadOnly;
1289 function wfReadOnlyReason() {
1296 * Return a Language object from $langcode
1298 * @param $langcode Mixed: either:
1299 * - a Language object
1300 * - code of the language to get the message for, if it is
1301 * a valid code create a language for that language, if
1302 * it is a string but not a valid code then make a basic
1304 * - a boolean: if it's false then use the global object for
1305 * the current user's language (as a fallback for the old parameter
1306 * functionality), or if it is true then use global object
1307 * for the wiki's content language.
1308 * @return Language object
1310 function wfGetLangObj( $langcode = false ) {
1311 # Identify which language to get or create a language object for.
1312 # Using is_object here due to Stub objects.
1313 if ( is_object( $langcode ) ) {
1314 # Great, we already have the object (hopefully)!
1318 global $wgContLang, $wgLanguageCode;
1319 if ( $langcode === true ||
$langcode === $wgLanguageCode ) {
1320 # $langcode is the language code of the wikis content language object.
1321 # or it is a boolean and value is true
1326 if ( $langcode === false ||
$langcode === $wgLang->getCode() ) {
1327 # $langcode is the language code of user language object.
1328 # or it was a boolean and value is false
1332 $validCodes = array_keys( Language
::fetchLanguageNames() );
1333 if ( in_array( $langcode, $validCodes ) ) {
1334 # $langcode corresponds to a valid language.
1335 return Language
::factory( $langcode );
1338 # $langcode is a string, but not a valid language code; use content language.
1339 wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1344 * Old function when $wgBetterDirectionality existed
1345 * All usage removed, wfUILang can be removed in near future
1347 * @deprecated since 1.18
1350 function wfUILang() {
1351 wfDeprecated( __METHOD__
, '1.18' );
1357 * This is the function for getting translated interface messages.
1359 * @see Message class for documentation how to use them.
1360 * @see https://www.mediawiki.org/wiki/Manual:Messages_API
1362 * This function replaces all old wfMsg* functions.
1364 * @param $key \string Message key.
1365 * Varargs: normal message parameters.
1369 function wfMessage( $key /*...*/) {
1370 $params = func_get_args();
1371 array_shift( $params );
1372 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
1373 $params = $params[0];
1375 return new Message( $key, $params );
1379 * This function accepts multiple message keys and returns a message instance
1380 * for the first message which is non-empty. If all messages are empty then an
1381 * instance of the first message key is returned.
1382 * @param varargs: message keys
1386 function wfMessageFallback( /*...*/ ) {
1387 $args = func_get_args();
1388 return MWFunction
::callArray( 'Message::newFallbackSequence', $args );
1392 * Get a message from anywhere, for the current user language.
1394 * Use wfMsgForContent() instead if the message should NOT
1395 * change depending on the user preferences.
1397 * @deprecated since 1.18
1399 * @param string $key lookup key for the message, usually
1400 * defined in languages/Language.php
1402 * Parameters to the message, which can be used to insert variable text into
1403 * it, can be passed to this function in the following formats:
1404 * - One per argument, starting at the second parameter
1405 * - As an array in the second parameter
1406 * These are not shown in the function definition.
1410 function wfMsg( $key ) {
1411 wfDeprecated( __METHOD__
, '1.21' );
1413 $args = func_get_args();
1414 array_shift( $args );
1415 return wfMsgReal( $key, $args );
1419 * Same as above except doesn't transform the message
1421 * @deprecated since 1.18
1423 * @param $key String
1426 function wfMsgNoTrans( $key ) {
1427 wfDeprecated( __METHOD__
, '1.21' );
1429 $args = func_get_args();
1430 array_shift( $args );
1431 return wfMsgReal( $key, $args, true, false, false );
1435 * Get a message from anywhere, for the current global language
1436 * set with $wgLanguageCode.
1438 * Use this if the message should NOT change dependent on the
1439 * language set in the user's preferences. This is the case for
1440 * most text written into logs, as well as link targets (such as
1441 * the name of the copyright policy page). Link titles, on the
1442 * other hand, should be shown in the UI language.
1444 * Note that MediaWiki allows users to change the user interface
1445 * language in their preferences, but a single installation
1446 * typically only contains content in one language.
1448 * Be wary of this distinction: If you use wfMsg() where you should
1449 * use wfMsgForContent(), a user of the software may have to
1450 * customize potentially hundreds of messages in
1451 * order to, e.g., fix a link in every possible language.
1453 * @deprecated since 1.18
1455 * @param string $key lookup key for the message, usually
1456 * defined in languages/Language.php
1459 function wfMsgForContent( $key ) {
1460 wfDeprecated( __METHOD__
, '1.21' );
1462 global $wgForceUIMsgAsContentMsg;
1463 $args = func_get_args();
1464 array_shift( $args );
1466 if ( is_array( $wgForceUIMsgAsContentMsg ) &&
1467 in_array( $key, $wgForceUIMsgAsContentMsg ) )
1469 $forcontent = false;
1471 return wfMsgReal( $key, $args, true, $forcontent );
1475 * Same as above except doesn't transform the message
1477 * @deprecated since 1.18
1479 * @param $key String
1482 function wfMsgForContentNoTrans( $key ) {
1483 wfDeprecated( __METHOD__
, '1.21' );
1485 global $wgForceUIMsgAsContentMsg;
1486 $args = func_get_args();
1487 array_shift( $args );
1489 if ( is_array( $wgForceUIMsgAsContentMsg ) &&
1490 in_array( $key, $wgForceUIMsgAsContentMsg ) )
1492 $forcontent = false;
1494 return wfMsgReal( $key, $args, true, $forcontent, false );
1498 * Really get a message
1500 * @deprecated since 1.18
1502 * @param string $key key to get.
1504 * @param $useDB Boolean
1505 * @param $forContent Mixed: Language code, or false for user lang, true for content lang.
1506 * @param $transform Boolean: Whether or not to transform the message.
1507 * @return String: the requested message.
1509 function wfMsgReal( $key, $args, $useDB = true, $forContent = false, $transform = true ) {
1510 wfDeprecated( __METHOD__
, '1.21' );
1512 wfProfileIn( __METHOD__
);
1513 $message = wfMsgGetKey( $key, $useDB, $forContent, $transform );
1514 $message = wfMsgReplaceArgs( $message, $args );
1515 wfProfileOut( __METHOD__
);
1520 * Fetch a message string value, but don't replace any keys yet.
1522 * @deprecated since 1.18
1524 * @param $key String
1525 * @param $useDB Bool
1526 * @param string $langCode Code of the language to get the message for, or
1527 * behaves as a content language switch if it is a boolean.
1528 * @param $transform Boolean: whether to parse magic words, etc.
1531 function wfMsgGetKey( $key, $useDB = true, $langCode = false, $transform = true ) {
1532 wfDeprecated( __METHOD__
, '1.21' );
1534 wfRunHooks( 'NormalizeMessageKey', array( &$key, &$useDB, &$langCode, &$transform ) );
1536 $cache = MessageCache
::singleton();
1537 $message = $cache->get( $key, $useDB, $langCode );
1538 if ( $message === false ) {
1539 $message = '<' . htmlspecialchars( $key ) . '>';
1540 } elseif ( $transform ) {
1541 $message = $cache->transform( $message );
1547 * Replace message parameter keys on the given formatted output.
1549 * @param $message String
1550 * @param $args Array
1554 function wfMsgReplaceArgs( $message, $args ) {
1555 # Fix windows line-endings
1556 # Some messages are split with explode("\n", $msg)
1557 $message = str_replace( "\r", '', $message );
1559 // Replace arguments
1560 if ( count( $args ) ) {
1561 if ( is_array( $args[0] ) ) {
1562 $args = array_values( $args[0] );
1564 $replacementKeys = array();
1565 foreach ( $args as $n => $param ) {
1566 $replacementKeys['$' . ( $n +
1 )] = $param;
1568 $message = strtr( $message, $replacementKeys );
1575 * Return an HTML-escaped version of a message.
1576 * Parameter replacements, if any, are done *after* the HTML-escaping,
1577 * so parameters may contain HTML (eg links or form controls). Be sure
1578 * to pre-escape them if you really do want plaintext, or just wrap
1579 * the whole thing in htmlspecialchars().
1581 * @deprecated since 1.18
1583 * @param $key String
1584 * @param string ... parameters
1587 function wfMsgHtml( $key ) {
1588 wfDeprecated( __METHOD__
, '1.21' );
1590 $args = func_get_args();
1591 array_shift( $args );
1592 return wfMsgReplaceArgs( htmlspecialchars( wfMsgGetKey( $key ) ), $args );
1596 * Return an HTML version of message
1597 * Parameter replacements, if any, are done *after* parsing the wiki-text message,
1598 * so parameters may contain HTML (eg links or form controls). Be sure
1599 * to pre-escape them if you really do want plaintext, or just wrap
1600 * the whole thing in htmlspecialchars().
1602 * @deprecated since 1.18
1604 * @param $key String
1605 * @param string ... parameters
1608 function wfMsgWikiHtml( $key ) {
1609 wfDeprecated( __METHOD__
, '1.21' );
1611 $args = func_get_args();
1612 array_shift( $args );
1613 return wfMsgReplaceArgs(
1614 MessageCache
::singleton()->parse( wfMsgGetKey( $key ), null,
1615 /* can't be set to false */ true, /* interface */ true )->getText(),
1620 * Returns message in the requested format
1622 * @deprecated since 1.18
1624 * @param string $key key of the message
1625 * @param array $options processing rules. Can take the following options:
1626 * <i>parse</i>: parses wikitext to HTML
1627 * <i>parseinline</i>: parses wikitext to HTML and removes the surrounding
1628 * p's added by parser or tidy
1629 * <i>escape</i>: filters message through htmlspecialchars
1630 * <i>escapenoentities</i>: same, but allows entity references like   through
1631 * <i>replaceafter</i>: parameters are substituted after parsing or escaping
1632 * <i>parsemag</i>: transform the message using magic phrases
1633 * <i>content</i>: fetch message for content language instead of interface
1634 * Also can accept a single associative argument, of the form 'language' => 'xx':
1635 * <i>language</i>: Language object or language code to fetch message for
1636 * (overridden by <i>content</i>).
1637 * Behavior for conflicting options (e.g., parse+parseinline) is undefined.
1641 function wfMsgExt( $key, $options ) {
1642 wfDeprecated( __METHOD__
, '1.21' );
1644 $args = func_get_args();
1645 array_shift( $args );
1646 array_shift( $args );
1647 $options = (array)$options;
1649 foreach ( $options as $arrayKey => $option ) {
1650 if ( !preg_match( '/^[0-9]+|language$/', $arrayKey ) ) {
1651 # An unknown index, neither numeric nor "language"
1652 wfWarn( "wfMsgExt called with incorrect parameter key $arrayKey", 1, E_USER_WARNING
);
1653 } elseif ( preg_match( '/^[0-9]+$/', $arrayKey ) && !in_array( $option,
1654 array( 'parse', 'parseinline', 'escape', 'escapenoentities',
1655 'replaceafter', 'parsemag', 'content' ) ) ) {
1656 # A numeric index with unknown value
1657 wfWarn( "wfMsgExt called with incorrect parameter $option", 1, E_USER_WARNING
);
1661 if ( in_array( 'content', $options, true ) ) {
1664 $langCodeObj = null;
1665 } elseif ( array_key_exists( 'language', $options ) ) {
1666 $forContent = false;
1667 $langCode = wfGetLangObj( $options['language'] );
1668 $langCodeObj = $langCode;
1670 $forContent = false;
1672 $langCodeObj = null;
1675 $string = wfMsgGetKey( $key, /*DB*/true, $langCode, /*Transform*/false );
1677 if ( !in_array( 'replaceafter', $options, true ) ) {
1678 $string = wfMsgReplaceArgs( $string, $args );
1681 $messageCache = MessageCache
::singleton();
1682 $parseInline = in_array( 'parseinline', $options, true );
1683 if ( in_array( 'parse', $options, true ) ||
$parseInline ) {
1684 $string = $messageCache->parse( $string, null, true, !$forContent, $langCodeObj );
1685 if ( $string instanceof ParserOutput
) {
1686 $string = $string->getText();
1689 if ( $parseInline ) {
1691 if ( preg_match( '/^<p>(.*)\n?<\/p>\n?$/sU', $string, $m ) ) {
1695 } elseif ( in_array( 'parsemag', $options, true ) ) {
1696 $string = $messageCache->transform( $string,
1697 !$forContent, $langCodeObj );
1700 if ( in_array( 'escape', $options, true ) ) {
1701 $string = htmlspecialchars ( $string );
1702 } elseif ( in_array( 'escapenoentities', $options, true ) ) {
1703 $string = Sanitizer
::escapeHtmlAllowEntities( $string );
1706 if ( in_array( 'replaceafter', $options, true ) ) {
1707 $string = wfMsgReplaceArgs( $string, $args );
1714 * Since wfMsg() and co suck, they don't return false if the message key they
1715 * looked up didn't exist but a XHTML string, this function checks for the
1716 * nonexistence of messages by checking the MessageCache::get() result directly.
1718 * @deprecated since 1.18. Use Message::isDisabled().
1720 * @param $key String: the message key looked up
1721 * @return Boolean True if the message *doesn't* exist.
1723 function wfEmptyMsg( $key ) {
1724 wfDeprecated( __METHOD__
, '1.21' );
1726 return MessageCache
::singleton()->get( $key, /*useDB*/true, /*content*/false ) === false;
1730 * Throw a debugging exception. This function previously once exited the process,
1731 * but now throws an exception instead, with similar results.
1733 * @param string $msg message shown when dying.
1734 * @throws MWException
1736 function wfDebugDieBacktrace( $msg = '' ) {
1737 throw new MWException( $msg );
1741 * Fetch server name for use in error reporting etc.
1742 * Use real server name if available, so we know which machine
1743 * in a server farm generated the current page.
1747 function wfHostname() {
1749 if ( is_null( $host ) ) {
1751 # Hostname overriding
1752 global $wgOverrideHostname;
1753 if ( $wgOverrideHostname !== false ) {
1754 # Set static and skip any detection
1755 $host = $wgOverrideHostname;
1759 if ( function_exists( 'posix_uname' ) ) {
1760 // This function not present on Windows
1761 $uname = posix_uname();
1765 if ( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1766 $host = $uname['nodename'];
1767 } elseif ( getenv( 'COMPUTERNAME' ) ) {
1768 # Windows computer name
1769 $host = getenv( 'COMPUTERNAME' );
1771 # This may be a virtual server.
1772 $host = $_SERVER['SERVER_NAME'];
1779 * Returns a HTML comment with the elapsed time since request.
1780 * This method has no side effects.
1784 function wfReportTime() {
1785 global $wgRequestTime, $wgShowHostnames;
1787 $elapsed = microtime( true ) - $wgRequestTime;
1789 return $wgShowHostnames
1790 ?
sprintf( '<!-- Served by %s in %01.3f secs. -->', wfHostname(), $elapsed )
1791 : sprintf( '<!-- Served in %01.3f secs. -->', $elapsed );
1795 * Safety wrapper for debug_backtrace().
1797 * With Zend Optimizer 3.2.0 loaded, this causes segfaults under somewhat
1798 * murky circumstances, which may be triggered in part by stub objects
1799 * or other fancy talking'.
1801 * Will return an empty array if Zend Optimizer is detected or if
1802 * debug_backtrace is disabled, otherwise the output from
1803 * debug_backtrace() (trimmed).
1805 * @param int $limit This parameter can be used to limit the number of stack frames returned
1807 * @return array of backtrace information
1809 function wfDebugBacktrace( $limit = 0 ) {
1810 static $disabled = null;
1812 if ( extension_loaded( 'Zend Optimizer' ) ) {
1813 wfDebug( "Zend Optimizer detected; skipping debug_backtrace for safety.\n" );
1817 if ( is_null( $disabled ) ) {
1819 $functions = explode( ',', ini_get( 'disable_functions' ) );
1820 $functions = array_map( 'trim', $functions );
1821 $functions = array_map( 'strtolower', $functions );
1822 if ( in_array( 'debug_backtrace', $functions ) ) {
1823 wfDebug( "debug_backtrace is in disabled_functions\n" );
1831 if ( $limit && version_compare( PHP_VERSION
, '5.4.0', '>=' ) ) {
1832 return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT
, $limit +
1 ), 1 );
1834 return array_slice( debug_backtrace(), 1 );
1839 * Get a debug backtrace as a string
1843 function wfBacktrace() {
1844 global $wgCommandLineMode;
1846 if ( $wgCommandLineMode ) {
1851 $backtrace = wfDebugBacktrace();
1852 foreach ( $backtrace as $call ) {
1853 if ( isset( $call['file'] ) ) {
1854 $f = explode( DIRECTORY_SEPARATOR
, $call['file'] );
1855 $file = $f[count( $f ) - 1];
1859 if ( isset( $call['line'] ) ) {
1860 $line = $call['line'];
1864 if ( $wgCommandLineMode ) {
1865 $msg .= "$file line $line calls ";
1867 $msg .= '<li>' . $file . ' line ' . $line . ' calls ';
1869 if ( !empty( $call['class'] ) ) {
1870 $msg .= $call['class'] . $call['type'];
1872 $msg .= $call['function'] . '()';
1874 if ( $wgCommandLineMode ) {
1880 if ( $wgCommandLineMode ) {
1890 * Get the name of the function which called this function
1891 * wfGetCaller( 1 ) is the function with the wfGetCaller() call (ie. __FUNCTION__)
1892 * wfGetCaller( 2 ) [default] is the caller of the function running wfGetCaller()
1893 * wfGetCaller( 3 ) is the parent of that.
1898 function wfGetCaller( $level = 2 ) {
1899 $backtrace = wfDebugBacktrace( $level +
1 );
1900 if ( isset( $backtrace[$level] ) ) {
1901 return wfFormatStackFrame( $backtrace[$level] );
1908 * Return a string consisting of callers in the stack. Useful sometimes
1909 * for profiling specific points.
1911 * @param int $limit The maximum depth of the stack frame to return, or false for
1915 function wfGetAllCallers( $limit = 3 ) {
1916 $trace = array_reverse( wfDebugBacktrace() );
1917 if ( !$limit ||
$limit > count( $trace ) - 1 ) {
1918 $limit = count( $trace ) - 1;
1920 $trace = array_slice( $trace, -$limit - 1, $limit );
1921 return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1925 * Return a string representation of frame
1927 * @param $frame Array
1930 function wfFormatStackFrame( $frame ) {
1931 return isset( $frame['class'] ) ?
1932 $frame['class'] . '::' . $frame['function'] :
1936 /* Some generic result counters, pulled out of SearchEngine */
1941 * @param $offset Int
1945 function wfShowingResults( $offset, $limit ) {
1946 return wfMessage( 'showingresults' )->numParams( $limit, $offset +
1 )->parse();
1950 * Generate (prev x| next x) (20|50|100...) type links for paging
1952 * @param $offset String
1953 * @param $limit Integer
1954 * @param $link String
1955 * @param string $query optional URL query parameter string
1956 * @param bool $atend optional param for specified if this is the last page
1958 * @deprecated in 1.19; use Language::viewPrevNext() instead
1960 function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) {
1961 wfDeprecated( __METHOD__
, '1.19' );
1965 $query = wfCgiToArray( $query );
1967 if ( is_object( $link ) ) {
1970 $title = Title
::newFromText( $link );
1971 if ( is_null( $title ) ) {
1976 return $wgLang->viewPrevNext( $title, $offset, $limit, $query, $atend );
1980 * Make a list item, used by various special pages
1982 * @param string $page Page link
1983 * @param string $details Text between brackets
1984 * @param $oppositedm Boolean Add the direction mark opposite to your
1985 * language, to display text properly
1987 * @deprecated since 1.19; use Language::specialList() instead
1989 function wfSpecialList( $page, $details, $oppositedm = true ) {
1990 wfDeprecated( __METHOD__
, '1.19' );
1993 return $wgLang->specialList( $page, $details, $oppositedm );
1998 * @todo FIXME: We may want to blacklist some broken browsers
2000 * @param $force Bool
2001 * @return bool Whereas client accept gzip compression
2003 function wfClientAcceptsGzip( $force = false ) {
2004 static $result = null;
2005 if ( $result === null ||
$force ) {
2007 if ( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
2008 # @todo FIXME: We may want to blacklist some broken browsers
2011 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
2012 $_SERVER['HTTP_ACCEPT_ENCODING'],
2016 if ( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
2020 wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
2029 * Obtain the offset and limit values from the request string;
2030 * used in special pages
2032 * @param int $deflimit default limit if none supplied
2033 * @param string $optionname Name of a user preference to check against
2037 function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
2039 return $wgRequest->getLimitOffset( $deflimit, $optionname );
2043 * Escapes the given text so that it may be output using addWikiText()
2044 * without any linking, formatting, etc. making its way through. This
2045 * is achieved by substituting certain characters with HTML entities.
2046 * As required by the callers, "<nowiki>" is not used.
2048 * @param string $text text to be escaped
2051 function wfEscapeWikiText( $text ) {
2052 $text = strtr( "\n$text", array(
2053 '"' => '"', '&' => '&', "'" => ''', '<' => '<',
2054 '=' => '=', '>' => '>', '[' => '[', ']' => ']',
2055 '{' => '{', '|' => '|', '}' => '}',
2056 "\n#" => "\n#", "\n*" => "\n*",
2057 "\n:" => "\n:", "\n;" => "\n;",
2058 '://' => '://', 'ISBN ' => 'ISBN ', 'RFC ' => 'RFC ',
2060 return substr( $text, 1 );
2064 * Get the current unix timestamp with microseconds. Useful for profiling
2068 return microtime( true );
2072 * Sets dest to source and returns the original value of dest
2073 * If source is NULL, it just returns the value, it doesn't set the variable
2074 * If force is true, it will set the value even if source is NULL
2076 * @param $dest Mixed
2077 * @param $source Mixed
2078 * @param $force Bool
2081 function wfSetVar( &$dest, $source, $force = false ) {
2083 if ( !is_null( $source ) ||
$force ) {
2090 * As for wfSetVar except setting a bit
2094 * @param $state Bool
2098 function wfSetBit( &$dest, $bit, $state = true ) {
2099 $temp = (bool)( $dest & $bit );
2100 if ( !is_null( $state ) ) {
2111 * A wrapper around the PHP function var_export().
2112 * Either print it or add it to the regular output ($wgOut).
2114 * @param $var mixed A PHP variable to dump.
2116 function wfVarDump( $var ) {
2118 $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
2119 if ( headers_sent() ||
!isset( $wgOut ) ||
!is_object( $wgOut ) ) {
2122 $wgOut->addHTML( $s );
2127 * Provide a simple HTTP error.
2129 * @param $code Int|String
2130 * @param $label String
2131 * @param $desc String
2133 function wfHttpError( $code, $label, $desc ) {
2136 header( "HTTP/1.0 $code $label" );
2137 header( "Status: $code $label" );
2138 $wgOut->sendCacheControl();
2140 header( 'Content-type: text/html; charset=utf-8' );
2141 print "<!doctype html>" .
2142 '<html><head><title>' .
2143 htmlspecialchars( $label ) .
2144 '</title></head><body><h1>' .
2145 htmlspecialchars( $label ) .
2147 nl2br( htmlspecialchars( $desc ) ) .
2148 "</p></body></html>\n";
2152 * Clear away any user-level output buffers, discarding contents.
2154 * Suitable for 'starting afresh', for instance when streaming
2155 * relatively large amounts of data without buffering, or wanting to
2156 * output image files without ob_gzhandler's compression.
2158 * The optional $resetGzipEncoding parameter controls suppression of
2159 * the Content-Encoding header sent by ob_gzhandler; by default it
2160 * is left. See comments for wfClearOutputBuffers() for why it would
2163 * Note that some PHP configuration options may add output buffer
2164 * layers which cannot be removed; these are left in place.
2166 * @param $resetGzipEncoding Bool
2168 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
2169 if ( $resetGzipEncoding ) {
2170 // Suppress Content-Encoding and Content-Length
2171 // headers from 1.10+s wfOutputHandler
2172 global $wgDisableOutputCompression;
2173 $wgDisableOutputCompression = true;
2175 while ( $status = ob_get_status() ) {
2176 if ( $status['type'] == 0 /* PHP_OUTPUT_HANDLER_INTERNAL */ ) {
2177 // Probably from zlib.output_compression or other
2178 // PHP-internal setting which can't be removed.
2180 // Give up, and hope the result doesn't break
2184 if ( !ob_end_clean() ) {
2185 // Could not remove output buffer handler; abort now
2186 // to avoid getting in some kind of infinite loop.
2189 if ( $resetGzipEncoding ) {
2190 if ( $status['name'] == 'ob_gzhandler' ) {
2191 // Reset the 'Content-Encoding' field set by this handler
2192 // so we can start fresh.
2193 header_remove( 'Content-Encoding' );
2201 * More legible than passing a 'false' parameter to wfResetOutputBuffers():
2203 * Clear away output buffers, but keep the Content-Encoding header
2204 * produced by ob_gzhandler, if any.
2206 * This should be used for HTTP 304 responses, where you need to
2207 * preserve the Content-Encoding header of the real result, but
2208 * also need to suppress the output of ob_gzhandler to keep to spec
2209 * and avoid breaking Firefox in rare cases where the headers and
2210 * body are broken over two packets.
2212 function wfClearOutputBuffers() {
2213 wfResetOutputBuffers( false );
2217 * Converts an Accept-* header into an array mapping string values to quality
2220 * @param $accept String
2221 * @param string $def default
2224 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
2225 # No arg means accept anything (per HTTP spec)
2227 return array( $def => 1.0 );
2232 $parts = explode( ',', $accept );
2234 foreach ( $parts as $part ) {
2235 # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
2236 $values = explode( ';', trim( $part ) );
2238 if ( count( $values ) == 1 ) {
2239 $prefs[$values[0]] = 1.0;
2240 } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
2241 $prefs[$values[0]] = floatval( $match[1] );
2249 * Checks if a given MIME type matches any of the keys in the given
2250 * array. Basic wildcards are accepted in the array keys.
2252 * Returns the matching MIME type (or wildcard) if a match, otherwise
2255 * @param $type String
2256 * @param $avail Array
2260 function mimeTypeMatch( $type, $avail ) {
2261 if ( array_key_exists( $type, $avail ) ) {
2264 $parts = explode( '/', $type );
2265 if ( array_key_exists( $parts[0] . '/*', $avail ) ) {
2266 return $parts[0] . '/*';
2267 } elseif ( array_key_exists( '*/*', $avail ) ) {
2276 * Returns the 'best' match between a client's requested internet media types
2277 * and the server's list of available types. Each list should be an associative
2278 * array of type to preference (preference is a float between 0.0 and 1.0).
2279 * Wildcards in the types are acceptable.
2281 * @param array $cprefs client's acceptable type list
2282 * @param array $sprefs server's offered types
2285 * @todo FIXME: Doesn't handle params like 'text/plain; charset=UTF-8'
2286 * XXX: generalize to negotiate other stuff
2288 function wfNegotiateType( $cprefs, $sprefs ) {
2291 foreach ( array_keys( $sprefs ) as $type ) {
2292 $parts = explode( '/', $type );
2293 if ( $parts[1] != '*' ) {
2294 $ckey = mimeTypeMatch( $type, $cprefs );
2296 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
2301 foreach ( array_keys( $cprefs ) as $type ) {
2302 $parts = explode( '/', $type );
2303 if ( $parts[1] != '*' && !array_key_exists( $type, $sprefs ) ) {
2304 $skey = mimeTypeMatch( $type, $sprefs );
2306 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
2314 foreach ( array_keys( $combine ) as $type ) {
2315 if ( $combine[$type] > $bestq ) {
2317 $bestq = $combine[$type];
2325 * Reference-counted warning suppression
2329 function wfSuppressWarnings( $end = false ) {
2330 static $suppressCount = 0;
2331 static $originalLevel = false;
2334 if ( $suppressCount ) {
2336 if ( !$suppressCount ) {
2337 error_reporting( $originalLevel );
2341 if ( !$suppressCount ) {
2342 $originalLevel = error_reporting( E_ALL
& ~
( E_WARNING | E_NOTICE | E_USER_WARNING | E_USER_NOTICE | E_DEPRECATED | E_USER_DEPRECATED | E_STRICT
) );
2349 * Restore error level to previous value
2351 function wfRestoreWarnings() {
2352 wfSuppressWarnings( true );
2355 # Autodetect, convert and provide timestamps of various types
2358 * Unix time - the number of seconds since 1970-01-01 00:00:00 UTC
2360 define( 'TS_UNIX', 0 );
2363 * MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
2365 define( 'TS_MW', 1 );
2368 * MySQL DATETIME (YYYY-MM-DD HH:MM:SS)
2370 define( 'TS_DB', 2 );
2373 * RFC 2822 format, for E-mail and HTTP headers
2375 define( 'TS_RFC2822', 3 );
2378 * ISO 8601 format with no timezone: 1986-02-09T20:00:00Z
2380 * This is used by Special:Export
2382 define( 'TS_ISO_8601', 4 );
2385 * An Exif timestamp (YYYY:MM:DD HH:MM:SS)
2387 * @see http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the
2388 * DateTime tag and page 36 for the DateTimeOriginal and
2389 * DateTimeDigitized tags.
2391 define( 'TS_EXIF', 5 );
2394 * Oracle format time.
2396 define( 'TS_ORACLE', 6 );
2399 * Postgres format time.
2401 define( 'TS_POSTGRES', 7 );
2404 * ISO 8601 basic format with no timezone: 19860209T200000Z. This is used by ResourceLoader
2406 define( 'TS_ISO_8601_BASIC', 9 );
2409 * Get a timestamp string in one of various formats
2411 * @param $outputtype Mixed: A timestamp in one of the supported formats, the
2412 * function will autodetect which format is supplied and act
2414 * @param $ts Mixed: optional timestamp to convert, default 0 for the current time
2415 * @return Mixed: String / false The same date in the format specified in $outputtype or false
2417 function wfTimestamp( $outputtype = TS_UNIX
, $ts = 0 ) {
2419 $timestamp = new MWTimestamp( $ts );
2420 return $timestamp->getTimestamp( $outputtype );
2421 } catch ( TimestampException
$e ) {
2422 wfDebug( "wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n" );
2428 * Return a formatted timestamp, or null if input is null.
2429 * For dealing with nullable timestamp columns in the database.
2431 * @param $outputtype Integer
2435 function wfTimestampOrNull( $outputtype = TS_UNIX
, $ts = null ) {
2436 if ( is_null( $ts ) ) {
2439 return wfTimestamp( $outputtype, $ts );
2444 * Convenience function; returns MediaWiki timestamp for the present time.
2448 function wfTimestampNow() {
2450 return wfTimestamp( TS_MW
, time() );
2454 * Check if the operating system is Windows
2456 * @return Bool: true if it's Windows, False otherwise.
2458 function wfIsWindows() {
2459 static $isWindows = null;
2460 if ( $isWindows === null ) {
2461 $isWindows = substr( php_uname(), 0, 7 ) == 'Windows';
2467 * Check if we are running under HipHop
2471 function wfIsHipHop() {
2472 return function_exists( 'hphp_thread_set_warmup_enabled' );
2476 * Swap two variables
2481 function swap( &$x, &$y ) {
2488 * Tries to get the system directory for temporary files. First
2489 * $wgTmpDirectory is checked, and then the TMPDIR, TMP, and TEMP
2490 * environment variables are then checked in sequence, and if none are
2491 * set try sys_get_temp_dir().
2493 * NOTE: When possible, use instead the tmpfile() function to create
2494 * temporary files to avoid race conditions on file creation, etc.
2498 function wfTempDir() {
2499 global $wgTmpDirectory;
2501 if ( $wgTmpDirectory !== false ) {
2502 return $wgTmpDirectory;
2505 $tmpDir = array_map( "getenv", array( 'TMPDIR', 'TMP', 'TEMP' ) );
2507 foreach ( $tmpDir as $tmp ) {
2508 if ( $tmp && file_exists( $tmp ) && is_dir( $tmp ) && is_writable( $tmp ) ) {
2512 return sys_get_temp_dir();
2516 * Make directory, and make all parent directories if they don't exist
2518 * @param string $dir full path to directory to create
2519 * @param $mode Integer: chmod value to use, default is $wgDirectoryMode
2520 * @param string $caller optional caller param for debugging.
2521 * @throws MWException
2524 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2525 global $wgDirectoryMode;
2527 if ( FileBackend
::isStoragePath( $dir ) ) { // sanity
2528 throw new MWException( __FUNCTION__
. " given storage path '$dir'." );
2531 if ( !is_null( $caller ) ) {
2532 wfDebug( "$caller: called wfMkdirParents($dir)\n" );
2535 if ( strval( $dir ) === '' ||
file_exists( $dir ) ) {
2539 $dir = str_replace( array( '\\', '/' ), DIRECTORY_SEPARATOR
, $dir );
2541 if ( is_null( $mode ) ) {
2542 $mode = $wgDirectoryMode;
2545 // Turn off the normal warning, we're doing our own below
2546 wfSuppressWarnings();
2547 $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2548 wfRestoreWarnings();
2551 // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2552 wfLogWarning( sprintf( "failed to mkdir \"%s\" mode 0%o", $dir, $mode ) );
2558 * Remove a directory and all its content.
2559 * Does not hide error.
2561 function wfRecursiveRemoveDir( $dir ) {
2562 wfDebug( __FUNCTION__
. "( $dir )\n" );
2563 // taken from http://de3.php.net/manual/en/function.rmdir.php#98622
2564 if ( is_dir( $dir ) ) {
2565 $objects = scandir( $dir );
2566 foreach ( $objects as $object ) {
2567 if ( $object != "." && $object != ".." ) {
2568 if ( filetype( $dir . '/' . $object ) == "dir" ) {
2569 wfRecursiveRemoveDir( $dir . '/' . $object );
2571 unlink( $dir . '/' . $object );
2581 * @param $nr Mixed: the number to format
2582 * @param $acc Integer: the number of digits after the decimal point, default 2
2583 * @param $round Boolean: whether or not to round the value, default true
2586 function wfPercent( $nr, $acc = 2, $round = true ) {
2587 $ret = sprintf( "%.${acc}f", $nr );
2588 return $round ?
round( $ret, $acc ) . '%' : "$ret%";
2592 * Find out whether or not a mixed variable exists in a string
2594 * @deprecated Just use str(i)pos
2595 * @param $needle String
2596 * @param $str String
2597 * @param $insensitive Boolean
2600 function in_string( $needle, $str, $insensitive = false ) {
2601 wfDeprecated( __METHOD__
, '1.21' );
2603 if ( $insensitive ) {
2607 return $func( $str, $needle ) !== false;
2611 * Safety wrapper around ini_get() for boolean settings.
2612 * The values returned from ini_get() are pre-normalized for settings
2613 * set via php.ini or php_flag/php_admin_flag... but *not*
2614 * for those set via php_value/php_admin_value.
2616 * It's fairly common for people to use php_value instead of php_flag,
2617 * which can leave you with an 'off' setting giving a false positive
2618 * for code that just takes the ini_get() return value as a boolean.
2620 * To make things extra interesting, setting via php_value accepts
2621 * "true" and "yes" as true, but php.ini and php_flag consider them false. :)
2622 * Unrecognized values go false... again opposite PHP's own coercion
2623 * from string to bool.
2625 * Luckily, 'properly' set settings will always come back as '0' or '1',
2626 * so we only have to worry about them and the 'improper' settings.
2628 * I frickin' hate PHP... :P
2630 * @param $setting String
2633 function wfIniGetBool( $setting ) {
2634 $val = ini_get( $setting );
2635 // 'on' and 'true' can't have whitespace around them, but '1' can.
2636 return strtolower( $val ) == 'on'
2637 ||
strtolower( $val ) == 'true'
2638 ||
strtolower( $val ) == 'yes'
2639 ||
preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2643 * Wrapper function for PHP's dl(). This doesn't work in most situations from
2644 * PHP 5.3 onward, and is usually disabled in shared environments anyway.
2646 * @param string $extension A PHP extension. The file suffix (.so or .dll)
2648 * @param string $fileName Name of the library, if not $extension.suffix
2649 * @return Bool - Whether or not the extension is loaded
2651 function wfDl( $extension, $fileName = null ) {
2652 if ( extension_loaded( $extension ) ) {
2657 if ( PHP_SAPI
== 'cli' || PHP_SAPI
== 'cgi' || PHP_SAPI
== 'embed' ) {
2658 $canDl = ( function_exists( 'dl' ) && is_callable( 'dl' )
2659 && wfIniGetBool( 'enable_dl' ) && !wfIniGetBool( 'safe_mode' ) );
2663 $fileName = $fileName ?
$fileName : $extension;
2664 if ( wfIsWindows() ) {
2665 $fileName = 'php_' . $fileName;
2667 wfSuppressWarnings();
2668 dl( $fileName . '.' . PHP_SHLIB_SUFFIX
);
2669 wfRestoreWarnings();
2671 return extension_loaded( $extension );
2675 * Windows-compatible version of escapeshellarg()
2676 * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
2677 * function puts single quotes in regardless of OS.
2679 * Also fixes the locale problems on Linux in PHP 5.2.6+ (bug backported to
2680 * earlier distro releases of PHP)
2685 function wfEscapeShellArg() {
2686 wfInitShellLocale();
2688 $args = func_get_args();
2691 foreach ( $args as $arg ) {
2698 if ( wfIsWindows() ) {
2699 // Escaping for an MSVC-style command line parser and CMD.EXE
2701 // * http://web.archive.org/web/20020708081031/http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
2702 // * http://technet.microsoft.com/en-us/library/cc723564.aspx
2705 // Double the backslashes before any double quotes. Escape the double quotes.
2706 $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE
);
2709 foreach ( $tokens as $token ) {
2710 if ( $iteration %
2 == 1 ) {
2711 // Delimiter, a double quote preceded by zero or more slashes
2712 $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
2713 } elseif ( $iteration %
4 == 2 ) {
2714 // ^ in $token will be outside quotes, need to be escaped
2715 $arg .= str_replace( '^', '^^', $token );
2716 } else { // $iteration % 4 == 0
2717 // ^ in $token will appear inside double quotes, so leave as is
2722 // Double the backslashes before the end of the string, because
2723 // we will soon add a quote
2725 if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
2726 $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
2729 // Add surrounding quotes
2730 $retVal .= '"' . $arg . '"';
2732 $retVal .= escapeshellarg( $arg );
2739 * Check if wfShellExec() is effectively disabled via php.ini config
2740 * @return bool|string False or one of (safemode,disabled)
2743 function wfShellExecDisabled() {
2744 static $disabled = null;
2745 if ( is_null( $disabled ) ) {
2747 if ( wfIniGetBool( 'safe_mode' ) ) {
2748 wfDebug( "wfShellExec can't run in safe_mode, PHP's exec functions are too broken.\n" );
2749 $disabled = 'safemode';
2751 $functions = explode( ',', ini_get( 'disable_functions' ) );
2752 $functions = array_map( 'trim', $functions );
2753 $functions = array_map( 'strtolower', $functions );
2754 if ( in_array( 'passthru', $functions ) ) {
2755 wfDebug( "passthru is in disabled_functions\n" );
2756 $disabled = 'passthru';
2764 * Execute a shell command, with time and memory limits mirrored from the PHP
2765 * configuration if supported.
2766 * @param string $cmd Command line, properly escaped for shell.
2767 * @param &$retval null|Mixed optional, will receive the program's exit code.
2768 * (non-zero is usually failure)
2769 * @param array $environ optional environment variables which should be
2770 * added to the executed command environment.
2771 * @param array $limits optional array with limits(filesize, memory, time, walltime)
2772 * this overwrites the global wgShellMax* limits.
2773 * @return string collected stdout as a string (trailing newlines stripped)
2775 function wfShellExec( $cmd, &$retval = null, $environ = array(), $limits = array() ) {
2776 global $IP, $wgMaxShellMemory, $wgMaxShellFileSize, $wgMaxShellTime,
2777 $wgMaxShellWallClockTime, $wgShellCgroup;
2779 $disabled = wfShellExecDisabled();
2782 return $disabled == 'safemode' ?
2783 'Unable to run external programs in safe mode.' :
2784 'Unable to run external programs, passthru() is disabled.';
2787 wfInitShellLocale();
2790 foreach ( $environ as $k => $v ) {
2791 if ( wfIsWindows() ) {
2792 /* Surrounding a set in quotes (method used by wfEscapeShellArg) makes the quotes themselves
2793 * appear in the environment variable, so we must use carat escaping as documented in
2794 * http://technet.microsoft.com/en-us/library/cc723564.aspx
2795 * Note however that the quote isn't listed there, but is needed, and the parentheses
2796 * are listed there but doesn't appear to need it.
2798 $envcmd .= "set $k=" . preg_replace( '/([&|()<>^"])/', '^\\1', $v ) . '&& ';
2800 /* Assume this is a POSIX shell, thus required to accept variable assignments before the command
2801 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_09_01
2803 $envcmd .= "$k=" . escapeshellarg( $v ) . ' ';
2806 $cmd = $envcmd . $cmd;
2808 if ( php_uname( 's' ) == 'Linux' ) {
2809 $time = intval ( isset( $limits['time'] ) ?
$limits['time'] : $wgMaxShellTime );
2810 if ( isset( $limits['walltime'] ) ) {
2811 $wallTime = intval( $limits['walltime'] );
2812 } elseif ( isset( $limits['time'] ) ) {
2815 $wallTime = intval( $wgMaxShellWallClockTime );
2817 $mem = intval ( isset( $limits['memory'] ) ?
$limits['memory'] : $wgMaxShellMemory );
2818 $filesize = intval ( isset( $limits['filesize'] ) ?
$limits['filesize'] : $wgMaxShellFileSize );
2820 if ( $time > 0 ||
$mem > 0 ||
$filesize > 0 ||
$wallTime > 0 ) {
2821 $cmd = '/bin/bash ' . escapeshellarg( "$IP/includes/limit.sh" ) . ' ' .
2822 escapeshellarg( $cmd ) . ' ' .
2824 "MW_CPU_LIMIT=$time; " .
2825 'MW_CGROUP=' . escapeshellarg( $wgShellCgroup ) . '; ' .
2826 "MW_MEM_LIMIT=$mem; " .
2827 "MW_FILE_SIZE_LIMIT=$filesize; " .
2828 "MW_WALL_CLOCK_LIMIT=$wallTime"
2832 wfDebug( "wfShellExec: $cmd\n" );
2834 $retval = 1; // error by default?
2836 passthru( $cmd, $retval );
2837 $output = ob_get_contents();
2840 if ( $retval == 127 ) {
2841 wfDebugLog( 'exec', "Possibly missing executable file: $cmd\n" );
2847 * Workaround for http://bugs.php.net/bug.php?id=45132
2848 * escapeshellarg() destroys non-ASCII characters if LANG is not a UTF-8 locale
2850 function wfInitShellLocale() {
2851 static $done = false;
2856 global $wgShellLocale;
2857 if ( !wfIniGetBool( 'safe_mode' ) ) {
2858 putenv( "LC_CTYPE=$wgShellLocale" );
2859 setlocale( LC_CTYPE
, $wgShellLocale );
2864 * Alias to wfShellWikiCmd()
2865 * @see wfShellWikiCmd()
2867 function wfShellMaintenanceCmd( $script, array $parameters = array(), array $options = array() ) {
2868 return wfShellWikiCmd( $script, $parameters, $options );
2872 * Generate a shell-escaped command line string to run a MediaWiki cli script.
2873 * Note that $parameters should be a flat array and an option with an argument
2874 * should consist of two consecutive items in the array (do not use "--option value").
2875 * @param string $script MediaWiki cli script path
2876 * @param array $parameters Arguments and options to the script
2877 * @param array $options Associative array of options:
2878 * 'php': The path to the php executable
2879 * 'wrapper': Path to a PHP wrapper to handle the maintenance script
2882 function wfShellWikiCmd( $script, array $parameters = array(), array $options = array() ) {
2884 // Give site config file a chance to run the script in a wrapper.
2885 // The caller may likely want to call wfBasename() on $script.
2886 wfRunHooks( 'wfShellWikiCmd', array( &$script, &$parameters, &$options ) );
2887 $cmd = isset( $options['php'] ) ?
array( $options['php'] ) : array( $wgPhpCli );
2888 if ( isset( $options['wrapper'] ) ) {
2889 $cmd[] = $options['wrapper'];
2892 // Escape each parameter for shell
2893 return implode( " ", array_map( 'wfEscapeShellArg', array_merge( $cmd, $parameters ) ) );
2897 * wfMerge attempts to merge differences between three texts.
2898 * Returns true for a clean merge and false for failure or a conflict.
2900 * @param $old String
2901 * @param $mine String
2902 * @param $yours String
2903 * @param $result String
2906 function wfMerge( $old, $mine, $yours, &$result ) {
2909 # This check may also protect against code injection in
2910 # case of broken installations.
2911 wfSuppressWarnings();
2912 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
2913 wfRestoreWarnings();
2915 if ( !$haveDiff3 ) {
2916 wfDebug( "diff3 not found\n" );
2920 # Make temporary files
2922 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2923 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
2924 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
2926 # NOTE: diff3 issues a warning to stderr if any of the files does not end with
2927 # a newline character. To avoid this, we normalize the trailing whitespace before
2928 # creating the diff.
2930 fwrite( $oldtextFile, rtrim( $old ) . "\n" );
2931 fclose( $oldtextFile );
2932 fwrite( $mytextFile, rtrim( $mine ) . "\n" );
2933 fclose( $mytextFile );
2934 fwrite( $yourtextFile, rtrim( $yours ) . "\n" );
2935 fclose( $yourtextFile );
2937 # Check for a conflict
2938 $cmd = wfEscapeShellArg( $wgDiff3 ) . ' -a --overlap-only ' .
2939 wfEscapeShellArg( $mytextName ) . ' ' .
2940 wfEscapeShellArg( $oldtextName ) . ' ' .
2941 wfEscapeShellArg( $yourtextName );
2942 $handle = popen( $cmd, 'r' );
2944 if ( fgets( $handle, 1024 ) ) {
2952 $cmd = wfEscapeShellArg( $wgDiff3 ) . ' -a -e --merge ' .
2953 wfEscapeShellArg( $mytextName, $oldtextName, $yourtextName );
2954 $handle = popen( $cmd, 'r' );
2957 $data = fread( $handle, 8192 );
2958 if ( strlen( $data ) == 0 ) {
2964 unlink( $mytextName );
2965 unlink( $oldtextName );
2966 unlink( $yourtextName );
2968 if ( $result === '' && $old !== '' && !$conflict ) {
2969 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
2976 * Returns unified plain-text diff of two texts.
2977 * Useful for machine processing of diffs.
2979 * @param string $before the text before the changes.
2980 * @param string $after the text after the changes.
2981 * @param string $params command-line options for the diff command.
2982 * @return String: unified diff of $before and $after
2984 function wfDiff( $before, $after, $params = '-u' ) {
2985 if ( $before == $after ) {
2990 wfSuppressWarnings();
2991 $haveDiff = $wgDiff && file_exists( $wgDiff );
2992 wfRestoreWarnings();
2994 # This check may also protect against code injection in
2995 # case of broken installations.
2997 wfDebug( "diff executable not found\n" );
2998 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
2999 $format = new UnifiedDiffFormatter();
3000 return $format->format( $diffs );
3003 # Make temporary files
3005 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
3006 $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
3008 fwrite( $oldtextFile, $before );
3009 fclose( $oldtextFile );
3010 fwrite( $newtextFile, $after );
3011 fclose( $newtextFile );
3013 // Get the diff of the two files
3014 $cmd = "$wgDiff " . $params . ' ' . wfEscapeShellArg( $oldtextName, $newtextName );
3016 $h = popen( $cmd, 'r' );
3021 $data = fread( $h, 8192 );
3022 if ( strlen( $data ) == 0 ) {
3030 unlink( $oldtextName );
3031 unlink( $newtextName );
3033 // Kill the --- and +++ lines. They're not useful.
3034 $diff_lines = explode( "\n", $diff );
3035 if ( strpos( $diff_lines[0], '---' ) === 0 ) {
3036 unset( $diff_lines[0] );
3038 if ( strpos( $diff_lines[1], '+++' ) === 0 ) {
3039 unset( $diff_lines[1] );
3042 $diff = implode( "\n", $diff_lines );
3048 * This function works like "use VERSION" in Perl, the program will die with a
3049 * backtrace if the current version of PHP is less than the version provided
3051 * This is useful for extensions which due to their nature are not kept in sync
3052 * with releases, and might depend on other versions of PHP than the main code
3054 * Note: PHP might die due to parsing errors in some cases before it ever
3055 * manages to call this function, such is life
3057 * @see perldoc -f use
3059 * @param $req_ver Mixed: the version to check, can be a string, an integer, or
3061 * @throws MWException
3063 function wfUsePHP( $req_ver ) {
3064 $php_ver = PHP_VERSION
;
3066 if ( version_compare( $php_ver, (string)$req_ver, '<' ) ) {
3067 throw new MWException( "PHP $req_ver required--this is only $php_ver" );
3072 * This function works like "use VERSION" in Perl except it checks the version
3073 * of MediaWiki, the program will die with a backtrace if the current version
3074 * of MediaWiki is less than the version provided.
3076 * This is useful for extensions which due to their nature are not kept in sync
3079 * @see perldoc -f use
3081 * @param $req_ver Mixed: the version to check, can be a string, an integer, or
3083 * @throws MWException
3085 function wfUseMW( $req_ver ) {
3088 if ( version_compare( $wgVersion, (string)$req_ver, '<' ) ) {
3089 throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
3094 * Return the final portion of a pathname.
3095 * Reimplemented because PHP5's "basename()" is buggy with multibyte text.
3096 * http://bugs.php.net/bug.php?id=33898
3098 * PHP's basename() only considers '\' a pathchar on Windows and Netware.
3099 * We'll consider it so always, as we don't want '\s' in our Unix paths either.
3101 * @param $path String
3102 * @param string $suffix to remove if present
3105 function wfBaseName( $path, $suffix = '' ) {
3106 $encSuffix = ( $suffix == '' )
3108 : ( '(?:' . preg_quote( $suffix, '#' ) . ')?' );
3110 if ( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
3118 * Generate a relative path name to the given file.
3119 * May explode on non-matching case-insensitive paths,
3120 * funky symlinks, etc.
3122 * @param string $path absolute destination path including target filename
3123 * @param string $from Absolute source path, directory only
3126 function wfRelativePath( $path, $from ) {
3127 // Normalize mixed input on Windows...
3128 $path = str_replace( '/', DIRECTORY_SEPARATOR
, $path );
3129 $from = str_replace( '/', DIRECTORY_SEPARATOR
, $from );
3131 // Trim trailing slashes -- fix for drive root
3132 $path = rtrim( $path, DIRECTORY_SEPARATOR
);
3133 $from = rtrim( $from, DIRECTORY_SEPARATOR
);
3135 $pieces = explode( DIRECTORY_SEPARATOR
, dirname( $path ) );
3136 $against = explode( DIRECTORY_SEPARATOR
, $from );
3138 if ( $pieces[0] !== $against[0] ) {
3139 // Non-matching Windows drive letters?
3140 // Return a full path.
3144 // Trim off common prefix
3145 while ( count( $pieces ) && count( $against )
3146 && $pieces[0] == $against[0] ) {
3147 array_shift( $pieces );
3148 array_shift( $against );
3151 // relative dots to bump us to the parent
3152 while ( count( $against ) ) {
3153 array_unshift( $pieces, '..' );
3154 array_shift( $against );
3157 array_push( $pieces, wfBaseName( $path ) );
3159 return implode( DIRECTORY_SEPARATOR
, $pieces );
3163 * Do any deferred updates and clear the list
3165 * @deprecated since 1.19
3166 * @see DeferredUpdates::doUpdate()
3167 * @param $commit string
3169 function wfDoUpdates( $commit = '' ) {
3170 wfDeprecated( __METHOD__
, '1.19' );
3171 DeferredUpdates
::doUpdates( $commit );
3175 * Convert an arbitrarily-long digit string from one numeric base
3176 * to another, optionally zero-padding to a minimum column width.
3178 * Supports base 2 through 36; digit values 10-36 are represented
3179 * as lowercase letters a-z. Input is case-insensitive.
3181 * @param string $input Input number
3182 * @param int $sourceBase Base of the input number
3183 * @param int $destBase Desired base of the output
3184 * @param int $pad Minimum number of digits in the output (pad with zeroes)
3185 * @param bool $lowercase Whether to output in lowercase or uppercase
3186 * @param string $engine Either "gmp", "bcmath", or "php"
3187 * @return string|bool The output number as a string, or false on error
3189 function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1, $lowercase = true, $engine = 'auto' ) {
3190 $input = (string)$input;
3196 $sourceBase != (int) $sourceBase ||
3197 $destBase != (int) $destBase ||
3198 $pad != (int) $pad ||
3199 !preg_match( "/^[" . substr( '0123456789abcdefghijklmnopqrstuvwxyz', 0, $sourceBase ) . "]+$/i", $input )
3204 static $baseChars = array(
3205 10 => 'a', 11 => 'b', 12 => 'c', 13 => 'd', 14 => 'e', 15 => 'f',
3206 16 => 'g', 17 => 'h', 18 => 'i', 19 => 'j', 20 => 'k', 21 => 'l',
3207 22 => 'm', 23 => 'n', 24 => 'o', 25 => 'p', 26 => 'q', 27 => 'r',
3208 28 => 's', 29 => 't', 30 => 'u', 31 => 'v', 32 => 'w', 33 => 'x',
3209 34 => 'y', 35 => 'z',
3211 '0' => 0, '1' => 1, '2' => 2, '3' => 3, '4' => 4, '5' => 5,
3212 '6' => 6, '7' => 7, '8' => 8, '9' => 9, 'a' => 10, 'b' => 11,
3213 'c' => 12, 'd' => 13, 'e' => 14, 'f' => 15, 'g' => 16, 'h' => 17,
3214 'i' => 18, 'j' => 19, 'k' => 20, 'l' => 21, 'm' => 22, 'n' => 23,
3215 'o' => 24, 'p' => 25, 'q' => 26, 'r' => 27, 's' => 28, 't' => 29,
3216 'u' => 30, 'v' => 31, 'w' => 32, 'x' => 33, 'y' => 34, 'z' => 35
3219 if ( extension_loaded( 'gmp' ) && ( $engine == 'auto' ||
$engine == 'gmp' ) ) {
3220 $result = gmp_strval( gmp_init( $input, $sourceBase ), $destBase );
3221 } elseif ( extension_loaded( 'bcmath' ) && ( $engine == 'auto' ||
$engine == 'bcmath' ) ) {
3223 foreach ( str_split( strtolower( $input ) ) as $char ) {
3224 $decimal = bcmul( $decimal, $sourceBase );
3225 $decimal = bcadd( $decimal, $baseChars[$char] );
3228 for ( $result = ''; bccomp( $decimal, 0 ); $decimal = bcdiv( $decimal, $destBase, 0 ) ) {
3229 $result .= $baseChars[bcmod( $decimal, $destBase )];
3232 $result = strrev( $result );
3234 $inDigits = array();
3235 foreach ( str_split( strtolower( $input ) ) as $char ) {
3236 $inDigits[] = $baseChars[$char];
3239 // Iterate over the input, modulo-ing out an output digit
3240 // at a time until input is gone.
3242 while ( $inDigits ) {
3244 $workDigits = array();
3247 foreach ( $inDigits as $digit ) {
3248 $work *= $sourceBase;
3251 if ( $workDigits ||
$work >= $destBase ) {
3252 $workDigits[] = (int) ( $work / $destBase );
3257 // All that division leaves us with a remainder,
3258 // which is conveniently our next output digit.
3259 $result .= $baseChars[$work];
3262 $inDigits = $workDigits;
3265 $result = strrev( $result );
3268 if ( !$lowercase ) {
3269 $result = strtoupper( $result );
3272 return str_pad( $result, $pad, '0', STR_PAD_LEFT
);
3276 * Create an object with a given name and an array of construct parameters
3278 * @param $name String
3279 * @param array $p parameters
3281 * @deprecated since 1.18, warnings in 1.18, removal in 1.20
3283 function wfCreateObject( $name, $p ) {
3284 wfDeprecated( __FUNCTION__
, '1.18' );
3285 return MWFunction
::newObj( $name, $p );
3291 function wfHttpOnlySafe() {
3292 global $wgHttpOnlyBlacklist;
3294 if ( isset( $_SERVER['HTTP_USER_AGENT'] ) ) {
3295 foreach ( $wgHttpOnlyBlacklist as $regex ) {
3296 if ( preg_match( $regex, $_SERVER['HTTP_USER_AGENT'] ) ) {
3306 * Check if there is sufficient entropy in php's built-in session generation
3307 * @return bool true = there is sufficient entropy
3309 function wfCheckEntropy() {
3311 ( wfIsWindows() && version_compare( PHP_VERSION
, '5.3.3', '>=' ) )
3312 ||
ini_get( 'session.entropy_file' )
3314 && intval( ini_get( 'session.entropy_length' ) ) >= 32;
3318 * Override session_id before session startup if php's built-in
3319 * session generation code is not secure.
3321 function wfFixSessionID() {
3322 // If the cookie or session id is already set we already have a session and should abort
3323 if ( isset( $_COOKIE[session_name()] ) ||
session_id() ) {
3327 // PHP's built-in session entropy is enabled if:
3328 // - entropy_file is set or you're on Windows with php 5.3.3+
3329 // - AND entropy_length is > 0
3330 // We treat it as disabled if it doesn't have an entropy length of at least 32
3331 $entropyEnabled = wfCheckEntropy();
3333 // If built-in entropy is not enabled or not sufficient override php's built in session id generation code
3334 if ( !$entropyEnabled ) {
3335 wfDebug( __METHOD__
. ": PHP's built in entropy is disabled or not sufficient, overriding session id generation using our cryptrand source.\n" );
3336 session_id( MWCryptRand
::generateHex( 32 ) );
3341 * Initialise php session
3343 * @param $sessionId Bool
3345 function wfSetupSession( $sessionId = false ) {
3346 global $wgSessionsInMemcached, $wgSessionsInObjectCache, $wgCookiePath, $wgCookieDomain,
3347 $wgCookieSecure, $wgCookieHttpOnly, $wgSessionHandler;
3348 if ( $wgSessionsInObjectCache ||
$wgSessionsInMemcached ) {
3349 ObjectCacheSessionHandler
::install();
3350 } elseif ( $wgSessionHandler && $wgSessionHandler != ini_get( 'session.save_handler' ) ) {
3351 # Only set this if $wgSessionHandler isn't null and session.save_handler
3352 # hasn't already been set to the desired value (that causes errors)
3353 ini_set( 'session.save_handler', $wgSessionHandler );
3355 $httpOnlySafe = wfHttpOnlySafe() && $wgCookieHttpOnly;
3356 wfDebugLog( 'cookie',
3357 'session_set_cookie_params: "' . implode( '", "',
3363 $httpOnlySafe ) ) . '"' );
3364 session_set_cookie_params( 0, $wgCookiePath, $wgCookieDomain, $wgCookieSecure, $httpOnlySafe );
3365 session_cache_limiter( 'private, must-revalidate' );
3367 session_id( $sessionId );
3371 wfSuppressWarnings();
3373 wfRestoreWarnings();
3377 * Get an object from the precompiled serialized directory
3379 * @param $name String
3380 * @return Mixed: the variable on success, false on failure
3382 function wfGetPrecompiledData( $name ) {
3385 $file = "$IP/serialized/$name";
3386 if ( file_exists( $file ) ) {
3387 $blob = file_get_contents( $file );
3389 return unserialize( $blob );
3401 function wfMemcKey( /*... */ ) {
3402 global $wgCachePrefix;
3403 $prefix = $wgCachePrefix === false ?
wfWikiID() : $wgCachePrefix;
3404 $args = func_get_args();
3405 $key = $prefix . ':' . implode( ':', $args );
3406 $key = str_replace( ' ', '_', $key );
3411 * Get a cache key for a foreign DB
3414 * @param $prefix String
3415 * @param varargs String
3418 function wfForeignMemcKey( $db, $prefix /*, ... */ ) {
3419 $args = array_slice( func_get_args(), 2 );
3421 $key = "$db-$prefix:" . implode( ':', $args );
3423 $key = $db . ':' . implode( ':', $args );
3429 * Get an ASCII string identifying this wiki
3430 * This is used as a prefix in memcached keys
3434 function wfWikiID() {
3435 global $wgDBprefix, $wgDBname;
3436 if ( $wgDBprefix ) {
3437 return "$wgDBname-$wgDBprefix";
3444 * Split a wiki ID into DB name and table prefix
3446 * @param $wiki String
3450 function wfSplitWikiID( $wiki ) {
3451 $bits = explode( '-', $wiki, 2 );
3452 if ( count( $bits ) < 2 ) {
3459 * Get a Database object.
3461 * @param $db Integer: index of the connection to get. May be DB_MASTER for the
3462 * master (for write queries), DB_SLAVE for potentially lagged read
3463 * queries, or an integer >= 0 for a particular server.
3465 * @param $groups Mixed: query groups. An array of group names that this query
3466 * belongs to. May contain a single string if the query is only
3469 * @param string $wiki the wiki ID, or false for the current wiki
3471 * Note: multiple calls to wfGetDB(DB_SLAVE) during the course of one request
3472 * will always return the same object, unless the underlying connection or load
3473 * balancer is manually destroyed.
3475 * Note 2: use $this->getDB() in maintenance scripts that may be invoked by
3476 * updater to ensure that a proper database is being updated.
3478 * @return DatabaseBase
3480 function &wfGetDB( $db, $groups = array(), $wiki = false ) {
3481 return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
3485 * Get a load balancer object.
3487 * @param string $wiki wiki ID, or false for the current wiki
3488 * @return LoadBalancer
3490 function wfGetLB( $wiki = false ) {
3491 return wfGetLBFactory()->getMainLB( $wiki );
3495 * Get the load balancer factory object
3499 function &wfGetLBFactory() {
3500 return LBFactory
::singleton();
3505 * Shortcut for RepoGroup::singleton()->findFile()
3507 * @param string $title or Title object
3508 * @param array $options Associative array of options:
3509 * time: requested time for an archived image, or false for the
3510 * current version. An image object will be returned which was
3511 * created at the specified time.
3513 * ignoreRedirect: If true, do not follow file redirects
3515 * private: If true, return restricted (deleted) files if the current
3516 * user is allowed to view them. Otherwise, such files will not
3519 * bypassCache: If true, do not use the process-local cache of File objects
3521 * @return File, or false if the file does not exist
3523 function wfFindFile( $title, $options = array() ) {
3524 return RepoGroup
::singleton()->findFile( $title, $options );
3528 * Get an object referring to a locally registered file.
3529 * Returns a valid placeholder object if the file does not exist.
3531 * @param $title Title|String
3532 * @return LocalFile|null A File, or null if passed an invalid Title
3534 function wfLocalFile( $title ) {
3535 return RepoGroup
::singleton()->getLocalRepo()->newFile( $title );
3539 * Stream a file to the browser. Back-compat alias for StreamFile::stream()
3540 * @deprecated since 1.19
3542 function wfStreamFile( $fname, $headers = array() ) {
3543 wfDeprecated( __FUNCTION__
, '1.19' );
3544 StreamFile
::stream( $fname, $headers );
3548 * Should low-performance queries be disabled?
3551 * @codeCoverageIgnore
3553 function wfQueriesMustScale() {
3554 global $wgMiserMode;
3556 ||
( SiteStats
::pages() > 100000
3557 && SiteStats
::edits() > 1000000
3558 && SiteStats
::users() > 10000 );
3562 * Get the path to a specified script file, respecting file
3563 * extensions; this is a wrapper around $wgScriptExtension etc.
3564 * except for 'index' and 'load' which use $wgScript/$wgLoadScript
3566 * @param string $script script filename, sans extension
3569 function wfScript( $script = 'index' ) {
3570 global $wgScriptPath, $wgScriptExtension, $wgScript, $wgLoadScript;
3571 if ( $script === 'index' ) {
3573 } elseif ( $script === 'load' ) {
3574 return $wgLoadScript;
3576 return "{$wgScriptPath}/{$script}{$wgScriptExtension}";
3581 * Get the script URL.
3583 * @return string script URL
3585 function wfGetScriptUrl() {
3586 if ( isset( $_SERVER['SCRIPT_NAME'] ) ) {
3588 # as it was called, minus the query string.
3590 # Some sites use Apache rewrite rules to handle subdomains,
3591 # and have PHP set up in a weird way that causes PHP_SELF
3592 # to contain the rewritten URL instead of the one that the
3593 # outside world sees.
3595 # If in this mode, use SCRIPT_URL instead, which mod_rewrite
3596 # provides containing the "before" URL.
3597 return $_SERVER['SCRIPT_NAME'];
3599 return $_SERVER['URL'];
3604 * Convenience function converts boolean values into "true"
3605 * or "false" (string) values
3607 * @param $value Boolean
3610 function wfBoolToStr( $value ) {
3611 return $value ?
'true' : 'false';
3615 * Get a platform-independent path to the null file, e.g. /dev/null
3619 function wfGetNull() {
3620 return wfIsWindows()
3626 * Modern version of wfWaitForSlaves(). Instead of looking at replication lag
3627 * and waiting for it to go down, this waits for the slaves to catch up to the
3628 * master position. Use this when updating very large numbers of rows, as
3629 * in maintenance scripts, to avoid causing too much lag. Of course, this is
3630 * a no-op if there are no slaves.
3632 * @param $maxLag Integer (deprecated)
3633 * @param $wiki mixed Wiki identifier accepted by wfGetLB
3634 * @param $cluster string cluster name accepted by LBFactory
3636 function wfWaitForSlaves( $maxLag = false, $wiki = false, $cluster = false ) {
3637 $lb = ( $cluster !== false )
3638 ?
wfGetLBFactory()->getExternalLB( $cluster )
3640 // bug 27975 - Don't try to wait for slaves if there are none
3641 // Prevents permission error when getting master position
3642 if ( $lb->getServerCount() > 1 ) {
3643 $dbw = $lb->getConnection( DB_MASTER
, array(), $wiki );
3644 $pos = $dbw->getMasterPos();
3645 // The DBMS may not support getMasterPos() or the whole
3646 // load balancer might be fake (e.g. $wgAllDBsAreLocalhost).
3647 if ( $pos !== false ) {
3648 $lb->waitForAll( $pos );
3654 * Used to be used for outputting text in the installer/updater
3655 * @deprecated since 1.18, warnings in 1.18, remove in 1.20
3657 function wfOut( $s ) {
3658 wfDeprecated( __FUNCTION__
, '1.18' );
3659 global $wgCommandLineMode;
3660 if ( $wgCommandLineMode ) {
3663 echo htmlspecialchars( $s );
3669 * Count down from $n to zero on the terminal, with a one-second pause
3670 * between showing each number. For use in command-line scripts.
3671 * @codeCoverageIgnore
3674 function wfCountDown( $n ) {
3675 for ( $i = $n; $i >= 0; $i-- ) {
3677 echo str_repeat( "\x08", strlen( $i +
1 ) );
3689 * Generate a random 32-character hexadecimal token.
3690 * @param $salt Mixed: some sort of salt, if necessary, to add to random
3691 * characters before hashing.
3693 * @codeCoverageIgnore
3694 * @deprecated since 1.20; Please use MWCryptRand for security purposes and wfRandomString for pseudo-random strings
3695 * @warning This method is NOT secure. Additionally it has many callers that use it for pseudo-random purposes.
3697 function wfGenerateToken( $salt = '' ) {
3698 wfDeprecated( __METHOD__
, '1.20' );
3699 $salt = serialize( $salt );
3700 return md5( mt_rand( 0, 0x7fffffff ) . $salt );
3704 * Replace all invalid characters with -
3705 * Additional characters can be defined in $wgIllegalFileChars (see bug 20489)
3706 * By default, $wgIllegalFileChars = ':'
3708 * @param $name Mixed: filename to process
3711 function wfStripIllegalFilenameChars( $name ) {
3712 global $wgIllegalFileChars;
3713 $illegalFileChars = $wgIllegalFileChars ?
"|[" . $wgIllegalFileChars . "]" : '';
3714 $name = wfBaseName( $name );
3715 $name = preg_replace(
3716 "/[^" . Title
::legalChars() . "]" . $illegalFileChars . "/",
3724 * Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit;
3726 * @return Integer value memory was set to.
3728 function wfMemoryLimit() {
3729 global $wgMemoryLimit;
3730 $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
3731 if ( $memlimit != -1 ) {
3732 $conflimit = wfShorthandToInteger( $wgMemoryLimit );
3733 if ( $conflimit == -1 ) {
3734 wfDebug( "Removing PHP's memory limit\n" );
3735 wfSuppressWarnings();
3736 ini_set( 'memory_limit', $conflimit );
3737 wfRestoreWarnings();
3739 } elseif ( $conflimit > $memlimit ) {
3740 wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
3741 wfSuppressWarnings();
3742 ini_set( 'memory_limit', $conflimit );
3743 wfRestoreWarnings();
3751 * Converts shorthand byte notation to integer form
3753 * @param $string String
3756 function wfShorthandToInteger( $string = '' ) {
3757 $string = trim( $string );
3758 if ( $string === '' ) {
3761 $last = $string[strlen( $string ) - 1];
3762 $val = intval( $string );
3767 // break intentionally missing
3771 // break intentionally missing
3781 * Get the normalised IETF language tag
3782 * See unit test for examples.
3784 * @param string $code The language code.
3785 * @return String: The language code which complying with BCP 47 standards.
3787 function wfBCP47( $code ) {
3788 $codeSegment = explode( '-', $code );
3790 foreach ( $codeSegment as $segNo => $seg ) {
3791 if ( count( $codeSegment ) > 0 ) {
3792 // when previous segment is x, it is a private segment and should be lc
3793 if ( $segNo > 0 && strtolower( $codeSegment[( $segNo - 1 )] ) == 'x' ) {
3794 $codeBCP[$segNo] = strtolower( $seg );
3795 // ISO 3166 country code
3796 } elseif ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) {
3797 $codeBCP[$segNo] = strtoupper( $seg );
3798 // ISO 15924 script code
3799 } elseif ( ( strlen( $seg ) == 4 ) && ( $segNo > 0 ) ) {
3800 $codeBCP[$segNo] = ucfirst( strtolower( $seg ) );
3801 // Use lowercase for other cases
3803 $codeBCP[$segNo] = strtolower( $seg );
3806 // Use lowercase for single segment
3807 $codeBCP[$segNo] = strtolower( $seg );
3810 $langCode = implode( '-', $codeBCP );
3815 * Get a cache object.
3817 * @param $inputType integer Cache type, one the the CACHE_* constants.
3820 function wfGetCache( $inputType ) {
3821 return ObjectCache
::getInstance( $inputType );
3825 * Get the main cache object
3829 function wfGetMainCache() {
3830 global $wgMainCacheType;
3831 return ObjectCache
::getInstance( $wgMainCacheType );
3835 * Get the cache object used by the message cache
3839 function wfGetMessageCacheStorage() {
3840 global $wgMessageCacheType;
3841 return ObjectCache
::getInstance( $wgMessageCacheType );
3845 * Get the cache object used by the parser cache
3849 function wfGetParserCacheStorage() {
3850 global $wgParserCacheType;
3851 return ObjectCache
::getInstance( $wgParserCacheType );
3855 * Get the cache object used by the language converter
3859 function wfGetLangConverterCacheStorage() {
3860 global $wgLanguageConverterCacheType;
3861 return ObjectCache
::getInstance( $wgLanguageConverterCacheType );
3865 * Call hook functions defined in $wgHooks
3867 * @param string $event event name
3868 * @param array $args parameters passed to hook functions
3869 * @return Boolean True if no handler aborted the hook
3871 function wfRunHooks( $event, array $args = array() ) {
3872 return Hooks
::run( $event, $args );
3876 * Wrapper around php's unpack.
3878 * @param string $format The format string (See php's docs)
3879 * @param $data: A binary string of binary data
3880 * @param $length integer or false: The minimum length of $data. This is to
3881 * prevent reading beyond the end of $data. false to disable the check.
3883 * Also be careful when using this function to read unsigned 32 bit integer
3884 * because php might make it negative.
3886 * @throws MWException if $data not long enough, or if unpack fails
3887 * @return array Associative array of the extracted data
3889 function wfUnpack( $format, $data, $length = false ) {
3890 if ( $length !== false ) {
3891 $realLen = strlen( $data );
3892 if ( $realLen < $length ) {
3893 throw new MWException( "Tried to use wfUnpack on a "
3894 . "string of length $realLen, but needed one "
3895 . "of at least length $length."
3900 wfSuppressWarnings();
3901 $result = unpack( $format, $data );
3902 wfRestoreWarnings();
3904 if ( $result === false ) {
3905 // If it cannot extract the packed data.
3906 throw new MWException( "unpack could not unpack binary data" );
3912 * Determine if an image exists on the 'bad image list'.
3914 * The format of MediaWiki:Bad_image_list is as follows:
3915 * * Only list items (lines starting with "*") are considered
3916 * * The first link on a line must be a link to a bad image
3917 * * Any subsequent links on the same line are considered to be exceptions,
3918 * i.e. articles where the image may occur inline.
3920 * @param string $name the image name to check
3921 * @param $contextTitle Title|bool the page on which the image occurs, if known
3922 * @param string $blacklist wikitext of a file blacklist
3925 function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
3926 static $badImageCache = null; // based on bad_image_list msg
3927 wfProfileIn( __METHOD__
);
3930 $redirectTitle = RepoGroup
::singleton()->checkRedirect( Title
::makeTitle( NS_FILE
, $name ) );
3931 if ( $redirectTitle ) {
3932 $name = $redirectTitle->getDBkey();
3935 # Run the extension hook
3937 if ( !wfRunHooks( 'BadImage', array( $name, &$bad ) ) ) {
3938 wfProfileOut( __METHOD__
);
3942 $cacheable = ( $blacklist === null );
3943 if ( $cacheable && $badImageCache !== null ) {
3944 $badImages = $badImageCache;
3945 } else { // cache miss
3946 if ( $blacklist === null ) {
3947 $blacklist = wfMessage( 'bad_image_list' )->inContentLanguage()->plain(); // site list
3949 # Build the list now
3950 $badImages = array();
3951 $lines = explode( "\n", $blacklist );
3952 foreach ( $lines as $line ) {
3954 if ( substr( $line, 0, 1 ) !== '*' ) {
3960 if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
3964 $exceptions = array();
3965 $imageDBkey = false;
3966 foreach ( $m[1] as $i => $titleText ) {
3967 $title = Title
::newFromText( $titleText );
3968 if ( !is_null( $title ) ) {
3970 $imageDBkey = $title->getDBkey();
3972 $exceptions[$title->getPrefixedDBkey()] = true;
3977 if ( $imageDBkey !== false ) {
3978 $badImages[$imageDBkey] = $exceptions;
3982 $badImageCache = $badImages;
3986 $contextKey = $contextTitle ?
$contextTitle->getPrefixedDBkey() : false;
3987 $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
3988 wfProfileOut( __METHOD__
);