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 );
98 // Support for Wietse Venema's taint feature
99 if ( !function_exists( 'istainted' ) ) {
101 * @codeCoverageIgnore
104 function istainted( $var ) {
107 /** @codeCoverageIgnore */
108 function taint( $var, $level = 0 ) {}
109 /** @codeCoverageIgnore */
110 function untaint( $var, $level = 0 ) {}
111 define( 'TC_HTML', 1 );
112 define( 'TC_SHELL', 1 );
113 define( 'TC_MYSQL', 1 );
114 define( 'TC_PCRE', 1 );
115 define( 'TC_SELF', 1 );
120 * Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
125 function wfArrayDiff2( $a, $b ) {
126 return array_udiff( $a, $b, 'wfArrayDiff2_cmp' );
134 function wfArrayDiff2_cmp( $a, $b ) {
135 if ( !is_array( $a ) ) {
136 return strcmp( $a, $b );
137 } elseif ( count( $a ) !== count( $b ) ) {
138 return count( $a ) < count( $b ) ?
-1 : 1;
142 while( ( list( , $valueA ) = each( $a ) ) && ( list( , $valueB ) = each( $b ) ) ) {
143 $cmp = strcmp( $valueA, $valueB );
154 * Returns an array where the values in the first array are replaced by the
155 * values in the second array with the corresponding keys
161 function wfArrayLookup( $a, $b ) {
162 return array_flip( array_intersect( array_flip( $a ), array_keys( $b ) ) );
166 * Appends to second array if $value differs from that in $default
168 * @param $key String|Int
169 * @param $value Mixed
170 * @param $default Mixed
171 * @param $changed Array to alter
172 * @throws MWException
174 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
175 if ( is_null( $changed ) ) {
176 throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' );
178 if ( $default[$key] !== $value ) {
179 $changed[$key] = $value;
184 * Backwards array plus for people who haven't bothered to read the PHP manual
185 * XXX: will not darn your socks for you.
187 * @param $array1 Array
188 * @param [$array2, [...]] Arrays
191 function wfArrayMerge( $array1/* ... */ ) {
192 $args = func_get_args();
193 $args = array_reverse( $args, true );
195 foreach ( $args as $arg ) {
202 * Merge arrays in the style of getUserPermissionsErrors, with duplicate removal
204 * wfMergeErrorArrays(
205 * array( array( 'x' ) ),
206 * array( array( 'x', '2' ) ),
207 * array( array( 'x' ) ),
208 * array( array( 'y' ) )
219 function wfMergeErrorArrays( /*...*/ ) {
220 $args = func_get_args();
222 foreach ( $args as $errors ) {
223 foreach ( $errors as $params ) {
224 # @todo FIXME: Sometimes get nested arrays for $params,
225 # which leads to E_NOTICEs
226 $spec = implode( "\t", $params );
227 $out[$spec] = $params;
230 return array_values( $out );
234 * Insert array into another array after the specified *KEY*
236 * @param $array Array: The array.
237 * @param $insert Array: The array to insert.
238 * @param $after Mixed: The key to insert after
241 function wfArrayInsertAfter( array $array, array $insert, $after ) {
242 // Find the offset of the element to insert after.
243 $keys = array_keys( $array );
244 $offsetByKey = array_flip( $keys );
246 $offset = $offsetByKey[$after];
248 // Insert at the specified offset
249 $before = array_slice( $array, 0, $offset +
1, true );
250 $after = array_slice( $array, $offset +
1, count( $array ) - $offset, true );
252 $output = $before +
$insert +
$after;
258 * Recursively converts the parameter (an object) to an array with the same data
260 * @param $objOrArray Object|Array
261 * @param $recursive Bool
264 function wfObjectToArray( $objOrArray, $recursive = true ) {
266 if( is_object( $objOrArray ) ) {
267 $objOrArray = get_object_vars( $objOrArray );
269 foreach ( $objOrArray as $key => $value ) {
270 if ( $recursive && ( is_object( $value ) ||
is_array( $value ) ) ) {
271 $value = wfObjectToArray( $value );
274 $array[$key] = $value;
281 * Wrapper around array_map() which also taints variables
283 * @param $function Callback
284 * @param $input Array
287 function wfArrayMap( $function, $input ) {
288 $ret = array_map( $function, $input );
289 foreach ( $ret as $key => $value ) {
290 $taint = istainted( $input[$key] );
292 taint( $ret[$key], $taint );
299 * Get a random decimal value between 0 and 1, in a way
300 * not likely to give duplicate values for any realistic
301 * number of articles.
305 function wfRandom() {
306 # The maximum random value is "only" 2^31-1, so get two random
307 # values to reduce the chance of dupes
308 $max = mt_getrandmax() +
1;
309 $rand = number_format( ( mt_rand() * $max +
mt_rand() )
310 / $max / $max, 12, '.', '' );
315 * Get a random string containing a number of pesudo-random hex
317 * @note This is not secure, if you are trying to generate some sort
318 * of token please use MWCryptRand instead.
320 * @param $length int The length of the string to generate
324 function wfRandomString( $length = 32 ) {
326 while ( strlen( $str ) < $length ) {
327 $str .= dechex( mt_rand() );
329 return substr( $str, 0, $length );
333 * Given an array of non-normalised probabilities, this function will select
334 * an element and return the appropriate key
336 * @param $weights array
340 function wfPickRandom( $weights ){
341 if ( !is_array( $weights ) ||
count( $weights ) == 0 ) {
345 $sum = array_sum( $weights );
347 # No loads on any of them
348 # In previous versions, this triggered an unweighted random selection,
349 # but this feature has been removed as of April 2006 to allow for strict
350 # separation of query groups.
353 $max = mt_getrandmax();
354 $rand = mt_rand( 0, $max ) / $max * $sum;
357 foreach ( $weights as $i => $w ) {
359 if ( $sum >= $rand ) {
367 * We want some things to be included as literal characters in our title URLs
368 * for prettiness, which urlencode encodes by default. According to RFC 1738,
369 * all of the following should be safe:
373 * But + is not safe because it's used to indicate a space; &= are only safe in
374 * paths and not in queries (and we don't distinguish here); ' seems kind of
375 * scary; and urlencode() doesn't touch -_. to begin with. Plus, although /
376 * is reserved, we don't care. So the list we unescape is:
380 * However, IIS7 redirects fail when the url contains a colon (Bug 22709),
381 * so no fancy : for IIS7.
383 * %2F in the page titles seems to fatally break for some reason.
388 function wfUrlencode( $s ) {
390 if ( is_null( $s ) ) {
395 if ( is_null( $needle ) ) {
396 $needle = array( '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F' );
397 if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) ||
( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false ) ) {
402 $s = urlencode( $s );
405 array( ';', '@', '$', '!', '*', '(', ')', ',', '/', ':' ),
413 * This function takes two arrays as input, and returns a CGI-style string, e.g.
414 * "days=7&limit=100". Options in the first array override options in the second.
415 * Options set to null or false will not be output.
417 * @param $array1 Array ( String|Array )
418 * @param $array2 Array ( String|Array )
419 * @param $prefix String
422 function wfArrayToCgi( $array1, $array2 = null, $prefix = '' ) {
423 if ( !is_null( $array2 ) ) {
424 $array1 = $array1 +
$array2;
428 foreach ( $array1 as $key => $value ) {
429 if ( !is_null( $value ) && $value !== false ) {
433 if ( $prefix !== '' ) {
434 $key = $prefix . "[$key]";
436 if ( is_array( $value ) ) {
438 foreach ( $value as $k => $v ) {
439 $cgi .= $firstTime ?
'' : '&';
440 if ( is_array( $v ) ) {
441 $cgi .= wfArrayToCgi( $v, null, $key . "[$k]" );
443 $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v );
448 if ( is_object( $value ) ) {
449 $value = $value->__toString();
451 $cgi .= urlencode( $key ) . '=' . urlencode( $value );
459 * This is the logical opposite of wfArrayToCgi(): it accepts a query string as
460 * its argument and returns the same string in array form. This allows compa-
461 * tibility with legacy functions that accept raw query strings instead of nice
462 * arrays. Of course, keys and values are urldecode()d.
464 * @param $query String: query string
465 * @return array Array version of input
467 function wfCgiToArray( $query ) {
468 if ( isset( $query[0] ) && $query[0] == '?' ) {
469 $query = substr( $query, 1 );
471 $bits = explode( '&', $query );
473 foreach ( $bits as $bit ) {
477 if ( strpos( $bit, '=' ) === false ) {
478 // Pieces like &qwerty become 'qwerty' => '' (at least this is what php does)
482 list( $key, $value ) = explode( '=', $bit );
484 $key = urldecode( $key );
485 $value = urldecode( $value );
486 if ( strpos( $key, '[' ) !== false ) {
487 $keys = array_reverse( explode( '[', $key ) );
488 $key = array_pop( $keys );
490 foreach ( $keys as $k ) {
491 $k = substr( $k, 0, -1 );
492 $temp = array( $k => $temp );
494 if ( isset( $ret[$key] ) ) {
495 $ret[$key] = array_merge( $ret[$key], $temp );
507 * Append a query string to an existing URL, which may or may not already
508 * have query string parameters already. If so, they will be combined.
511 * @param $query Mixed: string or associative array
514 function wfAppendQuery( $url, $query ) {
515 if ( is_array( $query ) ) {
516 $query = wfArrayToCgi( $query );
519 if( false === strpos( $url, '?' ) ) {
530 * Expand a potentially local URL to a fully-qualified URL. Assumes $wgServer
533 * The meaning of the PROTO_* constants is as follows:
534 * PROTO_HTTP: Output a URL starting with http://
535 * PROTO_HTTPS: Output a URL starting with https://
536 * PROTO_RELATIVE: Output a URL starting with // (protocol-relative URL)
537 * PROTO_CURRENT: Output a URL starting with either http:// or https:// , depending on which protocol was used for the current incoming request
538 * PROTO_CANONICAL: For URLs without a domain, like /w/index.php , use $wgCanonicalServer. For protocol-relative URLs, use the protocol of $wgCanonicalServer
539 * PROTO_INTERNAL: Like PROTO_CANONICAL, but uses $wgInternalServer instead of $wgCanonicalServer
541 * @todo this won't work with current-path-relative URLs
542 * like "subdir/foo.html", etc.
544 * @param $url String: either fully-qualified or a local path + query
545 * @param $defaultProto Mixed: one of the PROTO_* constants. Determines the
546 * protocol to use if $url or $wgServer is
548 * @return string Fully-qualified URL, current-path-relative URL or false if
549 * no valid URL can be constructed
551 function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT
) {
552 global $wgServer, $wgCanonicalServer, $wgInternalServer;
553 $serverUrl = $wgServer;
554 if ( $defaultProto === PROTO_CANONICAL
) {
555 $serverUrl = $wgCanonicalServer;
557 // Make $wgInternalServer fall back to $wgServer if not set
558 if ( $defaultProto === PROTO_INTERNAL
&& $wgInternalServer !== false ) {
559 $serverUrl = $wgInternalServer;
561 if ( $defaultProto === PROTO_CURRENT
) {
562 $defaultProto = WebRequest
::detectProtocol() . '://';
565 // Analyze $serverUrl to obtain its protocol
566 $bits = wfParseUrl( $serverUrl );
567 $serverHasProto = $bits && $bits['scheme'] != '';
569 if ( $defaultProto === PROTO_CANONICAL ||
$defaultProto === PROTO_INTERNAL
) {
570 if ( $serverHasProto ) {
571 $defaultProto = $bits['scheme'] . '://';
573 // $wgCanonicalServer or $wgInternalServer doesn't have a protocol. This really isn't supposed to happen
574 // Fall back to HTTP in this ridiculous case
575 $defaultProto = PROTO_HTTP
;
579 $defaultProtoWithoutSlashes = substr( $defaultProto, 0, -2 );
581 if ( substr( $url, 0, 2 ) == '//' ) {
582 $url = $defaultProtoWithoutSlashes . $url;
583 } elseif ( substr( $url, 0, 1 ) == '/' ) {
584 // If $serverUrl is protocol-relative, prepend $defaultProtoWithoutSlashes, otherwise leave it alone
585 $url = ( $serverHasProto ?
'' : $defaultProtoWithoutSlashes ) . $serverUrl . $url;
588 $bits = wfParseUrl( $url );
589 if ( $bits && isset( $bits['path'] ) ) {
590 $bits['path'] = wfRemoveDotSegments( $bits['path'] );
591 return wfAssembleUrl( $bits );
595 } elseif ( substr( $url, 0, 1 ) != '/' ) {
596 # URL is a relative path
597 return wfRemoveDotSegments( $url );
600 # Expanded URL is not valid.
605 * This function will reassemble a URL parsed with wfParseURL. This is useful
606 * if you need to edit part of a URL and put it back together.
608 * This is the basic structure used (brackets contain keys for $urlParts):
609 * [scheme][delimiter][user]:[pass]@[host]:[port][path]?[query]#[fragment]
611 * @todo Need to integrate this into wfExpandUrl (bug 32168)
614 * @param $urlParts Array URL parts, as output from wfParseUrl
615 * @return string URL assembled from its component parts
617 function wfAssembleUrl( $urlParts ) {
620 if ( isset( $urlParts['delimiter'] ) ) {
621 if ( isset( $urlParts['scheme'] ) ) {
622 $result .= $urlParts['scheme'];
625 $result .= $urlParts['delimiter'];
628 if ( isset( $urlParts['host'] ) ) {
629 if ( isset( $urlParts['user'] ) ) {
630 $result .= $urlParts['user'];
631 if ( isset( $urlParts['pass'] ) ) {
632 $result .= ':' . $urlParts['pass'];
637 $result .= $urlParts['host'];
639 if ( isset( $urlParts['port'] ) ) {
640 $result .= ':' . $urlParts['port'];
644 if ( isset( $urlParts['path'] ) ) {
645 $result .= $urlParts['path'];
648 if ( isset( $urlParts['query'] ) ) {
649 $result .= '?' . $urlParts['query'];
652 if ( isset( $urlParts['fragment'] ) ) {
653 $result .= '#' . $urlParts['fragment'];
660 * Remove all dot-segments in the provided URL path. For example,
661 * '/a/./b/../c/' becomes '/a/c/'. For details on the algorithm, please see
662 * RFC3986 section 5.2.4.
664 * @todo Need to integrate this into wfExpandUrl (bug 32168)
666 * @param $urlPath String URL path, potentially containing dot-segments
667 * @return string URL path with all dot-segments removed
669 function wfRemoveDotSegments( $urlPath ) {
672 $inputLength = strlen( $urlPath );
674 while ( $inputOffset < $inputLength ) {
675 $prefixLengthOne = substr( $urlPath, $inputOffset, 1 );
676 $prefixLengthTwo = substr( $urlPath, $inputOffset, 2 );
677 $prefixLengthThree = substr( $urlPath, $inputOffset, 3 );
678 $prefixLengthFour = substr( $urlPath, $inputOffset, 4 );
681 if ( $prefixLengthTwo == './' ) {
682 # Step A, remove leading "./"
684 } elseif ( $prefixLengthThree == '../' ) {
685 # Step A, remove leading "../"
687 } elseif ( ( $prefixLengthTwo == '/.' ) && ( $inputOffset +
2 == $inputLength ) ) {
688 # Step B, replace leading "/.$" with "/"
690 $urlPath[$inputOffset] = '/';
691 } elseif ( $prefixLengthThree == '/./' ) {
692 # Step B, replace leading "/./" with "/"
694 } elseif ( $prefixLengthThree == '/..' && ( $inputOffset +
3 == $inputLength ) ) {
695 # Step C, replace leading "/..$" with "/" and
696 # remove last path component in output
698 $urlPath[$inputOffset] = '/';
700 } elseif ( $prefixLengthFour == '/../' ) {
701 # Step C, replace leading "/../" with "/" and
702 # remove last path component in output
705 } elseif ( ( $prefixLengthOne == '.' ) && ( $inputOffset +
1 == $inputLength ) ) {
706 # Step D, remove "^.$"
708 } elseif ( ( $prefixLengthTwo == '..' ) && ( $inputOffset +
2 == $inputLength ) ) {
709 # Step D, remove "^..$"
712 # Step E, move leading path segment to output
713 if ( $prefixLengthOne == '/' ) {
714 $slashPos = strpos( $urlPath, '/', $inputOffset +
1 );
716 $slashPos = strpos( $urlPath, '/', $inputOffset );
718 if ( $slashPos === false ) {
719 $output .= substr( $urlPath, $inputOffset );
720 $inputOffset = $inputLength;
722 $output .= substr( $urlPath, $inputOffset, $slashPos - $inputOffset );
723 $inputOffset +
= $slashPos - $inputOffset;
728 $slashPos = strrpos( $output, '/' );
729 if ( $slashPos === false ) {
732 $output = substr( $output, 0, $slashPos );
741 * Returns a regular expression of url protocols
743 * @param $includeProtocolRelative bool If false, remove '//' from the returned protocol list.
744 * DO NOT USE this directly, use wfUrlProtocolsWithoutProtRel() instead
747 function wfUrlProtocols( $includeProtocolRelative = true ) {
748 global $wgUrlProtocols;
750 // Cache return values separately based on $includeProtocolRelative
751 static $withProtRel = null, $withoutProtRel = null;
752 $cachedValue = $includeProtocolRelative ?
$withProtRel : $withoutProtRel;
753 if ( !is_null( $cachedValue ) ) {
757 // Support old-style $wgUrlProtocols strings, for backwards compatibility
758 // with LocalSettings files from 1.5
759 if ( is_array( $wgUrlProtocols ) ) {
760 $protocols = array();
761 foreach ( $wgUrlProtocols as $protocol ) {
762 // Filter out '//' if !$includeProtocolRelative
763 if ( $includeProtocolRelative ||
$protocol !== '//' ) {
764 $protocols[] = preg_quote( $protocol, '/' );
768 $retval = implode( '|', $protocols );
770 // Ignore $includeProtocolRelative in this case
771 // This case exists for pre-1.6 compatibility, and we can safely assume
772 // that '//' won't appear in a pre-1.6 config because protocol-relative
773 // URLs weren't supported until 1.18
774 $retval = $wgUrlProtocols;
777 // Cache return value
778 if ( $includeProtocolRelative ) {
779 $withProtRel = $retval;
781 $withoutProtRel = $retval;
787 * Like wfUrlProtocols(), but excludes '//' from the protocol list. Use this if
788 * you need a regex that matches all URL protocols but does not match protocol-
792 function wfUrlProtocolsWithoutProtRel() {
793 return wfUrlProtocols( false );
797 * parse_url() work-alike, but non-broken. Differences:
799 * 1) Does not raise warnings on bad URLs (just returns false)
800 * 2) Handles protocols that don't use :// (e.g., mailto: and news: , as well as protocol-relative URLs) correctly
801 * 3) Adds a "delimiter" element to the array, either '://', ':' or '//' (see (2))
803 * @param $url String: a URL to parse
804 * @return Array: bits of the URL in an associative array, per PHP docs
806 function wfParseUrl( $url ) {
807 global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
809 // Protocol-relative URLs are handled really badly by parse_url(). It's so bad that the easiest
810 // way to handle them is to just prepend 'http:' and strip the protocol out later
811 $wasRelative = substr( $url, 0, 2 ) == '//';
812 if ( $wasRelative ) {
815 wfSuppressWarnings();
816 $bits = parse_url( $url );
818 // parse_url() returns an array without scheme for some invalid URLs, e.g.
819 // parse_url("%0Ahttp://example.com") == array( 'host' => '%0Ahttp', 'path' => 'example.com' )
820 if ( !$bits ||
!isset( $bits['scheme'] ) ) {
824 // parse_url() incorrectly handles schemes case-sensitively. Convert it to lowercase.
825 $bits['scheme'] = strtolower( $bits['scheme'] );
827 // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
828 if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
829 $bits['delimiter'] = '://';
830 } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
831 $bits['delimiter'] = ':';
832 // parse_url detects for news: and mailto: the host part of an url as path
833 // We have to correct this wrong detection
834 if ( isset( $bits['path'] ) ) {
835 $bits['host'] = $bits['path'];
842 /* Provide an empty host for eg. file:/// urls (see bug 28627) */
843 if ( !isset( $bits['host'] ) ) {
847 if ( isset( $bits['path'] ) ) {
848 /* parse_url loses the third / for file:///c:/ urls (but not on variants) */
849 if ( substr( $bits['path'], 0, 1 ) !== '/' ) {
850 $bits['path'] = '/' . $bits['path'];
857 // If the URL was protocol-relative, fix scheme and delimiter
858 if ( $wasRelative ) {
859 $bits['scheme'] = '';
860 $bits['delimiter'] = '//';
866 * Take a URL, make sure it's expanded to fully qualified, and replace any
867 * encoded non-ASCII Unicode characters with their UTF-8 original forms
868 * for more compact display and legibility for local audiences.
870 * @todo handle punycode domains too
875 function wfExpandIRI( $url ) {
876 return preg_replace_callback( '/((?:%[89A-F][0-9A-F])+)/i', 'wfExpandIRI_callback', wfExpandUrl( $url ) );
880 * Private callback for wfExpandIRI
881 * @param array $matches
884 function wfExpandIRI_callback( $matches ) {
885 return urldecode( $matches[1] );
891 * Make URL indexes, appropriate for the el_index field of externallinks.
896 function wfMakeUrlIndexes( $url ) {
897 $bits = wfParseUrl( $url );
899 // Reverse the labels in the hostname, convert to lower case
900 // For emails reverse domainpart only
901 if ( $bits['scheme'] == 'mailto' ) {
902 $mailparts = explode( '@', $bits['host'], 2 );
903 if ( count( $mailparts ) === 2 ) {
904 $domainpart = strtolower( implode( '.', array_reverse( explode( '.', $mailparts[1] ) ) ) );
906 // No domain specified, don't mangle it
909 $reversedHost = $domainpart . '@' . $mailparts[0];
911 $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) );
913 // Add an extra dot to the end
914 // Why? Is it in wrong place in mailto links?
915 if ( substr( $reversedHost, -1, 1 ) !== '.' ) {
916 $reversedHost .= '.';
918 // Reconstruct the pseudo-URL
919 $prot = $bits['scheme'];
920 $index = $prot . $bits['delimiter'] . $reversedHost;
921 // Leave out user and password. Add the port, path, query and fragment
922 if ( isset( $bits['port'] ) ) {
923 $index .= ':' . $bits['port'];
925 if ( isset( $bits['path'] ) ) {
926 $index .= $bits['path'];
930 if ( isset( $bits['query'] ) ) {
931 $index .= '?' . $bits['query'];
933 if ( isset( $bits['fragment'] ) ) {
934 $index .= '#' . $bits['fragment'];
938 return array( "http:$index", "https:$index" );
940 return array( $index );
945 * Check whether a given URL has a domain that occurs in a given set of domains
946 * @param $url string URL
947 * @param $domains array Array of domains (strings)
948 * @return bool True if the host part of $url ends in one of the strings in $domains
950 function wfMatchesDomainList( $url, $domains ) {
951 $bits = wfParseUrl( $url );
952 if ( is_array( $bits ) && isset( $bits['host'] ) ) {
953 foreach ( (array)$domains as $domain ) {
954 // FIXME: This gives false positives. http://nds-nl.wikipedia.org will match nl.wikipedia.org
955 // We should use something that interprets dots instead
956 if ( substr( $bits['host'], -strlen( $domain ) ) === $domain ) {
965 * Sends a line to the debug log if enabled or, optionally, to a comment in output.
966 * In normal operation this is a NOP.
968 * Controlling globals:
969 * $wgDebugLogFile - points to the log file
970 * $wgProfileOnly - if set, normal debug messages will not be recorded.
971 * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
972 * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
974 * @param $text String
975 * @param $logonly Bool: set true to avoid appearing in HTML when $wgDebugComments is set
977 function wfDebug( $text, $logonly = false ) {
978 global $wgDebugLogFile, $wgProfileOnly, $wgDebugRawPage, $wgDebugLogPrefix;
980 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
984 $timer = wfDebugTimer();
985 if ( $timer !== '' ) {
986 $text = preg_replace( '/[^\n]/', $timer . '\0', $text, 1 );
990 MWDebug
::debugMsg( $text );
993 if ( wfRunHooks( 'Debug', array( $text, null /* no log group */ ) ) ) {
994 if ( $wgDebugLogFile != '' && !$wgProfileOnly ) {
995 # Strip unprintables; they can switch terminal modes when binary data
996 # gets dumped, which is pretty annoying.
997 $text = preg_replace( '![\x00-\x08\x0b\x0c\x0e-\x1f]!', ' ', $text );
998 $text = $wgDebugLogPrefix . $text;
999 wfErrorLog( $text, $wgDebugLogFile );
1005 * Returns true if debug logging should be suppressed if $wgDebugRawPage = false
1008 function wfIsDebugRawPage() {
1010 if ( $cache !== null ) {
1013 # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
1014 if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
1016 isset( $_SERVER['SCRIPT_NAME'] )
1017 && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
1028 * Get microsecond timestamps for debug logs
1032 function wfDebugTimer() {
1033 global $wgDebugTimestamps, $wgRequestTime;
1035 if ( !$wgDebugTimestamps ) {
1039 $prefix = sprintf( "%6.4f", microtime( true ) - $wgRequestTime );
1040 $mem = sprintf( "%5.1fM", ( memory_get_usage( true ) / ( 1024 * 1024 ) ) );
1041 return "$prefix $mem ";
1045 * Send a line giving PHP memory usage.
1047 * @param $exact Bool: print exact values instead of kilobytes (default: false)
1049 function wfDebugMem( $exact = false ) {
1050 $mem = memory_get_usage();
1052 $mem = floor( $mem / 1024 ) . ' kilobytes';
1056 wfDebug( "Memory usage: $mem\n" );
1060 * Send a line to a supplementary debug log file, if configured, or main debug log if not.
1061 * $wgDebugLogGroups[$logGroup] should be set to a filename to send to a separate log.
1063 * @param $logGroup String
1064 * @param $text String
1065 * @param $public Bool: whether to log the event in the public log if no private
1066 * log file is specified, (default true)
1068 function wfDebugLog( $logGroup, $text, $public = true ) {
1069 global $wgDebugLogGroups;
1070 $text = trim( $text ) . "\n";
1071 if( isset( $wgDebugLogGroups[$logGroup] ) ) {
1072 $time = wfTimestamp( TS_DB
);
1074 $host = wfHostname();
1075 if ( wfRunHooks( 'Debug', array( $text, $logGroup ) ) ) {
1076 wfErrorLog( "$time $host $wiki: $text", $wgDebugLogGroups[$logGroup] );
1078 } elseif ( $public === true ) {
1079 wfDebug( "[$logGroup] $text", true );
1084 * Log for database errors
1086 * @param $text String: database error message.
1088 function wfLogDBError( $text ) {
1089 global $wgDBerrorLog, $wgDBerrorLogTZ;
1090 static $logDBErrorTimeZoneObject = null;
1092 if ( $wgDBerrorLog ) {
1093 $host = wfHostname();
1096 if ( $wgDBerrorLogTZ && !$logDBErrorTimeZoneObject ) {
1097 $logDBErrorTimeZoneObject = new DateTimeZone( $wgDBerrorLogTZ );
1100 // Workaround for https://bugs.php.net/bug.php?id=52063
1101 // Can be removed when min PHP > 5.3.2
1102 if ( $logDBErrorTimeZoneObject === null ) {
1103 $d = date_create( "now" );
1105 $d = date_create( "now", $logDBErrorTimeZoneObject );
1108 $date = $d->format( 'D M j G:i:s T Y' );
1110 $text = "$date\t$host\t$wiki\t$text";
1111 wfErrorLog( $text, $wgDBerrorLog );
1116 * Throws a warning that $function is deprecated
1118 * @param $function String
1119 * @param $version String|bool: Version of MediaWiki that the function was deprecated in (Added in 1.19).
1120 * @param $component String|bool: Added in 1.19.
1121 * @param $callerOffset integer: How far up the callstack is the original
1122 * caller. 2 = function that called the function that called
1123 * wfDeprecated (Added in 1.20)
1127 function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) {
1128 MWDebug
::deprecated( $function, $version, $component, $callerOffset +
1 );
1132 * Send a warning either to the debug log or in a PHP error depending on
1133 * $wgDevelopmentWarnings
1135 * @param $msg String: message to send
1136 * @param $callerOffset Integer: number of items to go back in the backtrace to
1137 * find the correct caller (1 = function calling wfWarn, ...)
1138 * @param $level Integer: PHP error level; only used when $wgDevelopmentWarnings
1141 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE
) {
1142 MWDebug
::warning( $msg, $callerOffset +
1, $level );
1146 * Log to a file without getting "file size exceeded" signals.
1148 * Can also log to TCP or UDP with the syntax udp://host:port/prefix. This will
1149 * send lines to the specified port, prefixed by the specified prefix and a space.
1151 * @param $text String
1152 * @param $file String filename
1153 * @throws MWException
1155 function wfErrorLog( $text, $file ) {
1156 if ( substr( $file, 0, 4 ) == 'udp:' ) {
1157 # Needs the sockets extension
1158 if ( preg_match( '!^(tcp|udp):(?://)?\[([0-9a-fA-F:]+)\]:(\d+)(?:/(.*))?$!', $file, $m ) ) {
1159 // IPv6 bracketed host
1161 $port = intval( $m[3] );
1162 $prefix = isset( $m[4] ) ?
$m[4] : false;
1164 } elseif ( preg_match( '!^(tcp|udp):(?://)?([a-zA-Z0-9.-]+):(\d+)(?:/(.*))?$!', $file, $m ) ) {
1166 if ( !IP
::isIPv4( $host ) ) {
1167 $host = gethostbyname( $host );
1169 $port = intval( $m[3] );
1170 $prefix = isset( $m[4] ) ?
$m[4] : false;
1173 throw new MWException( __METHOD__
. ': Invalid UDP specification' );
1176 // Clean it up for the multiplexer
1177 if ( strval( $prefix ) !== '' ) {
1178 $text = preg_replace( '/^/m', $prefix . ' ', $text );
1181 if ( strlen( $text ) > 65506 ) {
1182 $text = substr( $text, 0, 65506 );
1185 if ( substr( $text, -1 ) != "\n" ) {
1188 } elseif ( strlen( $text ) > 65507 ) {
1189 $text = substr( $text, 0, 65507 );
1192 $sock = socket_create( $domain, SOCK_DGRAM
, SOL_UDP
);
1197 socket_sendto( $sock, $text, strlen( $text ), 0, $host, $port );
1198 socket_close( $sock );
1200 wfSuppressWarnings();
1201 $exists = file_exists( $file );
1202 $size = $exists ?
filesize( $file ) : false;
1203 if ( !$exists ||
( $size !== false && $size +
strlen( $text ) < 0x7fffffff ) ) {
1204 file_put_contents( $file, $text, FILE_APPEND
);
1206 wfRestoreWarnings();
1213 function wfLogProfilingData() {
1214 global $wgRequestTime, $wgDebugLogFile, $wgDebugRawPage, $wgRequest;
1215 global $wgProfileLimit, $wgUser;
1217 $profiler = Profiler
::instance();
1219 # Profiling must actually be enabled...
1220 if ( $profiler->isStub() ) {
1224 // Get total page request time and only show pages that longer than
1225 // $wgProfileLimit time (default is 0)
1226 $elapsed = microtime( true ) - $wgRequestTime;
1227 if ( $elapsed <= $wgProfileLimit ) {
1231 $profiler->logData();
1233 // Check whether this should be logged in the debug file.
1234 if ( $wgDebugLogFile == '' ||
( !$wgDebugRawPage && wfIsDebugRawPage() ) ) {
1239 if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1240 $forward = ' forwarded for ' . $_SERVER['HTTP_X_FORWARDED_FOR'];
1242 if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1243 $forward .= ' client IP ' . $_SERVER['HTTP_CLIENT_IP'];
1245 if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1246 $forward .= ' from ' . $_SERVER['HTTP_FROM'];
1249 $forward = "\t(proxied via {$_SERVER['REMOTE_ADDR']}{$forward})";
1251 // Don't load $wgUser at this late stage just for statistics purposes
1252 // @todo FIXME: We can detect some anons even if it is not loaded. See User::getId()
1253 if ( $wgUser->isItemLoaded( 'id' ) && $wgUser->isAnon() ) {
1254 $forward .= ' anon';
1257 // Command line script uses a FauxRequest object which does not have
1258 // any knowledge about an URL and throw an exception instead.
1260 $requestUrl = $wgRequest->getRequestURL();
1261 } catch ( MWException
$e ) {
1262 $requestUrl = 'n/a';
1265 $log = sprintf( "%s\t%04.3f\t%s\n",
1266 gmdate( 'YmdHis' ), $elapsed,
1267 urldecode( $requestUrl . $forward ) );
1269 wfErrorLog( $log . $profiler->getOutput(), $wgDebugLogFile );
1273 * Increment a statistics counter
1275 * @param $key String
1279 function wfIncrStats( $key, $count = 1 ) {
1280 global $wgStatsMethod;
1282 $count = intval( $count );
1283 if ( $count == 0 ) {
1287 if( $wgStatsMethod == 'udp' ) {
1288 global $wgUDPProfilerHost, $wgUDPProfilerPort, $wgAggregateStatsID;
1291 $id = $wgAggregateStatsID !== false ?
$wgAggregateStatsID : wfWikiID();
1294 $socket = socket_create( AF_INET
, SOCK_DGRAM
, SOL_UDP
);
1295 $statline = "stats/{$id} - 1 1 1 1 1 -total\n";
1299 strlen( $statline ),
1305 $statline = "stats/{$id} - {$count} 1 1 1 1 {$key}\n";
1306 wfSuppressWarnings();
1310 strlen( $statline ),
1315 wfRestoreWarnings();
1316 } elseif( $wgStatsMethod == 'cache' ) {
1318 $key = wfMemcKey( 'stats', $key );
1319 if ( is_null( $wgMemc->incr( $key, $count ) ) ) {
1320 $wgMemc->add( $key, $count );
1328 * Check if the wiki read-only lock file is present. This can be used to lock
1329 * off editing functions, but doesn't guarantee that the database will not be
1334 function wfReadOnly() {
1335 global $wgReadOnlyFile, $wgReadOnly;
1337 if ( !is_null( $wgReadOnly ) ) {
1338 return (bool)$wgReadOnly;
1340 if ( $wgReadOnlyFile == '' ) {
1343 // Set $wgReadOnly for faster access next time
1344 if ( is_file( $wgReadOnlyFile ) ) {
1345 $wgReadOnly = file_get_contents( $wgReadOnlyFile );
1347 $wgReadOnly = false;
1349 return (bool)$wgReadOnly;
1355 function wfReadOnlyReason() {
1362 * Return a Language object from $langcode
1364 * @param $langcode Mixed: either:
1365 * - a Language object
1366 * - code of the language to get the message for, if it is
1367 * a valid code create a language for that language, if
1368 * it is a string but not a valid code then make a basic
1370 * - a boolean: if it's false then use the global object for
1371 * the current user's language (as a fallback for the old parameter
1372 * functionality), or if it is true then use global object
1373 * for the wiki's content language.
1374 * @return Language object
1376 function wfGetLangObj( $langcode = false ) {
1377 # Identify which language to get or create a language object for.
1378 # Using is_object here due to Stub objects.
1379 if( is_object( $langcode ) ) {
1380 # Great, we already have the object (hopefully)!
1384 global $wgContLang, $wgLanguageCode;
1385 if( $langcode === true ||
$langcode === $wgLanguageCode ) {
1386 # $langcode is the language code of the wikis content language object.
1387 # or it is a boolean and value is true
1392 if( $langcode === false ||
$langcode === $wgLang->getCode() ) {
1393 # $langcode is the language code of user language object.
1394 # or it was a boolean and value is false
1398 $validCodes = array_keys( Language
::fetchLanguageNames() );
1399 if( in_array( $langcode, $validCodes ) ) {
1400 # $langcode corresponds to a valid language.
1401 return Language
::factory( $langcode );
1404 # $langcode is a string, but not a valid language code; use content language.
1405 wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1410 * Old function when $wgBetterDirectionality existed
1411 * All usage removed, wfUILang can be removed in near future
1413 * @deprecated since 1.18
1416 function wfUILang() {
1417 wfDeprecated( __METHOD__
, '1.18' );
1423 * This is the function for getting translated interface messages.
1425 * @see Message class for documentation how to use them.
1426 * @see https://www.mediawiki.org/wiki/Manual:Messages_API
1428 * This function replaces all old wfMsg* functions.
1430 * @param $key \string Message key.
1431 * Varargs: normal message parameters.
1435 function wfMessage( $key /*...*/) {
1436 $params = func_get_args();
1437 array_shift( $params );
1438 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
1439 $params = $params[0];
1441 return new Message( $key, $params );
1445 * This function accepts multiple message keys and returns a message instance
1446 * for the first message which is non-empty. If all messages are empty then an
1447 * instance of the first message key is returned.
1448 * @param varargs: message keys
1452 function wfMessageFallback( /*...*/ ) {
1453 $args = func_get_args();
1454 return MWFunction
::callArray( 'Message::newFallbackSequence', $args );
1458 * Get a message from anywhere, for the current user language.
1460 * Use wfMsgForContent() instead if the message should NOT
1461 * change depending on the user preferences.
1463 * @deprecated since 1.18
1465 * @param $key String: lookup key for the message, usually
1466 * defined in languages/Language.php
1468 * Parameters to the message, which can be used to insert variable text into
1469 * it, can be passed to this function in the following formats:
1470 * - One per argument, starting at the second parameter
1471 * - As an array in the second parameter
1472 * These are not shown in the function definition.
1476 function wfMsg( $key ) {
1477 wfDeprecated( __METHOD__
, '1.21' );
1479 $args = func_get_args();
1480 array_shift( $args );
1481 return wfMsgReal( $key, $args );
1485 * Same as above except doesn't transform the message
1487 * @deprecated since 1.18
1489 * @param $key String
1492 function wfMsgNoTrans( $key ) {
1493 wfDeprecated( __METHOD__
, '1.21' );
1495 $args = func_get_args();
1496 array_shift( $args );
1497 return wfMsgReal( $key, $args, true, false, false );
1501 * Get a message from anywhere, for the current global language
1502 * set with $wgLanguageCode.
1504 * Use this if the message should NOT change dependent on the
1505 * language set in the user's preferences. This is the case for
1506 * most text written into logs, as well as link targets (such as
1507 * the name of the copyright policy page). Link titles, on the
1508 * other hand, should be shown in the UI language.
1510 * Note that MediaWiki allows users to change the user interface
1511 * language in their preferences, but a single installation
1512 * typically only contains content in one language.
1514 * Be wary of this distinction: If you use wfMsg() where you should
1515 * use wfMsgForContent(), a user of the software may have to
1516 * customize potentially hundreds of messages in
1517 * order to, e.g., fix a link in every possible language.
1519 * @deprecated since 1.18
1521 * @param $key String: lookup key for the message, usually
1522 * defined in languages/Language.php
1525 function wfMsgForContent( $key ) {
1526 wfDeprecated( __METHOD__
, '1.21' );
1528 global $wgForceUIMsgAsContentMsg;
1529 $args = func_get_args();
1530 array_shift( $args );
1532 if( is_array( $wgForceUIMsgAsContentMsg ) &&
1533 in_array( $key, $wgForceUIMsgAsContentMsg ) )
1535 $forcontent = false;
1537 return wfMsgReal( $key, $args, true, $forcontent );
1541 * Same as above except doesn't transform the message
1543 * @deprecated since 1.18
1545 * @param $key String
1548 function wfMsgForContentNoTrans( $key ) {
1549 wfDeprecated( __METHOD__
, '1.21' );
1551 global $wgForceUIMsgAsContentMsg;
1552 $args = func_get_args();
1553 array_shift( $args );
1555 if( is_array( $wgForceUIMsgAsContentMsg ) &&
1556 in_array( $key, $wgForceUIMsgAsContentMsg ) )
1558 $forcontent = false;
1560 return wfMsgReal( $key, $args, true, $forcontent, false );
1564 * Really get a message
1566 * @deprecated since 1.18
1568 * @param $key String: key to get.
1570 * @param $useDB Boolean
1571 * @param $forContent Mixed: Language code, or false for user lang, true for content lang.
1572 * @param $transform Boolean: Whether or not to transform the message.
1573 * @return String: the requested message.
1575 function wfMsgReal( $key, $args, $useDB = true, $forContent = false, $transform = true ) {
1576 wfDeprecated( __METHOD__
, '1.21' );
1578 wfProfileIn( __METHOD__
);
1579 $message = wfMsgGetKey( $key, $useDB, $forContent, $transform );
1580 $message = wfMsgReplaceArgs( $message, $args );
1581 wfProfileOut( __METHOD__
);
1586 * Fetch a message string value, but don't replace any keys yet.
1588 * @deprecated since 1.18
1590 * @param $key String
1591 * @param $useDB Bool
1592 * @param $langCode String: Code of the language to get the message for, or
1593 * behaves as a content language switch if it is a boolean.
1594 * @param $transform Boolean: whether to parse magic words, etc.
1597 function wfMsgGetKey( $key, $useDB = true, $langCode = false, $transform = true ) {
1598 wfDeprecated( __METHOD__
, '1.21' );
1600 wfRunHooks( 'NormalizeMessageKey', array( &$key, &$useDB, &$langCode, &$transform ) );
1602 $cache = MessageCache
::singleton();
1603 $message = $cache->get( $key, $useDB, $langCode );
1604 if( $message === false ) {
1605 $message = '<' . htmlspecialchars( $key ) . '>';
1606 } elseif ( $transform ) {
1607 $message = $cache->transform( $message );
1613 * Replace message parameter keys on the given formatted output.
1615 * @param $message String
1616 * @param $args Array
1620 function wfMsgReplaceArgs( $message, $args ) {
1621 # Fix windows line-endings
1622 # Some messages are split with explode("\n", $msg)
1623 $message = str_replace( "\r", '', $message );
1625 // Replace arguments
1626 if ( count( $args ) ) {
1627 if ( is_array( $args[0] ) ) {
1628 $args = array_values( $args[0] );
1630 $replacementKeys = array();
1631 foreach( $args as $n => $param ) {
1632 $replacementKeys['$' . ( $n +
1 )] = $param;
1634 $message = strtr( $message, $replacementKeys );
1641 * Return an HTML-escaped version of a message.
1642 * Parameter replacements, if any, are done *after* the HTML-escaping,
1643 * so parameters may contain HTML (eg links or form controls). Be sure
1644 * to pre-escape them if you really do want plaintext, or just wrap
1645 * the whole thing in htmlspecialchars().
1647 * @deprecated since 1.18
1649 * @param $key String
1650 * @param string ... parameters
1653 function wfMsgHtml( $key ) {
1654 wfDeprecated( __METHOD__
, '1.21' );
1656 $args = func_get_args();
1657 array_shift( $args );
1658 return wfMsgReplaceArgs( htmlspecialchars( wfMsgGetKey( $key ) ), $args );
1662 * Return an HTML version of message
1663 * Parameter replacements, if any, are done *after* parsing the wiki-text message,
1664 * so parameters may contain HTML (eg links or form controls). Be sure
1665 * to pre-escape them if you really do want plaintext, or just wrap
1666 * the whole thing in htmlspecialchars().
1668 * @deprecated since 1.18
1670 * @param $key String
1671 * @param string ... parameters
1674 function wfMsgWikiHtml( $key ) {
1675 wfDeprecated( __METHOD__
, '1.21' );
1677 $args = func_get_args();
1678 array_shift( $args );
1679 return wfMsgReplaceArgs(
1680 MessageCache
::singleton()->parse( wfMsgGetKey( $key ), null,
1681 /* can't be set to false */ true, /* interface */ true )->getText(),
1686 * Returns message in the requested format
1688 * @deprecated since 1.18
1690 * @param $key String: key of the message
1691 * @param $options Array: processing rules. Can take the following options:
1692 * <i>parse</i>: parses wikitext to HTML
1693 * <i>parseinline</i>: parses wikitext to HTML and removes the surrounding
1694 * p's added by parser or tidy
1695 * <i>escape</i>: filters message through htmlspecialchars
1696 * <i>escapenoentities</i>: same, but allows entity references like   through
1697 * <i>replaceafter</i>: parameters are substituted after parsing or escaping
1698 * <i>parsemag</i>: transform the message using magic phrases
1699 * <i>content</i>: fetch message for content language instead of interface
1700 * Also can accept a single associative argument, of the form 'language' => 'xx':
1701 * <i>language</i>: Language object or language code to fetch message for
1702 * (overriden by <i>content</i>).
1703 * Behavior for conflicting options (e.g., parse+parseinline) is undefined.
1707 function wfMsgExt( $key, $options ) {
1708 wfDeprecated( __METHOD__
, '1.21' );
1710 $args = func_get_args();
1711 array_shift( $args );
1712 array_shift( $args );
1713 $options = (array)$options;
1715 foreach( $options as $arrayKey => $option ) {
1716 if( !preg_match( '/^[0-9]+|language$/', $arrayKey ) ) {
1717 # An unknown index, neither numeric nor "language"
1718 wfWarn( "wfMsgExt called with incorrect parameter key $arrayKey", 1, E_USER_WARNING
);
1719 } elseif( preg_match( '/^[0-9]+$/', $arrayKey ) && !in_array( $option,
1720 array( 'parse', 'parseinline', 'escape', 'escapenoentities',
1721 'replaceafter', 'parsemag', 'content' ) ) ) {
1722 # A numeric index with unknown value
1723 wfWarn( "wfMsgExt called with incorrect parameter $option", 1, E_USER_WARNING
);
1727 if( in_array( 'content', $options, true ) ) {
1730 $langCodeObj = null;
1731 } elseif( array_key_exists( 'language', $options ) ) {
1732 $forContent = false;
1733 $langCode = wfGetLangObj( $options['language'] );
1734 $langCodeObj = $langCode;
1736 $forContent = false;
1738 $langCodeObj = null;
1741 $string = wfMsgGetKey( $key, /*DB*/true, $langCode, /*Transform*/false );
1743 if( !in_array( 'replaceafter', $options, true ) ) {
1744 $string = wfMsgReplaceArgs( $string, $args );
1747 $messageCache = MessageCache
::singleton();
1748 $parseInline = in_array( 'parseinline', $options, true );
1749 if( in_array( 'parse', $options, true ) ||
$parseInline ) {
1750 $string = $messageCache->parse( $string, null, true, !$forContent, $langCodeObj );
1751 if ( $string instanceof ParserOutput
) {
1752 $string = $string->getText();
1755 if ( $parseInline ) {
1757 if( preg_match( '/^<p>(.*)\n?<\/p>\n?$/sU', $string, $m ) ) {
1761 } elseif ( in_array( 'parsemag', $options, true ) ) {
1762 $string = $messageCache->transform( $string,
1763 !$forContent, $langCodeObj );
1766 if ( in_array( 'escape', $options, true ) ) {
1767 $string = htmlspecialchars ( $string );
1768 } elseif ( in_array( 'escapenoentities', $options, true ) ) {
1769 $string = Sanitizer
::escapeHtmlAllowEntities( $string );
1772 if( in_array( 'replaceafter', $options, true ) ) {
1773 $string = wfMsgReplaceArgs( $string, $args );
1780 * Since wfMsg() and co suck, they don't return false if the message key they
1781 * looked up didn't exist but a XHTML string, this function checks for the
1782 * nonexistance of messages by checking the MessageCache::get() result directly.
1784 * @deprecated since 1.18. Use Message::isDisabled().
1786 * @param $key String: the message key looked up
1787 * @return Boolean True if the message *doesn't* exist.
1789 function wfEmptyMsg( $key ) {
1790 wfDeprecated( __METHOD__
, '1.21' );
1792 return MessageCache
::singleton()->get( $key, /*useDB*/true, /*content*/false ) === false;
1796 * Throw a debugging exception. This function previously once exited the process,
1797 * but now throws an exception instead, with similar results.
1799 * @param $msg String: message shown when dying.
1800 * @throws MWException
1802 function wfDebugDieBacktrace( $msg = '' ) {
1803 throw new MWException( $msg );
1807 * Fetch server name for use in error reporting etc.
1808 * Use real server name if available, so we know which machine
1809 * in a server farm generated the current page.
1813 function wfHostname() {
1815 if ( is_null( $host ) ) {
1817 # Hostname overriding
1818 global $wgOverrideHostname;
1819 if( $wgOverrideHostname !== false ) {
1820 # Set static and skip any detection
1821 $host = $wgOverrideHostname;
1825 if ( function_exists( 'posix_uname' ) ) {
1826 // This function not present on Windows
1827 $uname = posix_uname();
1831 if( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1832 $host = $uname['nodename'];
1833 } elseif ( getenv( 'COMPUTERNAME' ) ) {
1834 # Windows computer name
1835 $host = getenv( 'COMPUTERNAME' );
1837 # This may be a virtual server.
1838 $host = $_SERVER['SERVER_NAME'];
1845 * Returns a HTML comment with the elapsed time since request.
1846 * This method has no side effects.
1850 function wfReportTime() {
1851 global $wgRequestTime, $wgShowHostnames;
1853 $elapsed = microtime( true ) - $wgRequestTime;
1855 return $wgShowHostnames
1856 ?
sprintf( '<!-- Served by %s in %01.3f secs. -->', wfHostname(), $elapsed )
1857 : sprintf( '<!-- Served in %01.3f secs. -->', $elapsed );
1861 * Safety wrapper for debug_backtrace().
1863 * With Zend Optimizer 3.2.0 loaded, this causes segfaults under somewhat
1864 * murky circumstances, which may be triggered in part by stub objects
1865 * or other fancy talkin'.
1867 * Will return an empty array if Zend Optimizer is detected or if
1868 * debug_backtrace is disabled, otherwise the output from
1869 * debug_backtrace() (trimmed).
1871 * @param $limit int This parameter can be used to limit the number of stack frames returned
1873 * @return array of backtrace information
1875 function wfDebugBacktrace( $limit = 0 ) {
1876 static $disabled = null;
1878 if( extension_loaded( 'Zend Optimizer' ) ) {
1879 wfDebug( "Zend Optimizer detected; skipping debug_backtrace for safety.\n" );
1883 if ( is_null( $disabled ) ) {
1885 $functions = explode( ',', ini_get( 'disable_functions' ) );
1886 $functions = array_map( 'trim', $functions );
1887 $functions = array_map( 'strtolower', $functions );
1888 if ( in_array( 'debug_backtrace', $functions ) ) {
1889 wfDebug( "debug_backtrace is in disabled_functions\n" );
1897 if ( $limit && version_compare( PHP_VERSION
, '5.4.0', '>=' ) ) {
1898 return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT
, $limit +
1 ), 1 );
1900 return array_slice( debug_backtrace(), 1 );
1905 * Get a debug backtrace as a string
1909 function wfBacktrace() {
1910 global $wgCommandLineMode;
1912 if ( $wgCommandLineMode ) {
1917 $backtrace = wfDebugBacktrace();
1918 foreach( $backtrace as $call ) {
1919 if( isset( $call['file'] ) ) {
1920 $f = explode( DIRECTORY_SEPARATOR
, $call['file'] );
1921 $file = $f[count( $f ) - 1];
1925 if( isset( $call['line'] ) ) {
1926 $line = $call['line'];
1930 if ( $wgCommandLineMode ) {
1931 $msg .= "$file line $line calls ";
1933 $msg .= '<li>' . $file . ' line ' . $line . ' calls ';
1935 if( !empty( $call['class'] ) ) {
1936 $msg .= $call['class'] . $call['type'];
1938 $msg .= $call['function'] . '()';
1940 if ( $wgCommandLineMode ) {
1946 if ( $wgCommandLineMode ) {
1956 * Get the name of the function which called this function
1957 * wfGetCaller( 1 ) is the function with the wfGetCaller() call (ie. __FUNCTION__)
1958 * wfGetCaller( 2 ) [default] is the caller of the function running wfGetCaller()
1959 * wfGetCaller( 3 ) is the parent of that.
1964 function wfGetCaller( $level = 2 ) {
1965 $backtrace = wfDebugBacktrace( $level +
1 );
1966 if ( isset( $backtrace[$level] ) ) {
1967 return wfFormatStackFrame( $backtrace[$level] );
1974 * Return a string consisting of callers in the stack. Useful sometimes
1975 * for profiling specific points.
1977 * @param $limit int The maximum depth of the stack frame to return, or false for
1981 function wfGetAllCallers( $limit = 3 ) {
1982 $trace = array_reverse( wfDebugBacktrace() );
1983 if ( !$limit ||
$limit > count( $trace ) - 1 ) {
1984 $limit = count( $trace ) - 1;
1986 $trace = array_slice( $trace, -$limit - 1, $limit );
1987 return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1991 * Return a string representation of frame
1993 * @param $frame Array
1996 function wfFormatStackFrame( $frame ) {
1997 return isset( $frame['class'] ) ?
1998 $frame['class'] . '::' . $frame['function'] :
2003 /* Some generic result counters, pulled out of SearchEngine */
2009 * @param $offset Int
2013 function wfShowingResults( $offset, $limit ) {
2014 return wfMessage( 'showingresults' )->numParams( $limit, $offset +
1 )->parse();
2018 * Generate (prev x| next x) (20|50|100...) type links for paging
2020 * @param $offset String
2021 * @param $limit Integer
2022 * @param $link String
2023 * @param $query String: optional URL query parameter string
2024 * @param $atend Bool: optional param for specified if this is the last page
2026 * @deprecated in 1.19; use Language::viewPrevNext() instead
2028 function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) {
2029 wfDeprecated( __METHOD__
, '1.19' );
2033 $query = wfCgiToArray( $query );
2035 if( is_object( $link ) ) {
2038 $title = Title
::newFromText( $link );
2039 if( is_null( $title ) ) {
2044 return $wgLang->viewPrevNext( $title, $offset, $limit, $query, $atend );
2048 * Make a list item, used by various special pages
2050 * @param $page String Page link
2051 * @param $details String Text between brackets
2052 * @param $oppositedm Boolean Add the direction mark opposite to your
2053 * language, to display text properly
2055 * @deprecated since 1.19; use Language::specialList() instead
2057 function wfSpecialList( $page, $details, $oppositedm = true ) {
2058 wfDeprecated( __METHOD__
, '1.19' );
2061 return $wgLang->specialList( $page, $details, $oppositedm );
2066 * @todo FIXME: We may want to blacklist some broken browsers
2068 * @param $force Bool
2069 * @return bool Whereas client accept gzip compression
2071 function wfClientAcceptsGzip( $force = false ) {
2072 static $result = null;
2073 if ( $result === null ||
$force ) {
2075 if( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
2076 # @todo FIXME: We may want to blacklist some broken browsers
2079 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
2080 $_SERVER['HTTP_ACCEPT_ENCODING'],
2084 if( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
2088 wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
2097 * Obtain the offset and limit values from the request string;
2098 * used in special pages
2100 * @param $deflimit Int default limit if none supplied
2101 * @param $optionname String Name of a user preference to check against
2105 function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
2107 return $wgRequest->getLimitOffset( $deflimit, $optionname );
2111 * Escapes the given text so that it may be output using addWikiText()
2112 * without any linking, formatting, etc. making its way through. This
2113 * is achieved by substituting certain characters with HTML entities.
2114 * As required by the callers, "<nowiki>" is not used.
2116 * @param $text String: text to be escaped
2119 function wfEscapeWikiText( $text ) {
2120 $text = strtr( "\n$text", array(
2121 '"' => '"', '&' => '&', "'" => ''', '<' => '<',
2122 '=' => '=', '>' => '>', '[' => '[', ']' => ']',
2123 '{' => '{', '|' => '|', '}' => '}',
2124 "\n#" => "\n#", "\n*" => "\n*",
2125 "\n:" => "\n:", "\n;" => "\n;",
2126 '://' => '://', 'ISBN ' => 'ISBN ', 'RFC ' => 'RFC ',
2128 return substr( $text, 1 );
2132 * Get the current unix timetstamp with microseconds. Useful for profiling
2136 return microtime( true );
2140 * Sets dest to source and returns the original value of dest
2141 * If source is NULL, it just returns the value, it doesn't set the variable
2142 * If force is true, it will set the value even if source is NULL
2144 * @param $dest Mixed
2145 * @param $source Mixed
2146 * @param $force Bool
2149 function wfSetVar( &$dest, $source, $force = false ) {
2151 if ( !is_null( $source ) ||
$force ) {
2158 * As for wfSetVar except setting a bit
2162 * @param $state Bool
2166 function wfSetBit( &$dest, $bit, $state = true ) {
2167 $temp = (bool)( $dest & $bit );
2168 if ( !is_null( $state ) ) {
2179 * A wrapper around the PHP function var_export().
2180 * Either print it or add it to the regular output ($wgOut).
2182 * @param $var mixed A PHP variable to dump.
2184 function wfVarDump( $var ) {
2186 $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
2187 if ( headers_sent() ||
!isset( $wgOut ) ||
!is_object( $wgOut ) ) {
2190 $wgOut->addHTML( $s );
2195 * Provide a simple HTTP error.
2197 * @param $code Int|String
2198 * @param $label String
2199 * @param $desc String
2201 function wfHttpError( $code, $label, $desc ) {
2204 header( "HTTP/1.0 $code $label" );
2205 header( "Status: $code $label" );
2206 $wgOut->sendCacheControl();
2208 header( 'Content-type: text/html; charset=utf-8' );
2209 print "<!doctype html>" .
2210 '<html><head><title>' .
2211 htmlspecialchars( $label ) .
2212 '</title></head><body><h1>' .
2213 htmlspecialchars( $label ) .
2215 nl2br( htmlspecialchars( $desc ) ) .
2216 "</p></body></html>\n";
2220 * Clear away any user-level output buffers, discarding contents.
2222 * Suitable for 'starting afresh', for instance when streaming
2223 * relatively large amounts of data without buffering, or wanting to
2224 * output image files without ob_gzhandler's compression.
2226 * The optional $resetGzipEncoding parameter controls suppression of
2227 * the Content-Encoding header sent by ob_gzhandler; by default it
2228 * is left. See comments for wfClearOutputBuffers() for why it would
2231 * Note that some PHP configuration options may add output buffer
2232 * layers which cannot be removed; these are left in place.
2234 * @param $resetGzipEncoding Bool
2236 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
2237 if( $resetGzipEncoding ) {
2238 // Suppress Content-Encoding and Content-Length
2239 // headers from 1.10+s wfOutputHandler
2240 global $wgDisableOutputCompression;
2241 $wgDisableOutputCompression = true;
2243 while( $status = ob_get_status() ) {
2244 if( $status['type'] == 0 /* PHP_OUTPUT_HANDLER_INTERNAL */ ) {
2245 // Probably from zlib.output_compression or other
2246 // PHP-internal setting which can't be removed.
2248 // Give up, and hope the result doesn't break
2252 if( !ob_end_clean() ) {
2253 // Could not remove output buffer handler; abort now
2254 // to avoid getting in some kind of infinite loop.
2257 if( $resetGzipEncoding ) {
2258 if( $status['name'] == 'ob_gzhandler' ) {
2259 // Reset the 'Content-Encoding' field set by this handler
2260 // so we can start fresh.
2261 header_remove( 'Content-Encoding' );
2269 * More legible than passing a 'false' parameter to wfResetOutputBuffers():
2271 * Clear away output buffers, but keep the Content-Encoding header
2272 * produced by ob_gzhandler, if any.
2274 * This should be used for HTTP 304 responses, where you need to
2275 * preserve the Content-Encoding header of the real result, but
2276 * also need to suppress the output of ob_gzhandler to keep to spec
2277 * and avoid breaking Firefox in rare cases where the headers and
2278 * body are broken over two packets.
2280 function wfClearOutputBuffers() {
2281 wfResetOutputBuffers( false );
2285 * Converts an Accept-* header into an array mapping string values to quality
2288 * @param $accept String
2289 * @param $def String default
2292 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
2293 # No arg means accept anything (per HTTP spec)
2295 return array( $def => 1.0 );
2300 $parts = explode( ',', $accept );
2302 foreach( $parts as $part ) {
2303 # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
2304 $values = explode( ';', trim( $part ) );
2306 if ( count( $values ) == 1 ) {
2307 $prefs[$values[0]] = 1.0;
2308 } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
2309 $prefs[$values[0]] = floatval( $match[1] );
2317 * Checks if a given MIME type matches any of the keys in the given
2318 * array. Basic wildcards are accepted in the array keys.
2320 * Returns the matching MIME type (or wildcard) if a match, otherwise
2323 * @param $type String
2324 * @param $avail Array
2328 function mimeTypeMatch( $type, $avail ) {
2329 if( array_key_exists( $type, $avail ) ) {
2332 $parts = explode( '/', $type );
2333 if( array_key_exists( $parts[0] . '/*', $avail ) ) {
2334 return $parts[0] . '/*';
2335 } elseif( array_key_exists( '*/*', $avail ) ) {
2344 * Returns the 'best' match between a client's requested internet media types
2345 * and the server's list of available types. Each list should be an associative
2346 * array of type to preference (preference is a float between 0.0 and 1.0).
2347 * Wildcards in the types are acceptable.
2349 * @param $cprefs Array: client's acceptable type list
2350 * @param $sprefs Array: server's offered types
2353 * @todo FIXME: Doesn't handle params like 'text/plain; charset=UTF-8'
2354 * XXX: generalize to negotiate other stuff
2356 function wfNegotiateType( $cprefs, $sprefs ) {
2359 foreach( array_keys( $sprefs ) as $type ) {
2360 $parts = explode( '/', $type );
2361 if( $parts[1] != '*' ) {
2362 $ckey = mimeTypeMatch( $type, $cprefs );
2364 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
2369 foreach( array_keys( $cprefs ) as $type ) {
2370 $parts = explode( '/', $type );
2371 if( $parts[1] != '*' && !array_key_exists( $type, $sprefs ) ) {
2372 $skey = mimeTypeMatch( $type, $sprefs );
2374 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
2382 foreach( array_keys( $combine ) as $type ) {
2383 if( $combine[$type] > $bestq ) {
2385 $bestq = $combine[$type];
2393 * Reference-counted warning suppression
2397 function wfSuppressWarnings( $end = false ) {
2398 static $suppressCount = 0;
2399 static $originalLevel = false;
2402 if ( $suppressCount ) {
2404 if ( !$suppressCount ) {
2405 error_reporting( $originalLevel );
2409 if ( !$suppressCount ) {
2410 $originalLevel = error_reporting( E_ALL
& ~
( E_WARNING | E_NOTICE | E_USER_WARNING | E_USER_NOTICE | E_DEPRECATED | E_USER_DEPRECATED | E_STRICT
) );
2417 * Restore error level to previous value
2419 function wfRestoreWarnings() {
2420 wfSuppressWarnings( true );
2423 # Autodetect, convert and provide timestamps of various types
2426 * Unix time - the number of seconds since 1970-01-01 00:00:00 UTC
2428 define( 'TS_UNIX', 0 );
2431 * MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
2433 define( 'TS_MW', 1 );
2436 * MySQL DATETIME (YYYY-MM-DD HH:MM:SS)
2438 define( 'TS_DB', 2 );
2441 * RFC 2822 format, for E-mail and HTTP headers
2443 define( 'TS_RFC2822', 3 );
2446 * ISO 8601 format with no timezone: 1986-02-09T20:00:00Z
2448 * This is used by Special:Export
2450 define( 'TS_ISO_8601', 4 );
2453 * An Exif timestamp (YYYY:MM:DD HH:MM:SS)
2455 * @see http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the
2456 * DateTime tag and page 36 for the DateTimeOriginal and
2457 * DateTimeDigitized tags.
2459 define( 'TS_EXIF', 5 );
2462 * Oracle format time.
2464 define( 'TS_ORACLE', 6 );
2467 * Postgres format time.
2469 define( 'TS_POSTGRES', 7 );
2474 define( 'TS_DB2', 8 );
2477 * ISO 8601 basic format with no timezone: 19860209T200000Z. This is used by ResourceLoader
2479 define( 'TS_ISO_8601_BASIC', 9 );
2482 * Get a timestamp string in one of various formats
2484 * @param $outputtype Mixed: A timestamp in one of the supported formats, the
2485 * function will autodetect which format is supplied and act
2487 * @param $ts Mixed: optional timestamp to convert, default 0 for the current time
2488 * @return Mixed: String / false The same date in the format specified in $outputtype or false
2490 function wfTimestamp( $outputtype = TS_UNIX
, $ts = 0 ) {
2492 $timestamp = new MWTimestamp( $ts );
2493 return $timestamp->getTimestamp( $outputtype );
2494 } catch( TimestampException
$e ) {
2495 wfDebug( "wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n" );
2501 * Return a formatted timestamp, or null if input is null.
2502 * For dealing with nullable timestamp columns in the database.
2504 * @param $outputtype Integer
2508 function wfTimestampOrNull( $outputtype = TS_UNIX
, $ts = null ) {
2509 if( is_null( $ts ) ) {
2512 return wfTimestamp( $outputtype, $ts );
2517 * Convenience function; returns MediaWiki timestamp for the present time.
2521 function wfTimestampNow() {
2523 return wfTimestamp( TS_MW
, time() );
2527 * Check if the operating system is Windows
2529 * @return Bool: true if it's Windows, False otherwise.
2531 function wfIsWindows() {
2532 static $isWindows = null;
2533 if ( $isWindows === null ) {
2534 $isWindows = substr( php_uname(), 0, 7 ) == 'Windows';
2540 * Check if we are running under HipHop
2544 function wfIsHipHop() {
2545 return function_exists( 'hphp_thread_set_warmup_enabled' );
2549 * Swap two variables
2554 function swap( &$x, &$y ) {
2561 * Tries to get the system directory for temporary files. First
2562 * $wgTmpDirectory is checked, and then the TMPDIR, TMP, and TEMP
2563 * environment variables are then checked in sequence, and if none are
2564 * set try sys_get_temp_dir().
2566 * NOTE: When possible, use instead the tmpfile() function to create
2567 * temporary files to avoid race conditions on file creation, etc.
2571 function wfTempDir() {
2572 global $wgTmpDirectory;
2574 if ( $wgTmpDirectory !== false ) {
2575 return $wgTmpDirectory;
2578 $tmpDir = array_map( "getenv", array( 'TMPDIR', 'TMP', 'TEMP' ) );
2580 foreach( $tmpDir as $tmp ) {
2581 if( $tmp && file_exists( $tmp ) && is_dir( $tmp ) && is_writable( $tmp ) ) {
2585 return sys_get_temp_dir();
2589 * Make directory, and make all parent directories if they don't exist
2591 * @param $dir String: full path to directory to create
2592 * @param $mode Integer: chmod value to use, default is $wgDirectoryMode
2593 * @param $caller String: optional caller param for debugging.
2594 * @throws MWException
2597 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2598 global $wgDirectoryMode;
2600 if ( FileBackend
::isStoragePath( $dir ) ) { // sanity
2601 throw new MWException( __FUNCTION__
. " given storage path '$dir'." );
2604 if ( !is_null( $caller ) ) {
2605 wfDebug( "$caller: called wfMkdirParents($dir)\n" );
2608 if( strval( $dir ) === '' ||
file_exists( $dir ) ) {
2612 $dir = str_replace( array( '\\', '/' ), DIRECTORY_SEPARATOR
, $dir );
2614 if ( is_null( $mode ) ) {
2615 $mode = $wgDirectoryMode;
2618 // Turn off the normal warning, we're doing our own below
2619 wfSuppressWarnings();
2620 $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2621 wfRestoreWarnings();
2624 // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2625 trigger_error( sprintf( "%s: failed to mkdir \"%s\" mode 0%o", __FUNCTION__
, $dir, $mode ),
2632 * Remove a directory and all its content.
2633 * Does not hide error.
2635 function wfRecursiveRemoveDir( $dir ) {
2636 wfDebug( __FUNCTION__
. "( $dir )\n" );
2637 // taken from http://de3.php.net/manual/en/function.rmdir.php#98622
2638 if ( is_dir( $dir ) ) {
2639 $objects = scandir( $dir );
2640 foreach ( $objects as $object ) {
2641 if ( $object != "." && $object != ".." ) {
2642 if ( filetype( $dir . '/' . $object ) == "dir" ) {
2643 wfRecursiveRemoveDir( $dir . '/' . $object );
2645 unlink( $dir . '/' . $object );
2655 * @param $nr Mixed: the number to format
2656 * @param $acc Integer: the number of digits after the decimal point, default 2
2657 * @param $round Boolean: whether or not to round the value, default true
2660 function wfPercent( $nr, $acc = 2, $round = true ) {
2661 $ret = sprintf( "%.${acc}f", $nr );
2662 return $round ?
round( $ret, $acc ) . '%' : "$ret%";
2666 * Find out whether or not a mixed variable exists in a string
2668 * @deprecated Just use str(i)pos
2669 * @param $needle String
2670 * @param $str String
2671 * @param $insensitive Boolean
2674 function in_string( $needle, $str, $insensitive = false ) {
2675 wfDeprecated( __METHOD__
, '1.21' );
2677 if( $insensitive ) $func = 'stripos';
2679 return $func( $str, $needle ) !== false;
2683 * Safety wrapper around ini_get() for boolean settings.
2684 * The values returned from ini_get() are pre-normalized for settings
2685 * set via php.ini or php_flag/php_admin_flag... but *not*
2686 * for those set via php_value/php_admin_value.
2688 * It's fairly common for people to use php_value instead of php_flag,
2689 * which can leave you with an 'off' setting giving a false positive
2690 * for code that just takes the ini_get() return value as a boolean.
2692 * To make things extra interesting, setting via php_value accepts
2693 * "true" and "yes" as true, but php.ini and php_flag consider them false. :)
2694 * Unrecognized values go false... again opposite PHP's own coercion
2695 * from string to bool.
2697 * Luckily, 'properly' set settings will always come back as '0' or '1',
2698 * so we only have to worry about them and the 'improper' settings.
2700 * I frickin' hate PHP... :P
2702 * @param $setting String
2705 function wfIniGetBool( $setting ) {
2706 $val = ini_get( $setting );
2707 // 'on' and 'true' can't have whitespace around them, but '1' can.
2708 return strtolower( $val ) == 'on'
2709 ||
strtolower( $val ) == 'true'
2710 ||
strtolower( $val ) == 'yes'
2711 ||
preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2715 * Wrapper function for PHP's dl(). This doesn't work in most situations from
2716 * PHP 5.3 onward, and is usually disabled in shared environments anyway.
2718 * @param $extension String A PHP extension. The file suffix (.so or .dll)
2720 * @param $fileName String Name of the library, if not $extension.suffix
2721 * @return Bool - Whether or not the extension is loaded
2723 function wfDl( $extension, $fileName = null ) {
2724 if( extension_loaded( $extension ) ) {
2729 if( PHP_SAPI
== 'cli' || PHP_SAPI
== 'cgi' || PHP_SAPI
== 'embed' ) {
2730 $canDl = ( function_exists( 'dl' ) && is_callable( 'dl' )
2731 && wfIniGetBool( 'enable_dl' ) && !wfIniGetBool( 'safe_mode' ) );
2735 $fileName = $fileName ?
$fileName : $extension;
2736 if( wfIsWindows() ) {
2737 $fileName = 'php_' . $fileName;
2739 wfSuppressWarnings();
2740 dl( $fileName . '.' . PHP_SHLIB_SUFFIX
);
2741 wfRestoreWarnings();
2743 return extension_loaded( $extension );
2747 * Windows-compatible version of escapeshellarg()
2748 * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
2749 * function puts single quotes in regardless of OS.
2751 * Also fixes the locale problems on Linux in PHP 5.2.6+ (bug backported to
2752 * earlier distro releases of PHP)
2757 function wfEscapeShellArg( ) {
2758 wfInitShellLocale();
2760 $args = func_get_args();
2763 foreach ( $args as $arg ) {
2770 if ( wfIsWindows() ) {
2771 // Escaping for an MSVC-style command line parser and CMD.EXE
2773 // * http://web.archive.org/web/20020708081031/http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
2774 // * http://technet.microsoft.com/en-us/library/cc723564.aspx
2777 // Double the backslashes before any double quotes. Escape the double quotes.
2778 $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE
);
2781 foreach ( $tokens as $token ) {
2782 if ( $iteration %
2 == 1 ) {
2783 // Delimiter, a double quote preceded by zero or more slashes
2784 $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
2785 } elseif ( $iteration %
4 == 2 ) {
2786 // ^ in $token will be outside quotes, need to be escaped
2787 $arg .= str_replace( '^', '^^', $token );
2788 } else { // $iteration % 4 == 0
2789 // ^ in $token will appear inside double quotes, so leave as is
2794 // Double the backslashes before the end of the string, because
2795 // we will soon add a quote
2797 if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
2798 $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
2801 // Add surrounding quotes
2802 $retVal .= '"' . $arg . '"';
2804 $retVal .= escapeshellarg( $arg );
2811 * Execute a shell command, with time and memory limits mirrored from the PHP
2812 * configuration if supported.
2813 * @param $cmd String Command line, properly escaped for shell.
2814 * @param &$retval null|Mixed optional, will receive the program's exit code.
2815 * (non-zero is usually failure)
2816 * @param $environ Array optional environment variables which should be
2817 * added to the executed command environment.
2818 * @param $limits Array optional array with limits(filesize, memory, time, walltime)
2819 * this overwrites the global wgShellMax* limits.
2820 * @return string collected stdout as a string (trailing newlines stripped)
2822 function wfShellExec( $cmd, &$retval = null, $environ = array(), $limits = array() ) {
2823 global $IP, $wgMaxShellMemory, $wgMaxShellFileSize, $wgMaxShellTime,
2824 $wgMaxShellWallClockTime, $wgShellCgroup;
2827 if ( is_null( $disabled ) ) {
2829 if( wfIniGetBool( 'safe_mode' ) ) {
2830 wfDebug( "wfShellExec can't run in safe_mode, PHP's exec functions are too broken.\n" );
2831 $disabled = 'safemode';
2833 $functions = explode( ',', ini_get( 'disable_functions' ) );
2834 $functions = array_map( 'trim', $functions );
2835 $functions = array_map( 'strtolower', $functions );
2836 if ( in_array( 'passthru', $functions ) ) {
2837 wfDebug( "passthru is in disabled_functions\n" );
2838 $disabled = 'passthru';
2844 return $disabled == 'safemode' ?
2845 'Unable to run external programs in safe mode.' :
2846 'Unable to run external programs, passthru() is disabled.';
2849 wfInitShellLocale();
2852 foreach( $environ as $k => $v ) {
2853 if ( wfIsWindows() ) {
2854 /* Surrounding a set in quotes (method used by wfEscapeShellArg) makes the quotes themselves
2855 * appear in the environment variable, so we must use carat escaping as documented in
2856 * http://technet.microsoft.com/en-us/library/cc723564.aspx
2857 * Note however that the quote isn't listed there, but is needed, and the parentheses
2858 * are listed there but doesn't appear to need it.
2860 $envcmd .= "set $k=" . preg_replace( '/([&|()<>^"])/', '^\\1', $v ) . '&& ';
2862 /* Assume this is a POSIX shell, thus required to accept variable assignments before the command
2863 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_09_01
2865 $envcmd .= "$k=" . escapeshellarg( $v ) . ' ';
2868 $cmd = $envcmd . $cmd;
2870 if ( php_uname( 's' ) == 'Linux' ) {
2871 $time = intval ( isset( $limits['time'] ) ?
$limits['time'] : $wgMaxShellTime );
2872 if ( isset( $limits['walltime'] ) ) {
2873 $wallTime = intval( $limits['walltime'] );
2874 } elseif ( isset( $limits['time'] ) ) {
2877 $wallTime = intval( $wgMaxShellWallClockTime );
2879 $mem = intval ( isset( $limits['memory'] ) ?
$limits['memory'] : $wgMaxShellMemory );
2880 $filesize = intval ( isset( $limits['filesize'] ) ?
$limits['filesize'] : $wgMaxShellFileSize );
2882 if ( $time > 0 ||
$mem > 0 ||
$filesize > 0 ||
$wallTime > 0 ) {
2883 $cmd = '/bin/bash ' . escapeshellarg( "$IP/includes/limit.sh" ) . ' ' .
2884 escapeshellarg( $cmd ) . ' ' .
2886 "MW_CPU_LIMIT=$time; " .
2887 'MW_CGROUP=' . escapeshellarg( $wgShellCgroup ) . '; ' .
2888 "MW_MEM_LIMIT=$mem; " .
2889 "MW_FILE_SIZE_LIMIT=$filesize; " .
2890 "MW_WALL_CLOCK_LIMIT=$wallTime"
2894 wfDebug( "wfShellExec: $cmd\n" );
2896 $retval = 1; // error by default?
2898 passthru( $cmd, $retval );
2899 $output = ob_get_contents();
2902 if ( $retval == 127 ) {
2903 wfDebugLog( 'exec', "Possibly missing executable file: $cmd\n" );
2909 * Workaround for http://bugs.php.net/bug.php?id=45132
2910 * escapeshellarg() destroys non-ASCII characters if LANG is not a UTF-8 locale
2912 function wfInitShellLocale() {
2913 static $done = false;
2918 global $wgShellLocale;
2919 if ( !wfIniGetBool( 'safe_mode' ) ) {
2920 putenv( "LC_CTYPE=$wgShellLocale" );
2921 setlocale( LC_CTYPE
, $wgShellLocale );
2926 * Alias to wfShellWikiCmd()
2927 * @see wfShellWikiCmd()
2929 function wfShellMaintenanceCmd( $script, array $parameters = array(), array $options = array() ) {
2930 return wfShellWikiCmd( $script, $parameters, $options );
2934 * Generate a shell-escaped command line string to run a MediaWiki cli script.
2935 * Note that $parameters should be a flat array and an option with an argument
2936 * should consist of two consecutive items in the array (do not use "--option value").
2937 * @param $script string MediaWiki cli script path
2938 * @param $parameters Array Arguments and options to the script
2939 * @param $options Array Associative array of options:
2940 * 'php': The path to the php executable
2941 * 'wrapper': Path to a PHP wrapper to handle the maintenance script
2944 function wfShellWikiCmd( $script, array $parameters = array(), array $options = array() ) {
2946 // Give site config file a chance to run the script in a wrapper.
2947 // The caller may likely want to call wfBasename() on $script.
2948 wfRunHooks( 'wfShellWikiCmd', array( &$script, &$parameters, &$options ) );
2949 $cmd = isset( $options['php'] ) ?
array( $options['php'] ) : array( $wgPhpCli );
2950 if ( isset( $options['wrapper'] ) ) {
2951 $cmd[] = $options['wrapper'];
2954 // Escape each parameter for shell
2955 return implode( " ", array_map( 'wfEscapeShellArg', array_merge( $cmd, $parameters ) ) );
2959 * wfMerge attempts to merge differences between three texts.
2960 * Returns true for a clean merge and false for failure or a conflict.
2962 * @param $old String
2963 * @param $mine String
2964 * @param $yours String
2965 * @param $result String
2968 function wfMerge( $old, $mine, $yours, &$result ) {
2971 # This check may also protect against code injection in
2972 # case of broken installations.
2973 wfSuppressWarnings();
2974 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
2975 wfRestoreWarnings();
2978 wfDebug( "diff3 not found\n" );
2982 # Make temporary files
2984 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2985 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
2986 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
2988 # NOTE: diff3 issues a warning to stderr if any of the files does not end with
2989 # a newline character. To avoid this, we normalize the trailing whitespace before
2990 # creating the diff.
2992 fwrite( $oldtextFile, rtrim( $old ) . "\n" );
2993 fclose( $oldtextFile );
2994 fwrite( $mytextFile, rtrim( $mine ) . "\n" );
2995 fclose( $mytextFile );
2996 fwrite( $yourtextFile, rtrim( $yours ) . "\n" );
2997 fclose( $yourtextFile );
2999 # Check for a conflict
3000 $cmd = wfEscapeShellArg( $wgDiff3 ) . ' -a --overlap-only ' .
3001 wfEscapeShellArg( $mytextName ) . ' ' .
3002 wfEscapeShellArg( $oldtextName ) . ' ' .
3003 wfEscapeShellArg( $yourtextName );
3004 $handle = popen( $cmd, 'r' );
3006 if( fgets( $handle, 1024 ) ) {
3014 $cmd = wfEscapeShellArg( $wgDiff3 ) . ' -a -e --merge ' .
3015 wfEscapeShellArg( $mytextName, $oldtextName, $yourtextName );
3016 $handle = popen( $cmd, 'r' );
3019 $data = fread( $handle, 8192 );
3020 if ( strlen( $data ) == 0 ) {
3026 unlink( $mytextName );
3027 unlink( $oldtextName );
3028 unlink( $yourtextName );
3030 if ( $result === '' && $old !== '' && !$conflict ) {
3031 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
3038 * Returns unified plain-text diff of two texts.
3039 * Useful for machine processing of diffs.
3041 * @param $before String: the text before the changes.
3042 * @param $after String: the text after the changes.
3043 * @param $params String: command-line options for the diff command.
3044 * @return String: unified diff of $before and $after
3046 function wfDiff( $before, $after, $params = '-u' ) {
3047 if ( $before == $after ) {
3052 wfSuppressWarnings();
3053 $haveDiff = $wgDiff && file_exists( $wgDiff );
3054 wfRestoreWarnings();
3056 # This check may also protect against code injection in
3057 # case of broken installations.
3059 wfDebug( "diff executable not found\n" );
3060 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
3061 $format = new UnifiedDiffFormatter();
3062 return $format->format( $diffs );
3065 # Make temporary files
3067 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
3068 $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
3070 fwrite( $oldtextFile, $before );
3071 fclose( $oldtextFile );
3072 fwrite( $newtextFile, $after );
3073 fclose( $newtextFile );
3075 // Get the diff of the two files
3076 $cmd = "$wgDiff " . $params . ' ' . wfEscapeShellArg( $oldtextName, $newtextName );
3078 $h = popen( $cmd, 'r' );
3083 $data = fread( $h, 8192 );
3084 if ( strlen( $data ) == 0 ) {
3092 unlink( $oldtextName );
3093 unlink( $newtextName );
3095 // Kill the --- and +++ lines. They're not useful.
3096 $diff_lines = explode( "\n", $diff );
3097 if ( strpos( $diff_lines[0], '---' ) === 0 ) {
3098 unset( $diff_lines[0] );
3100 if ( strpos( $diff_lines[1], '+++' ) === 0 ) {
3101 unset( $diff_lines[1] );
3104 $diff = implode( "\n", $diff_lines );
3110 * This function works like "use VERSION" in Perl, the program will die with a
3111 * backtrace if the current version of PHP is less than the version provided
3113 * This is useful for extensions which due to their nature are not kept in sync
3114 * with releases, and might depend on other versions of PHP than the main code
3116 * Note: PHP might die due to parsing errors in some cases before it ever
3117 * manages to call this function, such is life
3119 * @see perldoc -f use
3121 * @param $req_ver Mixed: the version to check, can be a string, an integer, or
3123 * @throws MWException
3125 function wfUsePHP( $req_ver ) {
3126 $php_ver = PHP_VERSION
;
3128 if ( version_compare( $php_ver, (string)$req_ver, '<' ) ) {
3129 throw new MWException( "PHP $req_ver required--this is only $php_ver" );
3134 * This function works like "use VERSION" in Perl except it checks the version
3135 * of MediaWiki, the program will die with a backtrace if the current version
3136 * of MediaWiki is less than the version provided.
3138 * This is useful for extensions which due to their nature are not kept in sync
3141 * @see perldoc -f use
3143 * @param $req_ver Mixed: the version to check, can be a string, an integer, or
3145 * @throws MWException
3147 function wfUseMW( $req_ver ) {
3150 if ( version_compare( $wgVersion, (string)$req_ver, '<' ) ) {
3151 throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
3156 * Return the final portion of a pathname.
3157 * Reimplemented because PHP5's "basename()" is buggy with multibyte text.
3158 * http://bugs.php.net/bug.php?id=33898
3160 * PHP's basename() only considers '\' a pathchar on Windows and Netware.
3161 * We'll consider it so always, as we don't want '\s' in our Unix paths either.
3163 * @param $path String
3164 * @param $suffix String: to remove if present
3167 function wfBaseName( $path, $suffix = '' ) {
3168 $encSuffix = ( $suffix == '' )
3170 : ( '(?:' . preg_quote( $suffix, '#' ) . ')?' );
3172 if( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
3180 * Generate a relative path name to the given file.
3181 * May explode on non-matching case-insensitive paths,
3182 * funky symlinks, etc.
3184 * @param $path String: absolute destination path including target filename
3185 * @param $from String: Absolute source path, directory only
3188 function wfRelativePath( $path, $from ) {
3189 // Normalize mixed input on Windows...
3190 $path = str_replace( '/', DIRECTORY_SEPARATOR
, $path );
3191 $from = str_replace( '/', DIRECTORY_SEPARATOR
, $from );
3193 // Trim trailing slashes -- fix for drive root
3194 $path = rtrim( $path, DIRECTORY_SEPARATOR
);
3195 $from = rtrim( $from, DIRECTORY_SEPARATOR
);
3197 $pieces = explode( DIRECTORY_SEPARATOR
, dirname( $path ) );
3198 $against = explode( DIRECTORY_SEPARATOR
, $from );
3200 if( $pieces[0] !== $against[0] ) {
3201 // Non-matching Windows drive letters?
3202 // Return a full path.
3206 // Trim off common prefix
3207 while( count( $pieces ) && count( $against )
3208 && $pieces[0] == $against[0] ) {
3209 array_shift( $pieces );
3210 array_shift( $against );
3213 // relative dots to bump us to the parent
3214 while( count( $against ) ) {
3215 array_unshift( $pieces, '..' );
3216 array_shift( $against );
3219 array_push( $pieces, wfBaseName( $path ) );
3221 return implode( DIRECTORY_SEPARATOR
, $pieces );
3225 * Do any deferred updates and clear the list
3227 * @deprecated since 1.19
3228 * @see DeferredUpdates::doUpdate()
3229 * @param $commit string
3231 function wfDoUpdates( $commit = '' ) {
3232 wfDeprecated( __METHOD__
, '1.19' );
3233 DeferredUpdates
::doUpdates( $commit );
3237 * Convert an arbitrarily-long digit string from one numeric base
3238 * to another, optionally zero-padding to a minimum column width.
3240 * Supports base 2 through 36; digit values 10-36 are represented
3241 * as lowercase letters a-z. Input is case-insensitive.
3243 * @param string $input Input number
3244 * @param int $sourceBase Base of the input number
3245 * @param int $destBase Desired base of the output
3246 * @param int $pad Minimum number of digits in the output (pad with zeroes)
3247 * @param bool $lowercase Whether to output in lowercase or uppercase
3248 * @param string $engine Either "gmp", "bcmath", or "php"
3249 * @return string|bool The output number as a string, or false on error
3251 function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1, $lowercase = true, $engine = 'auto' ) {
3252 $input = (string)$input;
3258 $sourceBase != (int) $sourceBase ||
3259 $destBase != (int) $destBase ||
3260 $pad != (int) $pad ||
3261 !preg_match( "/^[" . substr( '0123456789abcdefghijklmnopqrstuvwxyz', 0, $sourceBase ) . "]+$/i", $input )
3266 static $baseChars = array (
3267 10 => 'a', 11 => 'b', 12 => 'c', 13 => 'd', 14 => 'e', 15 => 'f',
3268 16 => 'g', 17 => 'h', 18 => 'i', 19 => 'j', 20 => 'k', 21 => 'l',
3269 22 => 'm', 23 => 'n', 24 => 'o', 25 => 'p', 26 => 'q', 27 => 'r',
3270 28 => 's', 29 => 't', 30 => 'u', 31 => 'v', 32 => 'w', 33 => 'x',
3271 34 => 'y', 35 => 'z',
3273 '0' => 0, '1' => 1, '2' => 2, '3' => 3, '4' => 4, '5' => 5,
3274 '6' => 6, '7' => 7, '8' => 8, '9' => 9, 'a' => 10, 'b' => 11,
3275 'c' => 12, 'd' => 13, 'e' => 14, 'f' => 15, 'g' => 16, 'h' => 17,
3276 'i' => 18, 'j' => 19, 'k' => 20, 'l' => 21, 'm' => 22, 'n' => 23,
3277 'o' => 24, 'p' => 25, 'q' => 26, 'r' => 27, 's' => 28, 't' => 29,
3278 'u' => 30, 'v' => 31, 'w' => 32, 'x' => 33, 'y' => 34, 'z' => 35
3281 if( extension_loaded( 'gmp' ) && ( $engine == 'auto' ||
$engine == 'gmp' ) ) {
3282 $result = gmp_strval( gmp_init( $input, $sourceBase ), $destBase );
3283 } elseif( extension_loaded( 'bcmath' ) && ( $engine == 'auto' ||
$engine == 'bcmath' ) ) {
3285 foreach( str_split( strtolower( $input ) ) as $char ) {
3286 $decimal = bcmul( $decimal, $sourceBase );
3287 $decimal = bcadd( $decimal, $baseChars[$char] );
3290 for( $result = ''; bccomp( $decimal, 0 ); $decimal = bcdiv( $decimal, $destBase, 0 ) ) {
3291 $result .= $baseChars[bcmod( $decimal, $destBase )];
3294 $result = strrev( $result );
3296 $inDigits = array();
3297 foreach( str_split( strtolower( $input ) ) as $char ) {
3298 $inDigits[] = $baseChars[$char];
3301 // Iterate over the input, modulo-ing out an output digit
3302 // at a time until input is gone.
3304 while( $inDigits ) {
3306 $workDigits = array();
3309 foreach( $inDigits as $digit ) {
3310 $work *= $sourceBase;
3313 if( $workDigits ||
$work >= $destBase ) {
3314 $workDigits[] = (int) ( $work / $destBase );
3319 // All that division leaves us with a remainder,
3320 // which is conveniently our next output digit.
3321 $result .= $baseChars[$work];
3324 $inDigits = $workDigits;
3327 $result = strrev( $result );
3331 $result = strtoupper( $result );
3334 return str_pad( $result, $pad, '0', STR_PAD_LEFT
);
3338 * Create an object with a given name and an array of construct parameters
3340 * @param $name String
3341 * @param $p Array: parameters
3343 * @deprecated since 1.18, warnings in 1.18, removal in 1.20
3345 function wfCreateObject( $name, $p ) {
3346 wfDeprecated( __FUNCTION__
, '1.18' );
3347 return MWFunction
::newObj( $name, $p );
3353 function wfHttpOnlySafe() {
3354 global $wgHttpOnlyBlacklist;
3356 if( isset( $_SERVER['HTTP_USER_AGENT'] ) ) {
3357 foreach( $wgHttpOnlyBlacklist as $regex ) {
3358 if( preg_match( $regex, $_SERVER['HTTP_USER_AGENT'] ) ) {
3368 * Check if there is sufficent entropy in php's built-in session generation
3369 * @return bool true = there is sufficient entropy
3371 function wfCheckEntropy() {
3373 ( wfIsWindows() && version_compare( PHP_VERSION
, '5.3.3', '>=' ) )
3374 ||
ini_get( 'session.entropy_file' )
3376 && intval( ini_get( 'session.entropy_length' ) ) >= 32;
3380 * Override session_id before session startup if php's built-in
3381 * session generation code is not secure.
3383 function wfFixSessionID() {
3384 // If the cookie or session id is already set we already have a session and should abort
3385 if ( isset( $_COOKIE[ session_name() ] ) ||
session_id() ) {
3389 // PHP's built-in session entropy is enabled if:
3390 // - entropy_file is set or you're on Windows with php 5.3.3+
3391 // - AND entropy_length is > 0
3392 // We treat it as disabled if it doesn't have an entropy length of at least 32
3393 $entropyEnabled = wfCheckEntropy();
3395 // If built-in entropy is not enabled or not sufficient override php's built in session id generation code
3396 if ( !$entropyEnabled ) {
3397 wfDebug( __METHOD__
. ": PHP's built in entropy is disabled or not sufficient, overriding session id generation using our cryptrand source.\n" );
3398 session_id( MWCryptRand
::generateHex( 32 ) );
3403 * Initialise php session
3405 * @param $sessionId Bool
3407 function wfSetupSession( $sessionId = false ) {
3408 global $wgSessionsInMemcached, $wgSessionsInObjectCache, $wgCookiePath, $wgCookieDomain,
3409 $wgCookieSecure, $wgCookieHttpOnly, $wgSessionHandler;
3410 if( $wgSessionsInObjectCache ||
$wgSessionsInMemcached ) {
3411 ObjectCacheSessionHandler
::install();
3412 } elseif( $wgSessionHandler && $wgSessionHandler != ini_get( 'session.save_handler' ) ) {
3413 # Only set this if $wgSessionHandler isn't null and session.save_handler
3414 # hasn't already been set to the desired value (that causes errors)
3415 ini_set( 'session.save_handler', $wgSessionHandler );
3417 $httpOnlySafe = wfHttpOnlySafe() && $wgCookieHttpOnly;
3418 wfDebugLog( 'cookie',
3419 'session_set_cookie_params: "' . implode( '", "',
3425 $httpOnlySafe ) ) . '"' );
3426 session_set_cookie_params( 0, $wgCookiePath, $wgCookieDomain, $wgCookieSecure, $httpOnlySafe );
3427 session_cache_limiter( 'private, must-revalidate' );
3429 session_id( $sessionId );
3433 wfSuppressWarnings();
3435 wfRestoreWarnings();
3439 * Get an object from the precompiled serialized directory
3441 * @param $name String
3442 * @return Mixed: the variable on success, false on failure
3444 function wfGetPrecompiledData( $name ) {
3447 $file = "$IP/serialized/$name";
3448 if ( file_exists( $file ) ) {
3449 $blob = file_get_contents( $file );
3451 return unserialize( $blob );
3463 function wfMemcKey( /*... */ ) {
3464 global $wgCachePrefix;
3465 $prefix = $wgCachePrefix === false ?
wfWikiID() : $wgCachePrefix;
3466 $args = func_get_args();
3467 $key = $prefix . ':' . implode( ':', $args );
3468 $key = str_replace( ' ', '_', $key );
3473 * Get a cache key for a foreign DB
3476 * @param $prefix String
3477 * @param varargs String
3480 function wfForeignMemcKey( $db, $prefix /*, ... */ ) {
3481 $args = array_slice( func_get_args(), 2 );
3483 $key = "$db-$prefix:" . implode( ':', $args );
3485 $key = $db . ':' . implode( ':', $args );
3491 * Get an ASCII string identifying this wiki
3492 * This is used as a prefix in memcached keys
3496 function wfWikiID() {
3497 global $wgDBprefix, $wgDBname;
3498 if ( $wgDBprefix ) {
3499 return "$wgDBname-$wgDBprefix";
3506 * Split a wiki ID into DB name and table prefix
3508 * @param $wiki String
3512 function wfSplitWikiID( $wiki ) {
3513 $bits = explode( '-', $wiki, 2 );
3514 if ( count( $bits ) < 2 ) {
3521 * Get a Database object.
3523 * @param $db Integer: index of the connection to get. May be DB_MASTER for the
3524 * master (for write queries), DB_SLAVE for potentially lagged read
3525 * queries, or an integer >= 0 for a particular server.
3527 * @param $groups Mixed: query groups. An array of group names that this query
3528 * belongs to. May contain a single string if the query is only
3531 * @param $wiki String: the wiki ID, or false for the current wiki
3533 * Note: multiple calls to wfGetDB(DB_SLAVE) during the course of one request
3534 * will always return the same object, unless the underlying connection or load
3535 * balancer is manually destroyed.
3537 * Note 2: use $this->getDB() in maintenance scripts that may be invoked by
3538 * updater to ensure that a proper database is being updated.
3540 * @return DatabaseBase
3542 function &wfGetDB( $db, $groups = array(), $wiki = false ) {
3543 return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
3547 * Get a load balancer object.
3549 * @param $wiki String: wiki ID, or false for the current wiki
3550 * @return LoadBalancer
3552 function wfGetLB( $wiki = false ) {
3553 return wfGetLBFactory()->getMainLB( $wiki );
3557 * Get the load balancer factory object
3561 function &wfGetLBFactory() {
3562 return LBFactory
::singleton();
3567 * Shortcut for RepoGroup::singleton()->findFile()
3569 * @param $title String or Title object
3570 * @param $options array Associative array of options:
3571 * time: requested time for an archived image, or false for the
3572 * current version. An image object will be returned which was
3573 * created at the specified time.
3575 * ignoreRedirect: If true, do not follow file redirects
3577 * private: If true, return restricted (deleted) files if the current
3578 * user is allowed to view them. Otherwise, such files will not
3581 * bypassCache: If true, do not use the process-local cache of File objects
3583 * @return File, or false if the file does not exist
3585 function wfFindFile( $title, $options = array() ) {
3586 return RepoGroup
::singleton()->findFile( $title, $options );
3590 * Get an object referring to a locally registered file.
3591 * Returns a valid placeholder object if the file does not exist.
3593 * @param $title Title|String
3594 * @return LocalFile|null A File, or null if passed an invalid Title
3596 function wfLocalFile( $title ) {
3597 return RepoGroup
::singleton()->getLocalRepo()->newFile( $title );
3601 * Stream a file to the browser. Back-compat alias for StreamFile::stream()
3602 * @deprecated since 1.19
3604 function wfStreamFile( $fname, $headers = array() ) {
3605 wfDeprecated( __FUNCTION__
, '1.19' );
3606 StreamFile
::stream( $fname, $headers );
3610 * Should low-performance queries be disabled?
3613 * @codeCoverageIgnore
3615 function wfQueriesMustScale() {
3616 global $wgMiserMode;
3618 ||
( SiteStats
::pages() > 100000
3619 && SiteStats
::edits() > 1000000
3620 && SiteStats
::users() > 10000 );
3624 * Get the path to a specified script file, respecting file
3625 * extensions; this is a wrapper around $wgScriptExtension etc.
3626 * except for 'index' and 'load' which use $wgScript/$wgLoadScript
3628 * @param $script String: script filename, sans extension
3631 function wfScript( $script = 'index' ) {
3632 global $wgScriptPath, $wgScriptExtension, $wgScript, $wgLoadScript;
3633 if ( $script === 'index' ) {
3635 } else if ( $script === 'load' ) {
3636 return $wgLoadScript;
3638 return "{$wgScriptPath}/{$script}{$wgScriptExtension}";
3643 * Get the script URL.
3645 * @return string script URL
3647 function wfGetScriptUrl() {
3648 if( isset( $_SERVER['SCRIPT_NAME'] ) ) {
3650 # as it was called, minus the query string.
3652 # Some sites use Apache rewrite rules to handle subdomains,
3653 # and have PHP set up in a weird way that causes PHP_SELF
3654 # to contain the rewritten URL instead of the one that the
3655 # outside world sees.
3657 # If in this mode, use SCRIPT_URL instead, which mod_rewrite
3658 # provides containing the "before" URL.
3659 return $_SERVER['SCRIPT_NAME'];
3661 return $_SERVER['URL'];
3666 * Convenience function converts boolean values into "true"
3667 * or "false" (string) values
3669 * @param $value Boolean
3672 function wfBoolToStr( $value ) {
3673 return $value ?
'true' : 'false';
3677 * Get a platform-independent path to the null file, e.g. /dev/null
3681 function wfGetNull() {
3682 return wfIsWindows()
3688 * Modern version of wfWaitForSlaves(). Instead of looking at replication lag
3689 * and waiting for it to go down, this waits for the slaves to catch up to the
3690 * master position. Use this when updating very large numbers of rows, as
3691 * in maintenance scripts, to avoid causing too much lag. Of course, this is
3692 * a no-op if there are no slaves.
3694 * @param $maxLag Integer (deprecated)
3695 * @param $wiki mixed Wiki identifier accepted by wfGetLB
3697 function wfWaitForSlaves( $maxLag = false, $wiki = false ) {
3698 $lb = wfGetLB( $wiki );
3699 // bug 27975 - Don't try to wait for slaves if there are none
3700 // Prevents permission error when getting master position
3701 if ( $lb->getServerCount() > 1 ) {
3702 $dbw = $lb->getConnection( DB_MASTER
);
3703 $pos = $dbw->getMasterPos();
3704 $lb->waitForAll( $pos );
3709 * Used to be used for outputting text in the installer/updater
3710 * @deprecated since 1.18, warnings in 1.18, remove in 1.20
3712 function wfOut( $s ) {
3713 wfDeprecated( __FUNCTION__
, '1.18' );
3714 global $wgCommandLineMode;
3715 if ( $wgCommandLineMode ) {
3718 echo htmlspecialchars( $s );
3724 * Count down from $n to zero on the terminal, with a one-second pause
3725 * between showing each number. For use in command-line scripts.
3726 * @codeCoverageIgnore
3729 function wfCountDown( $n ) {
3730 for ( $i = $n; $i >= 0; $i-- ) {
3732 echo str_repeat( "\x08", strlen( $i +
1 ) );
3744 * Generate a random 32-character hexadecimal token.
3745 * @param $salt Mixed: some sort of salt, if necessary, to add to random
3746 * characters before hashing.
3748 * @codeCoverageIgnore
3749 * @deprecated since 1.20; Please use MWCryptRand for security purposes and wfRandomString for pesudo-random strings
3750 * @warning This method is NOT secure. Additionally it has many callers that use it for pesudo-random purposes.
3752 function wfGenerateToken( $salt = '' ) {
3753 wfDeprecated( __METHOD__
, '1.20' );
3754 $salt = serialize( $salt );
3755 return md5( mt_rand( 0, 0x7fffffff ) . $salt );
3759 * Replace all invalid characters with -
3760 * Additional characters can be defined in $wgIllegalFileChars (see bug 20489)
3761 * By default, $wgIllegalFileChars = ':'
3763 * @param $name Mixed: filename to process
3766 function wfStripIllegalFilenameChars( $name ) {
3767 global $wgIllegalFileChars;
3768 $illegalFileChars = $wgIllegalFileChars ?
"|[" . $wgIllegalFileChars . "]" : '';
3769 $name = wfBaseName( $name );
3770 $name = preg_replace(
3771 "/[^" . Title
::legalChars() . "]" . $illegalFileChars . "/",
3779 * Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit;
3781 * @return Integer value memory was set to.
3783 function wfMemoryLimit() {
3784 global $wgMemoryLimit;
3785 $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
3786 if( $memlimit != -1 ) {
3787 $conflimit = wfShorthandToInteger( $wgMemoryLimit );
3788 if( $conflimit == -1 ) {
3789 wfDebug( "Removing PHP's memory limit\n" );
3790 wfSuppressWarnings();
3791 ini_set( 'memory_limit', $conflimit );
3792 wfRestoreWarnings();
3794 } elseif ( $conflimit > $memlimit ) {
3795 wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
3796 wfSuppressWarnings();
3797 ini_set( 'memory_limit', $conflimit );
3798 wfRestoreWarnings();
3806 * Converts shorthand byte notation to integer form
3808 * @param $string String
3811 function wfShorthandToInteger( $string = '' ) {
3812 $string = trim( $string );
3813 if( $string === '' ) {
3816 $last = $string[strlen( $string ) - 1];
3817 $val = intval( $string );
3822 // break intentionally missing
3826 // break intentionally missing
3836 * Get the normalised IETF language tag
3837 * See unit test for examples.
3839 * @param $code String: The language code.
3840 * @return String: The language code which complying with BCP 47 standards.
3842 function wfBCP47( $code ) {
3843 $codeSegment = explode( '-', $code );
3845 foreach ( $codeSegment as $segNo => $seg ) {
3846 if ( count( $codeSegment ) > 0 ) {
3847 // when previous segment is x, it is a private segment and should be lc
3848 if( $segNo > 0 && strtolower( $codeSegment[( $segNo - 1 )] ) == 'x' ) {
3849 $codeBCP[$segNo] = strtolower( $seg );
3850 // ISO 3166 country code
3851 } elseif ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) {
3852 $codeBCP[$segNo] = strtoupper( $seg );
3853 // ISO 15924 script code
3854 } elseif ( ( strlen( $seg ) == 4 ) && ( $segNo > 0 ) ) {
3855 $codeBCP[$segNo] = ucfirst( strtolower( $seg ) );
3856 // Use lowercase for other cases
3858 $codeBCP[$segNo] = strtolower( $seg );
3861 // Use lowercase for single segment
3862 $codeBCP[$segNo] = strtolower( $seg );
3865 $langCode = implode( '-', $codeBCP );
3870 * Get a cache object.
3872 * @param $inputType integer Cache type, one the the CACHE_* constants.
3875 function wfGetCache( $inputType ) {
3876 return ObjectCache
::getInstance( $inputType );
3880 * Get the main cache object
3884 function wfGetMainCache() {
3885 global $wgMainCacheType;
3886 return ObjectCache
::getInstance( $wgMainCacheType );
3890 * Get the cache object used by the message cache
3894 function wfGetMessageCacheStorage() {
3895 global $wgMessageCacheType;
3896 return ObjectCache
::getInstance( $wgMessageCacheType );
3900 * Get the cache object used by the parser cache
3904 function wfGetParserCacheStorage() {
3905 global $wgParserCacheType;
3906 return ObjectCache
::getInstance( $wgParserCacheType );
3910 * Get the cache object used by the language converter
3914 function wfGetLangConverterCacheStorage() {
3915 global $wgLanguageConverterCacheType;
3916 return ObjectCache
::getInstance( $wgLanguageConverterCacheType );
3920 * Call hook functions defined in $wgHooks
3922 * @param $event String: event name
3923 * @param $args Array: parameters passed to hook functions
3924 * @return Boolean True if no handler aborted the hook
3926 function wfRunHooks( $event, $args = array() ) {
3927 return Hooks
::run( $event, $args );
3931 * Wrapper around php's unpack.
3933 * @param $format String: The format string (See php's docs)
3934 * @param $data: A binary string of binary data
3935 * @param $length integer or false: The minimun length of $data. This is to
3936 * prevent reading beyond the end of $data. false to disable the check.
3938 * Also be careful when using this function to read unsigned 32 bit integer
3939 * because php might make it negative.
3941 * @throws MWException if $data not long enough, or if unpack fails
3942 * @return array Associative array of the extracted data
3944 function wfUnpack( $format, $data, $length=false ) {
3945 if ( $length !== false ) {
3946 $realLen = strlen( $data );
3947 if ( $realLen < $length ) {
3948 throw new MWException( "Tried to use wfUnpack on a "
3949 . "string of length $realLen, but needed one "
3950 . "of at least length $length."
3955 wfSuppressWarnings();
3956 $result = unpack( $format, $data );
3957 wfRestoreWarnings();
3959 if ( $result === false ) {
3960 // If it cannot extract the packed data.
3961 throw new MWException( "unpack could not unpack binary data" );
3967 * Determine if an image exists on the 'bad image list'.
3969 * The format of MediaWiki:Bad_image_list is as follows:
3970 * * Only list items (lines starting with "*") are considered
3971 * * The first link on a line must be a link to a bad image
3972 * * Any subsequent links on the same line are considered to be exceptions,
3973 * i.e. articles where the image may occur inline.
3975 * @param $name string the image name to check
3976 * @param $contextTitle Title|bool the page on which the image occurs, if known
3977 * @param $blacklist string wikitext of a file blacklist
3980 function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
3981 static $badImageCache = null; // based on bad_image_list msg
3982 wfProfileIn( __METHOD__
);
3985 $redirectTitle = RepoGroup
::singleton()->checkRedirect( Title
::makeTitle( NS_FILE
, $name ) );
3986 if( $redirectTitle ) {
3987 $name = $redirectTitle->getDbKey();
3990 # Run the extension hook
3992 if( !wfRunHooks( 'BadImage', array( $name, &$bad ) ) ) {
3993 wfProfileOut( __METHOD__
);
3997 $cacheable = ( $blacklist === null );
3998 if( $cacheable && $badImageCache !== null ) {
3999 $badImages = $badImageCache;
4000 } else { // cache miss
4001 if ( $blacklist === null ) {
4002 $blacklist = wfMessage( 'bad_image_list' )->inContentLanguage()->plain(); // site list
4004 # Build the list now
4005 $badImages = array();
4006 $lines = explode( "\n", $blacklist );
4007 foreach( $lines as $line ) {
4009 if ( substr( $line, 0, 1 ) !== '*' ) {
4015 if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
4019 $exceptions = array();
4020 $imageDBkey = false;
4021 foreach ( $m[1] as $i => $titleText ) {
4022 $title = Title
::newFromText( $titleText );
4023 if ( !is_null( $title ) ) {
4025 $imageDBkey = $title->getDBkey();
4027 $exceptions[$title->getPrefixedDBkey()] = true;
4032 if ( $imageDBkey !== false ) {
4033 $badImages[$imageDBkey] = $exceptions;
4037 $badImageCache = $badImages;
4041 $contextKey = $contextTitle ?
$contextTitle->getPrefixedDBkey() : false;
4042 $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
4043 wfProfileOut( __METHOD__
);