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
173 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
174 if ( is_null( $changed ) ) {
175 throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' );
177 if ( $default[$key] !== $value ) {
178 $changed[$key] = $value;
183 * Backwards array plus for people who haven't bothered to read the PHP manual
184 * XXX: will not darn your socks for you.
186 * @param $array1 Array
187 * @param [$array2, [...]] Arrays
190 function wfArrayMerge( $array1/* ... */ ) {
191 $args = func_get_args();
192 $args = array_reverse( $args, true );
194 foreach ( $args as $arg ) {
201 * Merge arrays in the style of getUserPermissionsErrors, with duplicate removal
203 * wfMergeErrorArrays(
204 * array( array( 'x' ) ),
205 * array( array( 'x', '2' ) ),
206 * array( array( 'x' ) ),
207 * array( array( 'y' ) )
218 function wfMergeErrorArrays( /*...*/ ) {
219 $args = func_get_args();
221 foreach ( $args as $errors ) {
222 foreach ( $errors as $params ) {
223 # @todo FIXME: Sometimes get nested arrays for $params,
224 # which leads to E_NOTICEs
225 $spec = implode( "\t", $params );
226 $out[$spec] = $params;
229 return array_values( $out );
233 * Insert array into another array after the specified *KEY*
235 * @param $array Array: The array.
236 * @param $insert Array: The array to insert.
237 * @param $after Mixed: The key to insert after
240 function wfArrayInsertAfter( array $array, array $insert, $after ) {
241 // Find the offset of the element to insert after.
242 $keys = array_keys( $array );
243 $offsetByKey = array_flip( $keys );
245 $offset = $offsetByKey[$after];
247 // Insert at the specified offset
248 $before = array_slice( $array, 0, $offset +
1, true );
249 $after = array_slice( $array, $offset +
1, count( $array ) - $offset, true );
251 $output = $before +
$insert +
$after;
257 * Recursively converts the parameter (an object) to an array with the same data
259 * @param $objOrArray Object|Array
260 * @param $recursive Bool
263 function wfObjectToArray( $objOrArray, $recursive = true ) {
265 if( is_object( $objOrArray ) ) {
266 $objOrArray = get_object_vars( $objOrArray );
268 foreach ( $objOrArray as $key => $value ) {
269 if ( $recursive && ( is_object( $value ) ||
is_array( $value ) ) ) {
270 $value = wfObjectToArray( $value );
273 $array[$key] = $value;
280 * Wrapper around array_map() which also taints variables
282 * @param $function Callback
283 * @param $input Array
286 function wfArrayMap( $function, $input ) {
287 $ret = array_map( $function, $input );
288 foreach ( $ret as $key => $value ) {
289 $taint = istainted( $input[$key] );
291 taint( $ret[$key], $taint );
298 * Get a random decimal value between 0 and 1, in a way
299 * not likely to give duplicate values for any realistic
300 * number of articles.
304 function wfRandom() {
305 # The maximum random value is "only" 2^31-1, so get two random
306 # values to reduce the chance of dupes
307 $max = mt_getrandmax() +
1;
308 $rand = number_format( ( mt_rand() * $max +
mt_rand() )
309 / $max / $max, 12, '.', '' );
314 * Get a random string containing a number of pesudo-random hex
316 * @note This is not secure, if you are trying to generate some sort
317 * of token please use MWCryptRand instead.
319 * @param $length int The length of the string to generate
323 function wfRandomString( $length = 32 ) {
325 while ( strlen( $str ) < $length ) {
326 $str .= dechex( mt_rand() );
328 return substr( $str, 0, $length );
332 * We want some things to be included as literal characters in our title URLs
333 * for prettiness, which urlencode encodes by default. According to RFC 1738,
334 * all of the following should be safe:
338 * But + is not safe because it's used to indicate a space; &= are only safe in
339 * paths and not in queries (and we don't distinguish here); ' seems kind of
340 * scary; and urlencode() doesn't touch -_. to begin with. Plus, although /
341 * is reserved, we don't care. So the list we unescape is:
345 * However, IIS7 redirects fail when the url contains a colon (Bug 22709),
346 * so no fancy : for IIS7.
348 * %2F in the page titles seems to fatally break for some reason.
353 function wfUrlencode( $s ) {
355 if ( is_null( $s ) ) {
360 if ( is_null( $needle ) ) {
361 $needle = array( '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F' );
362 if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) ||
( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false ) ) {
367 $s = urlencode( $s );
370 array( ';', '@', '$', '!', '*', '(', ')', ',', '/', ':' ),
378 * This function takes two arrays as input, and returns a CGI-style string, e.g.
379 * "days=7&limit=100". Options in the first array override options in the second.
380 * Options set to null or false will not be output.
382 * @param $array1 Array ( String|Array )
383 * @param $array2 Array ( String|Array )
384 * @param $prefix String
387 function wfArrayToCgi( $array1, $array2 = null, $prefix = '' ) {
388 if ( !is_null( $array2 ) ) {
389 $array1 = $array1 +
$array2;
393 foreach ( $array1 as $key => $value ) {
394 if ( $value !== false ) {
398 if ( $prefix !== '' ) {
399 $key = $prefix . "[$key]";
401 if ( is_array( $value ) ) {
403 foreach ( $value as $k => $v ) {
404 $cgi .= $firstTime ?
'' : '&';
405 if ( is_array( $v ) ) {
406 $cgi .= wfArrayToCgi( $v, null, $key . "[$k]" );
408 $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v );
413 if ( is_object( $value ) ) {
414 $value = $value->__toString();
415 } elseif( !is_null( $value ) ) {
416 $cgi .= urlencode( $key ) . '=' . urlencode( $value );
418 $cgi .= urlencode( $key );
427 * This is the logical opposite of wfArrayToCgi(): it accepts a query string as
428 * its argument and returns the same string in array form. This allows compa-
429 * tibility with legacy functions that accept raw query strings instead of nice
430 * arrays. Of course, keys and values are urldecode()d.
432 * @param $query String: query string
433 * @return array Array version of input
435 function wfCgiToArray( $query ) {
436 if ( isset( $query[0] ) && $query[0] == '?' ) {
437 $query = substr( $query, 1 );
439 $bits = explode( '&', $query );
441 foreach ( $bits as $bit ) {
445 if ( strpos( $bit, '=' ) === false ) {
446 // Pieces like &qwerty become 'qwerty' => null
447 $key = urldecode( $bit );
450 list( $key, $value ) = explode( '=', $bit );
451 $key = urldecode( $key );
452 $value = urldecode( $value );
455 if ( strpos( $key, '[' ) !== false ) {
456 $keys = array_reverse( explode( '[', $key ) );
457 $key = array_pop( $keys );
459 foreach ( $keys as $k ) {
460 $k = substr( $k, 0, -1 );
461 $temp = array( $k => $temp );
463 if ( isset( $ret[$key] ) ) {
464 $ret[$key] = array_merge( $ret[$key], $temp );
476 * Append a query string to an existing URL, which may or may not already
477 * have query string parameters already. If so, they will be combined.
479 * @deprecated in 1.20. Use Uri class.
481 * @param $query Mixed: string or associative array
484 function wfAppendQuery( $url, $query ) {
485 $obj = new Uri( $url );
486 $obj->extendQuery( $query );
487 return $obj->toString();
491 * Expand a potentially local URL to a fully-qualified URL. Assumes $wgServer
494 * The meaning of the PROTO_* constants is as follows:
495 * PROTO_HTTP: Output a URL starting with http://
496 * PROTO_HTTPS: Output a URL starting with https://
497 * PROTO_RELATIVE: Output a URL starting with // (protocol-relative URL)
498 * PROTO_CURRENT: Output a URL starting with either http:// or https:// , depending on which protocol was used for the current incoming request
499 * PROTO_CANONICAL: For URLs without a domain, like /w/index.php , use $wgCanonicalServer. For protocol-relative URLs, use the protocol of $wgCanonicalServer
500 * PROTO_INTERNAL: Like PROTO_CANONICAL, but uses $wgInternalServer instead of $wgCanonicalServer
502 * @todo this won't work with current-path-relative URLs
503 * like "subdir/foo.html", etc.
505 * @param $url String: either fully-qualified or a local path + query
506 * @param $defaultProto Mixed: one of the PROTO_* constants. Determines the
507 * protocol to use if $url or $wgServer is
509 * @return string Fully-qualified URL, current-path-relative URL or false if
510 * no valid URL can be constructed
512 function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT
) {
513 global $wgServer, $wgCanonicalServer, $wgInternalServer;
514 $serverUrl = $wgServer;
515 if ( $defaultProto === PROTO_CANONICAL
) {
516 $serverUrl = $wgCanonicalServer;
518 // Make $wgInternalServer fall back to $wgServer if not set
519 if ( $defaultProto === PROTO_INTERNAL
&& $wgInternalServer !== false ) {
520 $serverUrl = $wgInternalServer;
522 if ( $defaultProto === PROTO_CURRENT
) {
523 $defaultProto = WebRequest
::detectProtocol() . '://';
526 // Analyze $serverUrl to obtain its protocol
527 $bits = wfParseUrl( $serverUrl );
528 $serverHasProto = $bits && $bits['scheme'] != '';
530 if ( $defaultProto === PROTO_CANONICAL ||
$defaultProto === PROTO_INTERNAL
) {
531 if ( $serverHasProto ) {
532 $defaultProto = $bits['scheme'] . '://';
534 // $wgCanonicalServer or $wgInternalServer doesn't have a protocol. This really isn't supposed to happen
535 // Fall back to HTTP in this ridiculous case
536 $defaultProto = PROTO_HTTP
;
540 $defaultProtoWithoutSlashes = substr( $defaultProto, 0, -2 );
542 if ( substr( $url, 0, 2 ) == '//' ) {
543 $url = $defaultProtoWithoutSlashes . $url;
544 } elseif ( substr( $url, 0, 1 ) == '/' ) {
545 // If $serverUrl is protocol-relative, prepend $defaultProtoWithoutSlashes, otherwise leave it alone
546 $url = ( $serverHasProto ?
'' : $defaultProtoWithoutSlashes ) . $serverUrl . $url;
549 $bits = wfParseUrl( $url );
550 if ( $bits && isset( $bits['path'] ) ) {
551 $bits['path'] = wfRemoveDotSegments( $bits['path'] );
552 return wfAssembleUrl( $bits );
556 } elseif ( substr( $url, 0, 1 ) != '/' ) {
557 # URL is a relative path
558 return wfRemoveDotSegments( $url );
561 # Expanded URL is not valid.
566 * This function will reassemble a URL parsed with wfParseURL. This is useful
567 * if you need to edit part of a URL and put it back together.
569 * This is the basic structure used (brackets contain keys for $urlParts):
570 * [scheme][delimiter][user]:[pass]@[host]:[port][path]?[query]#[fragment]
572 * @todo Need to integrate this into wfExpandUrl (bug 32168)
576 * @param $urlParts Array URL parts, as output from wfParseUrl
577 * @return string URL assembled from its component parts
579 function wfAssembleUrl( $urlParts ) {
580 $obj = new Uri( $urlParts );
581 return $obj->toString();
585 * Remove all dot-segments in the provided URL path. For example,
586 * '/a/./b/../c/' becomes '/a/c/'. For details on the algorithm, please see
587 * RFC3986 section 5.2.4.
589 * @todo Need to integrate this into wfExpandUrl (bug 32168)
591 * @param $urlPath String URL path, potentially containing dot-segments
592 * @return string URL path with all dot-segments removed
594 function wfRemoveDotSegments( $urlPath ) {
597 $inputLength = strlen( $urlPath );
599 while ( $inputOffset < $inputLength ) {
600 $prefixLengthOne = substr( $urlPath, $inputOffset, 1 );
601 $prefixLengthTwo = substr( $urlPath, $inputOffset, 2 );
602 $prefixLengthThree = substr( $urlPath, $inputOffset, 3 );
603 $prefixLengthFour = substr( $urlPath, $inputOffset, 4 );
606 if ( $prefixLengthTwo == './' ) {
607 # Step A, remove leading "./"
609 } elseif ( $prefixLengthThree == '../' ) {
610 # Step A, remove leading "../"
612 } elseif ( ( $prefixLengthTwo == '/.' ) && ( $inputOffset +
2 == $inputLength ) ) {
613 # Step B, replace leading "/.$" with "/"
615 $urlPath[$inputOffset] = '/';
616 } elseif ( $prefixLengthThree == '/./' ) {
617 # Step B, replace leading "/./" with "/"
619 } elseif ( $prefixLengthThree == '/..' && ( $inputOffset +
3 == $inputLength ) ) {
620 # Step C, replace leading "/..$" with "/" and
621 # remove last path component in output
623 $urlPath[$inputOffset] = '/';
625 } elseif ( $prefixLengthFour == '/../' ) {
626 # Step C, replace leading "/../" with "/" and
627 # remove last path component in output
630 } elseif ( ( $prefixLengthOne == '.' ) && ( $inputOffset +
1 == $inputLength ) ) {
631 # Step D, remove "^.$"
633 } elseif ( ( $prefixLengthTwo == '..' ) && ( $inputOffset +
2 == $inputLength ) ) {
634 # Step D, remove "^..$"
637 # Step E, move leading path segment to output
638 if ( $prefixLengthOne == '/' ) {
639 $slashPos = strpos( $urlPath, '/', $inputOffset +
1 );
641 $slashPos = strpos( $urlPath, '/', $inputOffset );
643 if ( $slashPos === false ) {
644 $output .= substr( $urlPath, $inputOffset );
645 $inputOffset = $inputLength;
647 $output .= substr( $urlPath, $inputOffset, $slashPos - $inputOffset );
648 $inputOffset +
= $slashPos - $inputOffset;
653 $slashPos = strrpos( $output, '/' );
654 if ( $slashPos === false ) {
657 $output = substr( $output, 0, $slashPos );
666 * Returns a regular expression of url protocols
668 * @param $includeProtocolRelative bool If false, remove '//' from the returned protocol list.
669 * DO NOT USE this directly, use wfUrlProtocolsWithoutProtRel() instead
672 function wfUrlProtocols( $includeProtocolRelative = true ) {
673 global $wgUrlProtocols;
675 // Cache return values separately based on $includeProtocolRelative
676 static $withProtRel = null, $withoutProtRel = null;
677 $cachedValue = $includeProtocolRelative ?
$withProtRel : $withoutProtRel;
678 if ( !is_null( $cachedValue ) ) {
682 // Support old-style $wgUrlProtocols strings, for backwards compatibility
683 // with LocalSettings files from 1.5
684 if ( is_array( $wgUrlProtocols ) ) {
685 $protocols = array();
686 foreach ( $wgUrlProtocols as $protocol ) {
687 // Filter out '//' if !$includeProtocolRelative
688 if ( $includeProtocolRelative ||
$protocol !== '//' ) {
689 $protocols[] = preg_quote( $protocol, '/' );
693 $retval = implode( '|', $protocols );
695 // Ignore $includeProtocolRelative in this case
696 // This case exists for pre-1.6 compatibility, and we can safely assume
697 // that '//' won't appear in a pre-1.6 config because protocol-relative
698 // URLs weren't supported until 1.18
699 $retval = $wgUrlProtocols;
702 // Cache return value
703 if ( $includeProtocolRelative ) {
704 $withProtRel = $retval;
706 $withoutProtRel = $retval;
712 * Like wfUrlProtocols(), but excludes '//' from the protocol list. Use this if
713 * you need a regex that matches all URL protocols but does not match protocol-
717 function wfUrlProtocolsWithoutProtRel() {
718 return wfUrlProtocols( false );
722 * parse_url() work-alike, but non-broken. Differences:
724 * 1) Does not raise warnings on bad URLs (just returns false)
725 * 2) Handles protocols that don't use :// (e.g., mailto: and news: , as well as protocol-relative URLs) correctly
726 * 3) Adds a "delimiter" element to the array, either '://', ':' or '//' (see (2))
729 * @param $url String: a URL to parse
730 * @return Array: bits of the URL in an associative array, per PHP docs
732 function wfParseUrl( $url ) {
733 $obj = new Uri( $url );
734 return $obj->getComponents();
738 * Take a URL, make sure it's expanded to fully qualified, and replace any
739 * encoded non-ASCII Unicode characters with their UTF-8 original forms
740 * for more compact display and legibility for local audiences.
742 * @todo handle punycode domains too
747 function wfExpandIRI( $url ) {
748 return preg_replace_callback( '/((?:%[89A-F][0-9A-F])+)/i', 'wfExpandIRI_callback', wfExpandUrl( $url ) );
752 * Private callback for wfExpandIRI
753 * @param array $matches
756 function wfExpandIRI_callback( $matches ) {
757 return urldecode( $matches[1] );
763 * Make URL indexes, appropriate for the el_index field of externallinks.
768 function wfMakeUrlIndexes( $url ) {
769 $bits = wfParseUrl( $url );
771 // Reverse the labels in the hostname, convert to lower case
772 // For emails reverse domainpart only
773 if ( $bits['scheme'] == 'mailto' ) {
774 $mailparts = explode( '@', $bits['host'], 2 );
775 if ( count( $mailparts ) === 2 ) {
776 $domainpart = strtolower( implode( '.', array_reverse( explode( '.', $mailparts[1] ) ) ) );
778 // No domain specified, don't mangle it
781 $reversedHost = $domainpart . '@' . $mailparts[0];
783 $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) );
785 // Add an extra dot to the end
786 // Why? Is it in wrong place in mailto links?
787 if ( substr( $reversedHost, -1, 1 ) !== '.' ) {
788 $reversedHost .= '.';
790 // Reconstruct the pseudo-URL
791 $prot = $bits['scheme'];
792 $index = $prot . $bits['delimiter'] . $reversedHost;
793 // Leave out user and password. Add the port, path, query and fragment
794 if ( isset( $bits['port'] ) ) {
795 $index .= ':' . $bits['port'];
797 if ( isset( $bits['path'] ) ) {
798 $index .= $bits['path'];
802 if ( isset( $bits['query'] ) ) {
803 $index .= '?' . $bits['query'];
805 if ( isset( $bits['fragment'] ) ) {
806 $index .= '#' . $bits['fragment'];
810 return array( "http:$index", "https:$index" );
812 return array( $index );
817 * Check whether a given URL has a domain that occurs in a given set of domains
818 * @param $url string URL
819 * @param $domains array Array of domains (strings)
820 * @return bool True if the host part of $url ends in one of the strings in $domains
822 function wfMatchesDomainList( $url, $domains ) {
823 $bits = wfParseUrl( $url );
824 if ( is_array( $bits ) && isset( $bits['host'] ) ) {
825 foreach ( (array)$domains as $domain ) {
826 // FIXME: This gives false positives. http://nds-nl.wikipedia.org will match nl.wikipedia.org
827 // We should use something that interprets dots instead
828 if ( substr( $bits['host'], -strlen( $domain ) ) === $domain ) {
837 * Sends a line to the debug log if enabled or, optionally, to a comment in output.
838 * In normal operation this is a NOP.
840 * Controlling globals:
841 * $wgDebugLogFile - points to the log file
842 * $wgProfileOnly - if set, normal debug messages will not be recorded.
843 * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
844 * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
846 * @param $text String
847 * @param $logonly Bool: set true to avoid appearing in HTML when $wgDebugComments is set
849 function wfDebug( $text, $logonly = false ) {
850 global $wgDebugLogFile, $wgProfileOnly, $wgDebugRawPage, $wgDebugLogPrefix;
852 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
856 $timer = wfDebugTimer();
857 if ( $timer !== '' ) {
858 $text = preg_replace( '/[^\n]/', $timer . '\0', $text, 1 );
862 MWDebug
::debugMsg( $text );
865 if ( wfRunHooks( 'Debug', array( $text, null /* no log group */ ) ) ) {
866 if ( $wgDebugLogFile != '' && !$wgProfileOnly ) {
867 # Strip unprintables; they can switch terminal modes when binary data
868 # gets dumped, which is pretty annoying.
869 $text = preg_replace( '![\x00-\x08\x0b\x0c\x0e-\x1f]!', ' ', $text );
870 $text = $wgDebugLogPrefix . $text;
871 wfErrorLog( $text, $wgDebugLogFile );
877 * Returns true if debug logging should be suppressed if $wgDebugRawPage = false
880 function wfIsDebugRawPage() {
882 if ( $cache !== null ) {
885 # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
886 if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
888 isset( $_SERVER['SCRIPT_NAME'] )
889 && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
900 * Get microsecond timestamps for debug logs
904 function wfDebugTimer() {
905 global $wgDebugTimestamps, $wgRequestTime;
907 if ( !$wgDebugTimestamps ) {
911 $prefix = sprintf( "%6.4f", microtime( true ) - $wgRequestTime );
912 $mem = sprintf( "%5.1fM", ( memory_get_usage( true ) / ( 1024 * 1024 ) ) );
913 return "$prefix $mem ";
917 * Send a line giving PHP memory usage.
919 * @param $exact Bool: print exact values instead of kilobytes (default: false)
921 function wfDebugMem( $exact = false ) {
922 $mem = memory_get_usage();
924 $mem = floor( $mem / 1024 ) . ' kilobytes';
928 wfDebug( "Memory usage: $mem\n" );
932 * Send a line to a supplementary debug log file, if configured, or main debug log if not.
933 * $wgDebugLogGroups[$logGroup] should be set to a filename to send to a separate log.
935 * @param $logGroup String
936 * @param $text String
937 * @param $public Bool: whether to log the event in the public log if no private
938 * log file is specified, (default true)
940 function wfDebugLog( $logGroup, $text, $public = true ) {
941 global $wgDebugLogGroups;
942 $text = trim( $text ) . "\n";
943 if( isset( $wgDebugLogGroups[$logGroup] ) ) {
944 $time = wfTimestamp( TS_DB
);
946 $host = wfHostname();
947 if ( wfRunHooks( 'Debug', array( $text, $logGroup ) ) ) {
948 wfErrorLog( "$time $host $wiki: $text", $wgDebugLogGroups[$logGroup] );
950 } elseif ( $public === true ) {
951 wfDebug( $text, true );
956 * Log for database errors
958 * @param $text String: database error message.
960 function wfLogDBError( $text ) {
961 global $wgDBerrorLog, $wgDBerrorLogTZ;
962 static $logDBErrorTimeZoneObject = null;
964 if ( $wgDBerrorLog ) {
965 $host = wfHostname();
968 if ( $wgDBerrorLogTZ && !$logDBErrorTimeZoneObject ) {
969 $logDBErrorTimeZoneObject = new DateTimeZone( $wgDBerrorLogTZ );
972 // Workaround for https://bugs.php.net/bug.php?id=52063
973 // Can be removed when min PHP > 5.3.2
974 if ( $logDBErrorTimeZoneObject === null ) {
975 $d = date_create( "now" );
977 $d = date_create( "now", $logDBErrorTimeZoneObject );
979 $date = $d->format( 'D M j G:i:s T Y' );
981 $date = $d->format( 'D M j G:i:s T Y' );
983 $text = "$date\t$host\t$wiki\t$text";
984 wfErrorLog( $text, $wgDBerrorLog );
989 * Throws a warning that $function is deprecated
991 * @param $function String
992 * @param $version String|bool: Version of MediaWiki that the function was deprecated in (Added in 1.19).
993 * @param $component String|bool: Added in 1.19.
994 * @param $callerOffset integer: How far up the callstack is the original
995 * caller. 2 = function that called the function that called
996 * wfDeprecated (Added in 1.20)
1000 function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) {
1001 MWDebug
::deprecated( $function, $version, $component, $callerOffset +
1 );
1005 * Send a warning either to the debug log or in a PHP error depending on
1006 * $wgDevelopmentWarnings
1008 * @param $msg String: message to send
1009 * @param $callerOffset Integer: number of items to go back in the backtrace to
1010 * find the correct caller (1 = function calling wfWarn, ...)
1011 * @param $level Integer: PHP error level; only used when $wgDevelopmentWarnings
1014 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE
) {
1015 MWDebug
::warning( $msg, $callerOffset +
1, $level );
1019 * Log to a file without getting "file size exceeded" signals.
1021 * Can also log to TCP or UDP with the syntax udp://host:port/prefix. This will
1022 * send lines to the specified port, prefixed by the specified prefix and a space.
1024 * @param $text String
1025 * @param $file String filename
1027 function wfErrorLog( $text, $file ) {
1028 if ( substr( $file, 0, 4 ) == 'udp:' ) {
1029 # Needs the sockets extension
1030 if ( preg_match( '!^(tcp|udp):(?://)?\[([0-9a-fA-F:]+)\]:(\d+)(?:/(.*))?$!', $file, $m ) ) {
1031 // IPv6 bracketed host
1033 $port = intval( $m[3] );
1034 $prefix = isset( $m[4] ) ?
$m[4] : false;
1036 } elseif ( preg_match( '!^(tcp|udp):(?://)?([a-zA-Z0-9.-]+):(\d+)(?:/(.*))?$!', $file, $m ) ) {
1038 if ( !IP
::isIPv4( $host ) ) {
1039 $host = gethostbyname( $host );
1041 $port = intval( $m[3] );
1042 $prefix = isset( $m[4] ) ?
$m[4] : false;
1045 throw new MWException( __METHOD__
. ': Invalid UDP specification' );
1048 // Clean it up for the multiplexer
1049 if ( strval( $prefix ) !== '' ) {
1050 $text = preg_replace( '/^/m', $prefix . ' ', $text );
1053 if ( strlen( $text ) > 65506 ) {
1054 $text = substr( $text, 0, 65506 );
1057 if ( substr( $text, -1 ) != "\n" ) {
1060 } elseif ( strlen( $text ) > 65507 ) {
1061 $text = substr( $text, 0, 65507 );
1064 $sock = socket_create( $domain, SOCK_DGRAM
, SOL_UDP
);
1069 socket_sendto( $sock, $text, strlen( $text ), 0, $host, $port );
1070 socket_close( $sock );
1072 wfSuppressWarnings();
1073 $exists = file_exists( $file );
1074 $size = $exists ?
filesize( $file ) : false;
1075 if ( !$exists ||
( $size !== false && $size +
strlen( $text ) < 0x7fffffff ) ) {
1076 file_put_contents( $file, $text, FILE_APPEND
);
1078 wfRestoreWarnings();
1085 function wfLogProfilingData() {
1086 global $wgRequestTime, $wgDebugLogFile, $wgDebugRawPage, $wgRequest;
1087 global $wgProfileLimit, $wgUser;
1089 $profiler = Profiler
::instance();
1091 # Profiling must actually be enabled...
1092 if ( $profiler->isStub() ) {
1096 // Get total page request time and only show pages that longer than
1097 // $wgProfileLimit time (default is 0)
1098 $elapsed = microtime( true ) - $wgRequestTime;
1099 if ( $elapsed <= $wgProfileLimit ) {
1103 $profiler->logData();
1105 // Check whether this should be logged in the debug file.
1106 if ( $wgDebugLogFile == '' ||
( !$wgDebugRawPage && wfIsDebugRawPage() ) ) {
1111 if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1112 $forward = ' forwarded for ' . $_SERVER['HTTP_X_FORWARDED_FOR'];
1114 if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1115 $forward .= ' client IP ' . $_SERVER['HTTP_CLIENT_IP'];
1117 if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1118 $forward .= ' from ' . $_SERVER['HTTP_FROM'];
1121 $forward = "\t(proxied via {$_SERVER['REMOTE_ADDR']}{$forward})";
1123 // Don't load $wgUser at this late stage just for statistics purposes
1124 // @todo FIXME: We can detect some anons even if it is not loaded. See User::getId()
1125 if ( $wgUser->isItemLoaded( 'id' ) && $wgUser->isAnon() ) {
1126 $forward .= ' anon';
1128 $log = sprintf( "%s\t%04.3f\t%s\n",
1129 gmdate( 'YmdHis' ), $elapsed,
1130 urldecode( $wgRequest->getRequestURL() . $forward ) );
1132 wfErrorLog( $log . $profiler->getOutput(), $wgDebugLogFile );
1136 * Increment a statistics counter
1138 * @param $key String
1141 function wfIncrStats( $key, $count = 1 ) {
1142 global $wgStatsMethod;
1144 $count = intval( $count );
1146 if( $wgStatsMethod == 'udp' ) {
1147 global $wgUDPProfilerHost, $wgUDPProfilerPort, $wgDBname, $wgAggregateStatsID;
1150 $id = $wgAggregateStatsID !== false ?
$wgAggregateStatsID : $wgDBname;
1153 $socket = socket_create( AF_INET
, SOCK_DGRAM
, SOL_UDP
);
1154 $statline = "stats/{$id} - 1 1 1 1 1 -total\n";
1158 strlen( $statline ),
1164 $statline = "stats/{$id} - {$count} 1 1 1 1 {$key}\n";
1165 wfSuppressWarnings();
1169 strlen( $statline ),
1174 wfRestoreWarnings();
1175 } elseif( $wgStatsMethod == 'cache' ) {
1177 $key = wfMemcKey( 'stats', $key );
1178 if ( is_null( $wgMemc->incr( $key, $count ) ) ) {
1179 $wgMemc->add( $key, $count );
1187 * Check if the wiki read-only lock file is present. This can be used to lock
1188 * off editing functions, but doesn't guarantee that the database will not be
1193 function wfReadOnly() {
1194 global $wgReadOnlyFile, $wgReadOnly;
1196 if ( !is_null( $wgReadOnly ) ) {
1197 return (bool)$wgReadOnly;
1199 if ( $wgReadOnlyFile == '' ) {
1202 // Set $wgReadOnly for faster access next time
1203 if ( is_file( $wgReadOnlyFile ) ) {
1204 $wgReadOnly = file_get_contents( $wgReadOnlyFile );
1206 $wgReadOnly = false;
1208 return (bool)$wgReadOnly;
1214 function wfReadOnlyReason() {
1221 * Return a Language object from $langcode
1223 * @param $langcode Mixed: either:
1224 * - a Language object
1225 * - code of the language to get the message for, if it is
1226 * a valid code create a language for that language, if
1227 * it is a string but not a valid code then make a basic
1229 * - a boolean: if it's false then use the global object for
1230 * the current user's language (as a fallback for the old parameter
1231 * functionality), or if it is true then use global object
1232 * for the wiki's content language.
1233 * @return Language object
1235 function wfGetLangObj( $langcode = false ) {
1236 # Identify which language to get or create a language object for.
1237 # Using is_object here due to Stub objects.
1238 if( is_object( $langcode ) ) {
1239 # Great, we already have the object (hopefully)!
1243 global $wgContLang, $wgLanguageCode;
1244 if( $langcode === true ||
$langcode === $wgLanguageCode ) {
1245 # $langcode is the language code of the wikis content language object.
1246 # or it is a boolean and value is true
1251 if( $langcode === false ||
$langcode === $wgLang->getCode() ) {
1252 # $langcode is the language code of user language object.
1253 # or it was a boolean and value is false
1257 $validCodes = array_keys( Language
::fetchLanguageNames() );
1258 if( in_array( $langcode, $validCodes ) ) {
1259 # $langcode corresponds to a valid language.
1260 return Language
::factory( $langcode );
1263 # $langcode is a string, but not a valid language code; use content language.
1264 wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1269 * Old function when $wgBetterDirectionality existed
1270 * All usage removed, wfUILang can be removed in near future
1272 * @deprecated since 1.18
1275 function wfUILang() {
1276 wfDeprecated( __METHOD__
, '1.18' );
1282 * This is the new function for getting translated interface messages.
1283 * See the Message class for documentation how to use them.
1284 * The intention is that this function replaces all old wfMsg* functions.
1285 * @param $key \string Message key.
1286 * Varargs: normal message parameters.
1290 function wfMessage( $key /*...*/) {
1291 $params = func_get_args();
1292 array_shift( $params );
1293 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
1294 $params = $params[0];
1296 return new Message( $key, $params );
1300 * This function accepts multiple message keys and returns a message instance
1301 * for the first message which is non-empty. If all messages are empty then an
1302 * instance of the first message key is returned.
1303 * @param varargs: message keys
1307 function wfMessageFallback( /*...*/ ) {
1308 $args = func_get_args();
1309 return MWFunction
::callArray( 'Message::newFallbackSequence', $args );
1313 * Get a message from anywhere, for the current user language.
1315 * Use wfMsgForContent() instead if the message should NOT
1316 * change depending on the user preferences.
1318 * @deprecated since 1.18
1320 * @param $key String: lookup key for the message, usually
1321 * defined in languages/Language.php
1323 * Parameters to the message, which can be used to insert variable text into
1324 * it, can be passed to this function in the following formats:
1325 * - One per argument, starting at the second parameter
1326 * - As an array in the second parameter
1327 * These are not shown in the function definition.
1331 function wfMsg( $key ) {
1332 $args = func_get_args();
1333 array_shift( $args );
1334 return wfMsgReal( $key, $args );
1338 * Same as above except doesn't transform the message
1340 * @deprecated since 1.18
1342 * @param $key String
1345 function wfMsgNoTrans( $key ) {
1346 $args = func_get_args();
1347 array_shift( $args );
1348 return wfMsgReal( $key, $args, true, false, false );
1352 * Get a message from anywhere, for the current global language
1353 * set with $wgLanguageCode.
1355 * Use this if the message should NOT change dependent on the
1356 * language set in the user's preferences. This is the case for
1357 * most text written into logs, as well as link targets (such as
1358 * the name of the copyright policy page). Link titles, on the
1359 * other hand, should be shown in the UI language.
1361 * Note that MediaWiki allows users to change the user interface
1362 * language in their preferences, but a single installation
1363 * typically only contains content in one language.
1365 * Be wary of this distinction: If you use wfMsg() where you should
1366 * use wfMsgForContent(), a user of the software may have to
1367 * customize potentially hundreds of messages in
1368 * order to, e.g., fix a link in every possible language.
1370 * @deprecated since 1.18
1372 * @param $key String: lookup key for the message, usually
1373 * defined in languages/Language.php
1376 function wfMsgForContent( $key ) {
1377 global $wgForceUIMsgAsContentMsg;
1378 $args = func_get_args();
1379 array_shift( $args );
1381 if( is_array( $wgForceUIMsgAsContentMsg ) &&
1382 in_array( $key, $wgForceUIMsgAsContentMsg ) )
1384 $forcontent = false;
1386 return wfMsgReal( $key, $args, true, $forcontent );
1390 * Same as above except doesn't transform the message
1392 * @deprecated since 1.18
1394 * @param $key String
1397 function wfMsgForContentNoTrans( $key ) {
1398 global $wgForceUIMsgAsContentMsg;
1399 $args = func_get_args();
1400 array_shift( $args );
1402 if( is_array( $wgForceUIMsgAsContentMsg ) &&
1403 in_array( $key, $wgForceUIMsgAsContentMsg ) )
1405 $forcontent = false;
1407 return wfMsgReal( $key, $args, true, $forcontent, false );
1411 * Really get a message
1413 * @deprecated since 1.18
1415 * @param $key String: key to get.
1417 * @param $useDB Boolean
1418 * @param $forContent Mixed: Language code, or false for user lang, true for content lang.
1419 * @param $transform Boolean: Whether or not to transform the message.
1420 * @return String: the requested message.
1422 function wfMsgReal( $key, $args, $useDB = true, $forContent = false, $transform = true ) {
1423 wfProfileIn( __METHOD__
);
1424 $message = wfMsgGetKey( $key, $useDB, $forContent, $transform );
1425 $message = wfMsgReplaceArgs( $message, $args );
1426 wfProfileOut( __METHOD__
);
1431 * Fetch a message string value, but don't replace any keys yet.
1433 * @deprecated since 1.18
1435 * @param $key String
1436 * @param $useDB Bool
1437 * @param $langCode String: Code of the language to get the message for, or
1438 * behaves as a content language switch if it is a boolean.
1439 * @param $transform Boolean: whether to parse magic words, etc.
1442 function wfMsgGetKey( $key, $useDB = true, $langCode = false, $transform = true ) {
1443 wfRunHooks( 'NormalizeMessageKey', array( &$key, &$useDB, &$langCode, &$transform ) );
1445 $cache = MessageCache
::singleton();
1446 $message = $cache->get( $key, $useDB, $langCode );
1447 if( $message === false ) {
1448 $message = '<' . htmlspecialchars( $key ) . '>';
1449 } elseif ( $transform ) {
1450 $message = $cache->transform( $message );
1456 * Replace message parameter keys on the given formatted output.
1458 * @deprecated since 1.18
1460 * @param $message String
1461 * @param $args Array
1465 function wfMsgReplaceArgs( $message, $args ) {
1466 # Fix windows line-endings
1467 # Some messages are split with explode("\n", $msg)
1468 $message = str_replace( "\r", '', $message );
1470 // Replace arguments
1471 if ( count( $args ) ) {
1472 if ( is_array( $args[0] ) ) {
1473 $args = array_values( $args[0] );
1475 $replacementKeys = array();
1476 foreach( $args as $n => $param ) {
1477 $replacementKeys['$' . ( $n +
1 )] = $param;
1479 $message = strtr( $message, $replacementKeys );
1486 * Return an HTML-escaped version of a message.
1487 * Parameter replacements, if any, are done *after* the HTML-escaping,
1488 * so parameters may contain HTML (eg links or form controls). Be sure
1489 * to pre-escape them if you really do want plaintext, or just wrap
1490 * the whole thing in htmlspecialchars().
1492 * @deprecated since 1.18
1494 * @param $key String
1495 * @param string ... parameters
1498 function wfMsgHtml( $key ) {
1499 $args = func_get_args();
1500 array_shift( $args );
1501 return wfMsgReplaceArgs( htmlspecialchars( wfMsgGetKey( $key ) ), $args );
1505 * Return an HTML version of message
1506 * Parameter replacements, if any, are done *after* parsing the wiki-text message,
1507 * so parameters may contain HTML (eg links or form controls). Be sure
1508 * to pre-escape them if you really do want plaintext, or just wrap
1509 * the whole thing in htmlspecialchars().
1511 * @deprecated since 1.18
1513 * @param $key String
1514 * @param string ... parameters
1517 function wfMsgWikiHtml( $key ) {
1518 $args = func_get_args();
1519 array_shift( $args );
1520 return wfMsgReplaceArgs(
1521 MessageCache
::singleton()->parse( wfMsgGetKey( $key ), null,
1522 /* can't be set to false */ true, /* interface */ true )->getText(),
1527 * Returns message in the requested format
1529 * @deprecated since 1.18
1531 * @param $key String: key of the message
1532 * @param $options Array: processing rules. Can take the following options:
1533 * <i>parse</i>: parses wikitext to HTML
1534 * <i>parseinline</i>: parses wikitext to HTML and removes the surrounding
1535 * p's added by parser or tidy
1536 * <i>escape</i>: filters message through htmlspecialchars
1537 * <i>escapenoentities</i>: same, but allows entity references like   through
1538 * <i>replaceafter</i>: parameters are substituted after parsing or escaping
1539 * <i>parsemag</i>: transform the message using magic phrases
1540 * <i>content</i>: fetch message for content language instead of interface
1541 * Also can accept a single associative argument, of the form 'language' => 'xx':
1542 * <i>language</i>: Language object or language code to fetch message for
1543 * (overriden by <i>content</i>).
1544 * Behavior for conflicting options (e.g., parse+parseinline) is undefined.
1548 function wfMsgExt( $key, $options ) {
1549 $args = func_get_args();
1550 array_shift( $args );
1551 array_shift( $args );
1552 $options = (array)$options;
1554 foreach( $options as $arrayKey => $option ) {
1555 if( !preg_match( '/^[0-9]+|language$/', $arrayKey ) ) {
1556 # An unknown index, neither numeric nor "language"
1557 wfWarn( "wfMsgExt called with incorrect parameter key $arrayKey", 1, E_USER_WARNING
);
1558 } elseif( preg_match( '/^[0-9]+$/', $arrayKey ) && !in_array( $option,
1559 array( 'parse', 'parseinline', 'escape', 'escapenoentities',
1560 'replaceafter', 'parsemag', 'content' ) ) ) {
1561 # A numeric index with unknown value
1562 wfWarn( "wfMsgExt called with incorrect parameter $option", 1, E_USER_WARNING
);
1566 if( in_array( 'content', $options, true ) ) {
1569 $langCodeObj = null;
1570 } elseif( array_key_exists( 'language', $options ) ) {
1571 $forContent = false;
1572 $langCode = wfGetLangObj( $options['language'] );
1573 $langCodeObj = $langCode;
1575 $forContent = false;
1577 $langCodeObj = null;
1580 $string = wfMsgGetKey( $key, /*DB*/true, $langCode, /*Transform*/false );
1582 if( !in_array( 'replaceafter', $options, true ) ) {
1583 $string = wfMsgReplaceArgs( $string, $args );
1586 $messageCache = MessageCache
::singleton();
1587 $parseInline = in_array( 'parseinline', $options, true );
1588 if( in_array( 'parse', $options, true ) ||
$parseInline ) {
1589 $string = $messageCache->parse( $string, null, true, !$forContent, $langCodeObj );
1590 if ( $string instanceof ParserOutput
) {
1591 $string = $string->getText();
1594 if ( $parseInline ) {
1596 if( preg_match( '/^<p>(.*)\n?<\/p>\n?$/sU', $string, $m ) ) {
1600 } elseif ( in_array( 'parsemag', $options, true ) ) {
1601 $string = $messageCache->transform( $string,
1602 !$forContent, $langCodeObj );
1605 if ( in_array( 'escape', $options, true ) ) {
1606 $string = htmlspecialchars ( $string );
1607 } elseif ( in_array( 'escapenoentities', $options, true ) ) {
1608 $string = Sanitizer
::escapeHtmlAllowEntities( $string );
1611 if( in_array( 'replaceafter', $options, true ) ) {
1612 $string = wfMsgReplaceArgs( $string, $args );
1619 * Since wfMsg() and co suck, they don't return false if the message key they
1620 * looked up didn't exist but a XHTML string, this function checks for the
1621 * nonexistance of messages by checking the MessageCache::get() result directly.
1623 * @deprecated since 1.18. Use Message::isDisabled().
1625 * @param $key String: the message key looked up
1626 * @return Boolean True if the message *doesn't* exist.
1628 function wfEmptyMsg( $key ) {
1629 return MessageCache
::singleton()->get( $key, /*useDB*/true, /*content*/false ) === false;
1633 * Throw a debugging exception. This function previously once exited the process,
1634 * but now throws an exception instead, with similar results.
1636 * @param $msg String: message shown when dying.
1638 function wfDebugDieBacktrace( $msg = '' ) {
1639 throw new MWException( $msg );
1643 * Fetch server name for use in error reporting etc.
1644 * Use real server name if available, so we know which machine
1645 * in a server farm generated the current page.
1649 function wfHostname() {
1651 if ( is_null( $host ) ) {
1653 # Hostname overriding
1654 global $wgOverrideHostname;
1655 if( $wgOverrideHostname !== false ) {
1656 # Set static and skip any detection
1657 $host = $wgOverrideHostname;
1661 if ( function_exists( 'posix_uname' ) ) {
1662 // This function not present on Windows
1663 $uname = posix_uname();
1667 if( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1668 $host = $uname['nodename'];
1669 } elseif ( getenv( 'COMPUTERNAME' ) ) {
1670 # Windows computer name
1671 $host = getenv( 'COMPUTERNAME' );
1673 # This may be a virtual server.
1674 $host = $_SERVER['SERVER_NAME'];
1681 * Returns a HTML comment with the elapsed time since request.
1682 * This method has no side effects.
1686 function wfReportTime() {
1687 global $wgRequestTime, $wgShowHostnames;
1689 $elapsed = microtime( true ) - $wgRequestTime;
1691 return $wgShowHostnames
1692 ?
sprintf( '<!-- Served by %s in %01.3f secs. -->', wfHostname(), $elapsed )
1693 : sprintf( '<!-- Served in %01.3f secs. -->', $elapsed );
1697 * Safety wrapper for debug_backtrace().
1699 * With Zend Optimizer 3.2.0 loaded, this causes segfaults under somewhat
1700 * murky circumstances, which may be triggered in part by stub objects
1701 * or other fancy talkin'.
1703 * Will return an empty array if Zend Optimizer is detected or if
1704 * debug_backtrace is disabled, otherwise the output from
1705 * debug_backtrace() (trimmed).
1707 * @param $limit int This parameter can be used to limit the number of stack frames returned
1709 * @return array of backtrace information
1711 function wfDebugBacktrace( $limit = 0 ) {
1712 static $disabled = null;
1714 if( extension_loaded( 'Zend Optimizer' ) ) {
1715 wfDebug( "Zend Optimizer detected; skipping debug_backtrace for safety.\n" );
1719 if ( is_null( $disabled ) ) {
1721 $functions = explode( ',', ini_get( 'disable_functions' ) );
1722 $functions = array_map( 'trim', $functions );
1723 $functions = array_map( 'strtolower', $functions );
1724 if ( in_array( 'debug_backtrace', $functions ) ) {
1725 wfDebug( "debug_backtrace is in disabled_functions\n" );
1733 if ( $limit && version_compare( PHP_VERSION
, '5.4.0', '>=' ) ) {
1734 return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT
, $limit +
1 ), 1 );
1736 return array_slice( debug_backtrace(), 1 );
1741 * Get a debug backtrace as a string
1745 function wfBacktrace() {
1746 global $wgCommandLineMode;
1748 if ( $wgCommandLineMode ) {
1753 $backtrace = wfDebugBacktrace();
1754 foreach( $backtrace as $call ) {
1755 if( isset( $call['file'] ) ) {
1756 $f = explode( DIRECTORY_SEPARATOR
, $call['file'] );
1757 $file = $f[count( $f ) - 1];
1761 if( isset( $call['line'] ) ) {
1762 $line = $call['line'];
1766 if ( $wgCommandLineMode ) {
1767 $msg .= "$file line $line calls ";
1769 $msg .= '<li>' . $file . ' line ' . $line . ' calls ';
1771 if( !empty( $call['class'] ) ) {
1772 $msg .= $call['class'] . $call['type'];
1774 $msg .= $call['function'] . '()';
1776 if ( $wgCommandLineMode ) {
1782 if ( $wgCommandLineMode ) {
1792 * Get the name of the function which called this function
1793 * wfGetCaller( 1 ) is the function with the wfGetCaller() call (ie. __FUNCTION__)
1794 * wfGetCaller( 2 ) [default] is the caller of the function running wfGetCaller()
1795 * wfGetCaller( 3 ) is the parent of that.
1798 * @return Bool|string
1800 function wfGetCaller( $level = 2 ) {
1801 $backtrace = wfDebugBacktrace( $level +
1 );
1802 if ( isset( $backtrace[$level] ) ) {
1803 return wfFormatStackFrame( $backtrace[$level] );
1805 $caller = 'unknown';
1811 * Return a string consisting of callers in the stack. Useful sometimes
1812 * for profiling specific points.
1814 * @param $limit int The maximum depth of the stack frame to return, or false for
1818 function wfGetAllCallers( $limit = 3 ) {
1819 $trace = array_reverse( wfDebugBacktrace() );
1820 if ( !$limit ||
$limit > count( $trace ) - 1 ) {
1821 $limit = count( $trace ) - 1;
1823 $trace = array_slice( $trace, -$limit - 1, $limit );
1824 return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1828 * Return a string representation of frame
1830 * @param $frame Array
1833 function wfFormatStackFrame( $frame ) {
1834 return isset( $frame['class'] ) ?
1835 $frame['class'] . '::' . $frame['function'] :
1840 /* Some generic result counters, pulled out of SearchEngine */
1846 * @param $offset Int
1850 function wfShowingResults( $offset, $limit ) {
1851 return wfMessage( 'showingresults' )->numParams( $limit, $offset +
1 )->parse();
1855 * Generate (prev x| next x) (20|50|100...) type links for paging
1857 * @param $offset String
1858 * @param $limit Integer
1859 * @param $link String
1860 * @param $query String: optional URL query parameter string
1861 * @param $atend Bool: optional param for specified if this is the last page
1863 * @deprecated in 1.19; use Language::viewPrevNext() instead
1865 function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) {
1866 wfDeprecated( __METHOD__
, '1.19' );
1870 $query = wfCgiToArray( $query );
1872 if( is_object( $link ) ) {
1875 $title = Title
::newFromText( $link );
1876 if( is_null( $title ) ) {
1881 return $wgLang->viewPrevNext( $title, $offset, $limit, $query, $atend );
1885 * Make a list item, used by various special pages
1887 * @param $page String Page link
1888 * @param $details String Text between brackets
1889 * @param $oppositedm Boolean Add the direction mark opposite to your
1890 * language, to display text properly
1892 * @deprecated since 1.19; use Language::specialList() instead
1894 function wfSpecialList( $page, $details, $oppositedm = true ) {
1895 wfDeprecated( __METHOD__
, '1.19' );
1898 return $wgLang->specialList( $page, $details, $oppositedm );
1903 * @todo FIXME: We may want to blacklist some broken browsers
1905 * @param $force Bool
1906 * @return bool Whereas client accept gzip compression
1908 function wfClientAcceptsGzip( $force = false ) {
1909 static $result = null;
1910 if ( $result === null ||
$force ) {
1912 if( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
1913 # @todo FIXME: We may want to blacklist some broken browsers
1916 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
1917 $_SERVER['HTTP_ACCEPT_ENCODING'],
1921 if( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
1925 wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
1934 * Obtain the offset and limit values from the request string;
1935 * used in special pages
1937 * @param $deflimit Int default limit if none supplied
1938 * @param $optionname String Name of a user preference to check against
1942 function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
1944 return $wgRequest->getLimitOffset( $deflimit, $optionname );
1948 * Escapes the given text so that it may be output using addWikiText()
1949 * without any linking, formatting, etc. making its way through. This
1950 * is achieved by substituting certain characters with HTML entities.
1951 * As required by the callers, "<nowiki>" is not used.
1953 * @param $text String: text to be escaped
1956 function wfEscapeWikiText( $text ) {
1957 $text = strtr( "\n$text", array(
1958 '"' => '"', '&' => '&', "'" => ''', '<' => '<',
1959 '=' => '=', '>' => '>', '[' => '[', ']' => ']',
1960 '{' => '{', '|' => '|', '}' => '}',
1961 "\n#" => "\n#", "\n*" => "\n*",
1962 "\n:" => "\n:", "\n;" => "\n;",
1963 '://' => '://', 'ISBN ' => 'ISBN ', 'RFC ' => 'RFC ',
1965 return substr( $text, 1 );
1969 * Get the current unix timetstamp with microseconds. Useful for profiling
1973 return microtime( true );
1977 * Sets dest to source and returns the original value of dest
1978 * If source is NULL, it just returns the value, it doesn't set the variable
1979 * If force is true, it will set the value even if source is NULL
1981 * @param $dest Mixed
1982 * @param $source Mixed
1983 * @param $force Bool
1986 function wfSetVar( &$dest, $source, $force = false ) {
1988 if ( !is_null( $source ) ||
$force ) {
1995 * As for wfSetVar except setting a bit
1999 * @param $state Bool
2003 function wfSetBit( &$dest, $bit, $state = true ) {
2004 $temp = (bool)( $dest & $bit );
2005 if ( !is_null( $state ) ) {
2016 * A wrapper around the PHP function var_export().
2017 * Either print it or add it to the regular output ($wgOut).
2019 * @param $var mixed A PHP variable to dump.
2021 function wfVarDump( $var ) {
2023 $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
2024 if ( headers_sent() ||
!isset( $wgOut ) ||
!is_object( $wgOut ) ) {
2027 $wgOut->addHTML( $s );
2032 * Provide a simple HTTP error.
2034 * @param $code Int|String
2035 * @param $label String
2036 * @param $desc String
2038 function wfHttpError( $code, $label, $desc ) {
2041 header( "HTTP/1.0 $code $label" );
2042 header( "Status: $code $label" );
2043 $wgOut->sendCacheControl();
2045 header( 'Content-type: text/html; charset=utf-8' );
2046 print "<!doctype html>" .
2047 '<html><head><title>' .
2048 htmlspecialchars( $label ) .
2049 '</title></head><body><h1>' .
2050 htmlspecialchars( $label ) .
2052 nl2br( htmlspecialchars( $desc ) ) .
2053 "</p></body></html>\n";
2057 * Clear away any user-level output buffers, discarding contents.
2059 * Suitable for 'starting afresh', for instance when streaming
2060 * relatively large amounts of data without buffering, or wanting to
2061 * output image files without ob_gzhandler's compression.
2063 * The optional $resetGzipEncoding parameter controls suppression of
2064 * the Content-Encoding header sent by ob_gzhandler; by default it
2065 * is left. See comments for wfClearOutputBuffers() for why it would
2068 * Note that some PHP configuration options may add output buffer
2069 * layers which cannot be removed; these are left in place.
2071 * @param $resetGzipEncoding Bool
2073 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
2074 if( $resetGzipEncoding ) {
2075 // Suppress Content-Encoding and Content-Length
2076 // headers from 1.10+s wfOutputHandler
2077 global $wgDisableOutputCompression;
2078 $wgDisableOutputCompression = true;
2080 while( $status = ob_get_status() ) {
2081 if( $status['type'] == 0 /* PHP_OUTPUT_HANDLER_INTERNAL */ ) {
2082 // Probably from zlib.output_compression or other
2083 // PHP-internal setting which can't be removed.
2085 // Give up, and hope the result doesn't break
2089 if( !ob_end_clean() ) {
2090 // Could not remove output buffer handler; abort now
2091 // to avoid getting in some kind of infinite loop.
2094 if( $resetGzipEncoding ) {
2095 if( $status['name'] == 'ob_gzhandler' ) {
2096 // Reset the 'Content-Encoding' field set by this handler
2097 // so we can start fresh.
2098 header_remove( 'Content-Encoding' );
2106 * More legible than passing a 'false' parameter to wfResetOutputBuffers():
2108 * Clear away output buffers, but keep the Content-Encoding header
2109 * produced by ob_gzhandler, if any.
2111 * This should be used for HTTP 304 responses, where you need to
2112 * preserve the Content-Encoding header of the real result, but
2113 * also need to suppress the output of ob_gzhandler to keep to spec
2114 * and avoid breaking Firefox in rare cases where the headers and
2115 * body are broken over two packets.
2117 function wfClearOutputBuffers() {
2118 wfResetOutputBuffers( false );
2122 * Converts an Accept-* header into an array mapping string values to quality
2125 * @param $accept String
2126 * @param $def String default
2129 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
2130 # No arg means accept anything (per HTTP spec)
2132 return array( $def => 1.0 );
2137 $parts = explode( ',', $accept );
2139 foreach( $parts as $part ) {
2140 # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
2141 $values = explode( ';', trim( $part ) );
2143 if ( count( $values ) == 1 ) {
2144 $prefs[$values[0]] = 1.0;
2145 } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
2146 $prefs[$values[0]] = floatval( $match[1] );
2154 * Checks if a given MIME type matches any of the keys in the given
2155 * array. Basic wildcards are accepted in the array keys.
2157 * Returns the matching MIME type (or wildcard) if a match, otherwise
2160 * @param $type String
2161 * @param $avail Array
2165 function mimeTypeMatch( $type, $avail ) {
2166 if( array_key_exists( $type, $avail ) ) {
2169 $parts = explode( '/', $type );
2170 if( array_key_exists( $parts[0] . '/*', $avail ) ) {
2171 return $parts[0] . '/*';
2172 } elseif( array_key_exists( '*/*', $avail ) ) {
2181 * Returns the 'best' match between a client's requested internet media types
2182 * and the server's list of available types. Each list should be an associative
2183 * array of type to preference (preference is a float between 0.0 and 1.0).
2184 * Wildcards in the types are acceptable.
2186 * @param $cprefs Array: client's acceptable type list
2187 * @param $sprefs Array: server's offered types
2190 * @todo FIXME: Doesn't handle params like 'text/plain; charset=UTF-8'
2191 * XXX: generalize to negotiate other stuff
2193 function wfNegotiateType( $cprefs, $sprefs ) {
2196 foreach( array_keys( $sprefs ) as $type ) {
2197 $parts = explode( '/', $type );
2198 if( $parts[1] != '*' ) {
2199 $ckey = mimeTypeMatch( $type, $cprefs );
2201 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
2206 foreach( array_keys( $cprefs ) as $type ) {
2207 $parts = explode( '/', $type );
2208 if( $parts[1] != '*' && !array_key_exists( $type, $sprefs ) ) {
2209 $skey = mimeTypeMatch( $type, $sprefs );
2211 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
2219 foreach( array_keys( $combine ) as $type ) {
2220 if( $combine[$type] > $bestq ) {
2222 $bestq = $combine[$type];
2230 * Reference-counted warning suppression
2234 function wfSuppressWarnings( $end = false ) {
2235 static $suppressCount = 0;
2236 static $originalLevel = false;
2239 if ( $suppressCount ) {
2241 if ( !$suppressCount ) {
2242 error_reporting( $originalLevel );
2246 if ( !$suppressCount ) {
2247 $originalLevel = error_reporting( E_ALL
& ~
( E_WARNING | E_NOTICE | E_USER_WARNING | E_USER_NOTICE | E_DEPRECATED | E_USER_DEPRECATED
) );
2254 * Restore error level to previous value
2256 function wfRestoreWarnings() {
2257 wfSuppressWarnings( true );
2260 # Autodetect, convert and provide timestamps of various types
2263 * Unix time - the number of seconds since 1970-01-01 00:00:00 UTC
2265 define( 'TS_UNIX', 0 );
2268 * MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
2270 define( 'TS_MW', 1 );
2273 * MySQL DATETIME (YYYY-MM-DD HH:MM:SS)
2275 define( 'TS_DB', 2 );
2278 * RFC 2822 format, for E-mail and HTTP headers
2280 define( 'TS_RFC2822', 3 );
2283 * ISO 8601 format with no timezone: 1986-02-09T20:00:00Z
2285 * This is used by Special:Export
2287 define( 'TS_ISO_8601', 4 );
2290 * An Exif timestamp (YYYY:MM:DD HH:MM:SS)
2292 * @see http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the
2293 * DateTime tag and page 36 for the DateTimeOriginal and
2294 * DateTimeDigitized tags.
2296 define( 'TS_EXIF', 5 );
2299 * Oracle format time.
2301 define( 'TS_ORACLE', 6 );
2304 * Postgres format time.
2306 define( 'TS_POSTGRES', 7 );
2311 define( 'TS_DB2', 8 );
2314 * ISO 8601 basic format with no timezone: 19860209T200000Z. This is used by ResourceLoader
2316 define( 'TS_ISO_8601_BASIC', 9 );
2319 * Get a timestamp string in one of various formats
2321 * @param $outputtype Mixed: A timestamp in one of the supported formats, the
2322 * function will autodetect which format is supplied and act
2324 * @param $ts Mixed: the timestamp to convert or 0 for the current timestamp
2325 * @return Mixed: String / false The same date in the format specified in $outputtype or false
2327 function wfTimestamp( $outputtype = TS_UNIX
, $ts = 0 ) {
2332 if ( !$ts ) { // We want to catch 0, '', null... but not date strings starting with a letter.
2335 } elseif ( preg_match( '/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)$/D', $ts, $da ) ) {
2337 } elseif ( preg_match( '/^(\d{4}):(\d\d):(\d\d) (\d\d):(\d\d):(\d\d)$/D', $ts, $da ) ) {
2339 } elseif ( preg_match( '/^(\d{4})(\d\d)(\d\d)(\d\d)(\d\d)(\d\d)$/D', $ts, $da ) ) {
2341 } elseif ( preg_match( '/^-?\d{1,13}$/D', $ts ) ) {
2344 $strtime = "@$ts"; // http://php.net/manual/en/datetime.formats.compound.php
2345 } elseif ( preg_match( '/^\d{2}-\d{2}-\d{4} \d{2}:\d{2}:\d{2}.\d{6}$/', $ts ) ) {
2346 # TS_ORACLE // session altered to DD-MM-YYYY HH24:MI:SS.FF6
2347 $strtime = preg_replace( '/(\d\d)\.(\d\d)\.(\d\d)(\.(\d+))?/', "$1:$2:$3",
2348 str_replace( '+00:00', 'UTC', $ts ) );
2349 } elseif ( preg_match( '/^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})(?:\.*\d*)?Z$/', $ts, $da ) ) {
2351 } elseif ( preg_match( '/^(\d{4})(\d{2})(\d{2})T(\d{2})(\d{2})(\d{2})(?:\.*\d*)?Z$/', $ts, $da ) ) {
2353 } elseif ( preg_match( '/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)\.*\d*[\+\- ](\d\d)$/', $ts, $da ) ) {
2355 } elseif ( preg_match( '/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)\.*\d* GMT$/', $ts, $da ) ) {
2357 } elseif (preg_match( '/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)\.\d\d\d$/', $ts, $da ) ) {
2359 } elseif ( preg_match( '/^[ \t\r\n]*([A-Z][a-z]{2},[ \t\r\n]*)?' . # Day of week
2360 '\d\d?[ \t\r\n]*[A-Z][a-z]{2}[ \t\r\n]*\d{2}(?:\d{2})?' . # dd Mon yyyy
2361 '[ \t\r\n]*\d\d[ \t\r\n]*:[ \t\r\n]*\d\d[ \t\r\n]*:[ \t\r\n]*\d\d/S', $ts ) ) { # hh:mm:ss
2362 # TS_RFC2822, accepting a trailing comment. See http://www.squid-cache.org/mail-archive/squid-users/200307/0122.html / r77171
2363 # The regex is a superset of rfc2822 for readability
2364 $strtime = strtok( $ts, ';' );
2365 } elseif ( preg_match( '/^[A-Z][a-z]{5,8}, \d\d-[A-Z][a-z]{2}-\d{2} \d\d:\d\d:\d\d/', $ts ) ) {
2368 } elseif ( preg_match( '/^[A-Z][a-z]{2} [A-Z][a-z]{2} +\d{1,2} \d\d:\d\d:\d\d \d{4}/', $ts ) ) {
2373 wfDebug("wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n");
2378 static $formats = array(
2381 TS_DB
=> 'Y-m-d H:i:s',
2382 TS_ISO_8601
=> 'Y-m-d\TH:i:s\Z',
2383 TS_ISO_8601_BASIC
=> 'Ymd\THis\Z',
2384 TS_EXIF
=> 'Y:m:d H:i:s', // This shouldn't ever be used, but is included for completeness
2385 TS_RFC2822
=> 'D, d M Y H:i:s',
2386 TS_ORACLE
=> 'd-m-Y H:i:s.000000', // Was 'd-M-y h.i.s A' . ' +00:00' before r51500
2387 TS_POSTGRES
=> 'Y-m-d H:i:s',
2388 TS_DB2
=> 'Y-m-d H:i:s',
2391 if ( !isset( $formats[$outputtype] ) ) {
2392 throw new MWException( 'wfTimestamp() called with illegal output type.' );
2395 if ( function_exists( "date_create" ) ) {
2396 if ( count( $da ) ) {
2397 $ds = sprintf("%04d-%02d-%02dT%02d:%02d:%02d.00+00:00",
2398 (int)$da[1], (int)$da[2], (int)$da[3],
2399 (int)$da[4], (int)$da[5], (int)$da[6]);
2401 $d = date_create( $ds, new DateTimeZone( 'GMT' ) );
2402 } elseif ( $strtime ) {
2403 $d = date_create( $strtime, new DateTimeZone( 'GMT' ) );
2409 wfDebug("wfTimestamp() fed bogus time value: $outputtype; $ts\n");
2413 $output = $d->format( $formats[$outputtype] );
2415 if ( count( $da ) ) {
2416 // Warning! gmmktime() acts oddly if the month or day is set to 0
2417 // We may want to handle that explicitly at some point
2418 $uts = gmmktime( (int)$da[4], (int)$da[5], (int)$da[6],
2419 (int)$da[2], (int)$da[3], (int)$da[1] );
2420 } elseif ( $strtime ) {
2421 $uts = strtotime( $strtime );
2424 if ( $uts === false ) {
2425 wfDebug("wfTimestamp() can't parse the timestamp (non 32-bit time? Update php): $outputtype; $ts\n");
2429 if ( TS_UNIX
== $outputtype ) {
2432 $output = gmdate( $formats[$outputtype], $uts );
2435 if ( ( $outputtype == TS_RFC2822
) ||
( $outputtype == TS_POSTGRES
) ) {
2443 * Return a formatted timestamp, or null if input is null.
2444 * For dealing with nullable timestamp columns in the database.
2446 * @param $outputtype Integer
2450 function wfTimestampOrNull( $outputtype = TS_UNIX
, $ts = null ) {
2451 if( is_null( $ts ) ) {
2454 return wfTimestamp( $outputtype, $ts );
2459 * Convenience function; returns MediaWiki timestamp for the present time.
2463 function wfTimestampNow() {
2465 return wfTimestamp( TS_MW
, time() );
2469 * Check if the operating system is Windows
2471 * @return Bool: true if it's Windows, False otherwise.
2473 function wfIsWindows() {
2474 static $isWindows = null;
2475 if ( $isWindows === null ) {
2476 $isWindows = substr( php_uname(), 0, 7 ) == 'Windows';
2482 * Check if we are running under HipHop
2486 function wfIsHipHop() {
2487 return function_exists( 'hphp_thread_set_warmup_enabled' );
2491 * Swap two variables
2496 function swap( &$x, &$y ) {
2503 * Tries to get the system directory for temporary files. First
2504 * $wgTmpDirectory is checked, and then the TMPDIR, TMP, and TEMP
2505 * environment variables are then checked in sequence, and if none are
2506 * set try sys_get_temp_dir().
2508 * NOTE: When possible, use instead the tmpfile() function to create
2509 * temporary files to avoid race conditions on file creation, etc.
2513 function wfTempDir() {
2514 global $wgTmpDirectory;
2516 if ( $wgTmpDirectory !== false ) {
2517 return $wgTmpDirectory;
2520 $tmpDir = array_map( "getenv", array( 'TMPDIR', 'TMP', 'TEMP' ) );
2522 foreach( $tmpDir as $tmp ) {
2523 if( $tmp && file_exists( $tmp ) && is_dir( $tmp ) && is_writable( $tmp ) ) {
2527 return sys_get_temp_dir();
2531 * Make directory, and make all parent directories if they don't exist
2533 * @param $dir String: full path to directory to create
2534 * @param $mode Integer: chmod value to use, default is $wgDirectoryMode
2535 * @param $caller String: optional caller param for debugging.
2538 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2539 global $wgDirectoryMode;
2541 if ( FileBackend
::isStoragePath( $dir ) ) { // sanity
2542 throw new MWException( __FUNCTION__
. " given storage path '$dir'." );
2545 if ( !is_null( $caller ) ) {
2546 wfDebug( "$caller: called wfMkdirParents($dir)\n" );
2549 if( strval( $dir ) === '' ||
file_exists( $dir ) ) {
2553 $dir = str_replace( array( '\\', '/' ), DIRECTORY_SEPARATOR
, $dir );
2555 if ( is_null( $mode ) ) {
2556 $mode = $wgDirectoryMode;
2559 // Turn off the normal warning, we're doing our own below
2560 wfSuppressWarnings();
2561 $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2562 wfRestoreWarnings();
2565 // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2566 trigger_error( sprintf( "%s: failed to mkdir \"%s\" mode 0%o", __FUNCTION__
, $dir, $mode ),
2573 * Remove a directory and all its content.
2574 * Does not hide error.
2576 function wfRecursiveRemoveDir( $dir ) {
2577 wfDebug( __FUNCTION__
. "( $dir )\n" );
2578 // taken from http://de3.php.net/manual/en/function.rmdir.php#98622
2579 if ( is_dir( $dir ) ) {
2580 $objects = scandir( $dir );
2581 foreach ( $objects as $object ) {
2582 if ( $object != "." && $object != ".." ) {
2583 if ( filetype( $dir . '/' . $object ) == "dir" ) {
2584 wfRecursiveRemoveDir( $dir . '/' . $object );
2586 unlink( $dir . '/' . $object );
2596 * @param $nr Mixed: the number to format
2597 * @param $acc Integer: the number of digits after the decimal point, default 2
2598 * @param $round Boolean: whether or not to round the value, default true
2601 function wfPercent( $nr, $acc = 2, $round = true ) {
2602 $ret = sprintf( "%.${acc}f", $nr );
2603 return $round ?
round( $ret, $acc ) . '%' : "$ret%";
2607 * Find out whether or not a mixed variable exists in a string
2609 * @param $needle String
2610 * @param $str String
2611 * @param $insensitive Boolean
2614 function in_string( $needle, $str, $insensitive = false ) {
2616 if( $insensitive ) $func = 'stripos';
2618 return $func( $str, $needle ) !== false;
2622 * Safety wrapper around ini_get() for boolean settings.
2623 * The values returned from ini_get() are pre-normalized for settings
2624 * set via php.ini or php_flag/php_admin_flag... but *not*
2625 * for those set via php_value/php_admin_value.
2627 * It's fairly common for people to use php_value instead of php_flag,
2628 * which can leave you with an 'off' setting giving a false positive
2629 * for code that just takes the ini_get() return value as a boolean.
2631 * To make things extra interesting, setting via php_value accepts
2632 * "true" and "yes" as true, but php.ini and php_flag consider them false. :)
2633 * Unrecognized values go false... again opposite PHP's own coercion
2634 * from string to bool.
2636 * Luckily, 'properly' set settings will always come back as '0' or '1',
2637 * so we only have to worry about them and the 'improper' settings.
2639 * I frickin' hate PHP... :P
2641 * @param $setting String
2644 function wfIniGetBool( $setting ) {
2645 $val = ini_get( $setting );
2646 // 'on' and 'true' can't have whitespace around them, but '1' can.
2647 return strtolower( $val ) == 'on'
2648 ||
strtolower( $val ) == 'true'
2649 ||
strtolower( $val ) == 'yes'
2650 ||
preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2654 * Wrapper function for PHP's dl(). This doesn't work in most situations from
2655 * PHP 5.3 onward, and is usually disabled in shared environments anyway.
2657 * @param $extension String A PHP extension. The file suffix (.so or .dll)
2659 * @param $fileName String Name of the library, if not $extension.suffix
2660 * @return Bool - Whether or not the extension is loaded
2662 function wfDl( $extension, $fileName = null ) {
2663 if( extension_loaded( $extension ) ) {
2668 $sapi = php_sapi_name();
2669 if( $sapi == 'cli' ||
$sapi == 'cgi' ||
$sapi == 'embed' ) {
2670 $canDl = ( function_exists( 'dl' ) && is_callable( 'dl' )
2671 && wfIniGetBool( 'enable_dl' ) && !wfIniGetBool( 'safe_mode' ) );
2675 $fileName = $fileName ?
$fileName : $extension;
2676 if( wfIsWindows() ) {
2677 $fileName = 'php_' . $fileName;
2679 wfSuppressWarnings();
2680 dl( $fileName . '.' . PHP_SHLIB_SUFFIX
);
2681 wfRestoreWarnings();
2683 return extension_loaded( $extension );
2687 * Windows-compatible version of escapeshellarg()
2688 * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
2689 * function puts single quotes in regardless of OS.
2691 * Also fixes the locale problems on Linux in PHP 5.2.6+ (bug backported to
2692 * earlier distro releases of PHP)
2697 function wfEscapeShellArg( ) {
2698 wfInitShellLocale();
2700 $args = func_get_args();
2703 foreach ( $args as $arg ) {
2710 if ( wfIsWindows() ) {
2711 // Escaping for an MSVC-style command line parser and CMD.EXE
2713 // * http://web.archive.org/web/20020708081031/http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
2714 // * http://technet.microsoft.com/en-us/library/cc723564.aspx
2717 // Double the backslashes before any double quotes. Escape the double quotes.
2718 $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE
);
2721 foreach ( $tokens as $token ) {
2722 if ( $iteration %
2 == 1 ) {
2723 // Delimiter, a double quote preceded by zero or more slashes
2724 $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
2725 } elseif ( $iteration %
4 == 2 ) {
2726 // ^ in $token will be outside quotes, need to be escaped
2727 $arg .= str_replace( '^', '^^', $token );
2728 } else { // $iteration % 4 == 0
2729 // ^ in $token will appear inside double quotes, so leave as is
2734 // Double the backslashes before the end of the string, because
2735 // we will soon add a quote
2737 if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
2738 $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
2741 // Add surrounding quotes
2742 $retVal .= '"' . $arg . '"';
2744 $retVal .= escapeshellarg( $arg );
2751 * Execute a shell command, with time and memory limits mirrored from the PHP
2752 * configuration if supported.
2753 * @param $cmd String Command line, properly escaped for shell.
2754 * @param &$retval null|Mixed optional, will receive the program's exit code.
2755 * (non-zero is usually failure)
2756 * @param $environ Array optional environment variables which should be
2757 * added to the executed command environment.
2758 * @param $limits Array optional array with limits(filesize, memory, time)
2759 * this overwrites the global wgShellMax* limits.
2760 * @return string collected stdout as a string (trailing newlines stripped)
2762 function wfShellExec( $cmd, &$retval = null, $environ = array(), $limits = array() ) {
2763 global $IP, $wgMaxShellMemory, $wgMaxShellFileSize, $wgMaxShellTime;
2766 if ( is_null( $disabled ) ) {
2768 if( wfIniGetBool( 'safe_mode' ) ) {
2769 wfDebug( "wfShellExec can't run in safe_mode, PHP's exec functions are too broken.\n" );
2770 $disabled = 'safemode';
2772 $functions = explode( ',', ini_get( 'disable_functions' ) );
2773 $functions = array_map( 'trim', $functions );
2774 $functions = array_map( 'strtolower', $functions );
2775 if ( in_array( 'passthru', $functions ) ) {
2776 wfDebug( "passthru is in disabled_functions\n" );
2777 $disabled = 'passthru';
2783 return $disabled == 'safemode' ?
2784 'Unable to run external programs in safe mode.' :
2785 'Unable to run external programs, passthru() is disabled.';
2788 wfInitShellLocale();
2791 foreach( $environ as $k => $v ) {
2792 if ( wfIsWindows() ) {
2793 /* Surrounding a set in quotes (method used by wfEscapeShellArg) makes the quotes themselves
2794 * appear in the environment variable, so we must use carat escaping as documented in
2795 * http://technet.microsoft.com/en-us/library/cc723564.aspx
2796 * Note however that the quote isn't listed there, but is needed, and the parentheses
2797 * are listed there but doesn't appear to need it.
2799 $envcmd .= "set $k=" . preg_replace( '/([&|()<>^"])/', '^\\1', $v ) . '&& ';
2801 /* Assume this is a POSIX shell, thus required to accept variable assignments before the command
2802 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_09_01
2804 $envcmd .= "$k=" . escapeshellarg( $v ) . ' ';
2807 $cmd = $envcmd . $cmd;
2809 if ( php_uname( 's' ) == 'Linux' ) {
2810 $time = intval ( isset($limits['time']) ?
$limits['time'] : $wgMaxShellTime );
2811 $mem = intval ( isset($limits['memory']) ?
$limits['memory'] : $wgMaxShellMemory );
2812 $filesize = intval ( isset($limits['filesize']) ?
$limits['filesize'] : $wgMaxShellFileSize );
2814 if ( $time > 0 && $mem > 0 ) {
2815 $script = "$IP/bin/ulimit4.sh";
2816 if ( is_executable( $script ) ) {
2817 $cmd = '/bin/bash ' . escapeshellarg( $script ) . " $time $mem $filesize " . escapeshellarg( $cmd );
2821 wfDebug( "wfShellExec: $cmd\n" );
2823 $retval = 1; // error by default?
2825 passthru( $cmd, $retval );
2826 $output = ob_get_contents();
2829 if ( $retval == 127 ) {
2830 wfDebugLog( 'exec', "Possibly missing executable file: $cmd\n" );
2836 * Workaround for http://bugs.php.net/bug.php?id=45132
2837 * escapeshellarg() destroys non-ASCII characters if LANG is not a UTF-8 locale
2839 function wfInitShellLocale() {
2840 static $done = false;
2845 global $wgShellLocale;
2846 if ( !wfIniGetBool( 'safe_mode' ) ) {
2847 putenv( "LC_CTYPE=$wgShellLocale" );
2848 setlocale( LC_CTYPE
, $wgShellLocale );
2853 * Alias to wfShellWikiCmd()
2854 * @see wfShellWikiCmd()
2856 function wfShellMaintenanceCmd( $script, array $parameters = array(), array $options = array() ) {
2857 return wfShellWikiCmd( $script, $parameters, $options );
2861 * Generate a shell-escaped command line string to run a MediaWiki cli script.
2862 * Note that $parameters should be a flat array and an option with an argument
2863 * should consist of two consecutive items in the array (do not use "--option value").
2864 * @param $script string MediaWiki cli script path
2865 * @param $parameters Array Arguments and options to the script
2866 * @param $options Array Associative array of options:
2867 * 'php': The path to the php executable
2868 * 'wrapper': Path to a PHP wrapper to handle the maintenance script
2871 function wfShellWikiCmd( $script, array $parameters = array(), array $options = array() ) {
2873 // Give site config file a chance to run the script in a wrapper.
2874 // The caller may likely want to call wfBasename() on $script.
2875 wfRunHooks( 'wfShellWikiCmd', array( &$script, &$parameters, &$options ) );
2876 $cmd = isset( $options['php'] ) ?
array( $options['php'] ) : array( $wgPhpCli );
2877 if ( isset( $options['wrapper'] ) ) {
2878 $cmd[] = $options['wrapper'];
2881 // Escape each parameter for shell
2882 return implode( " ", array_map( 'wfEscapeShellArg', array_merge( $cmd, $parameters ) ) );
2886 * wfMerge attempts to merge differences between three texts.
2887 * Returns true for a clean merge and false for failure or a conflict.
2889 * @param $old String
2890 * @param $mine String
2891 * @param $yours String
2892 * @param $result String
2895 function wfMerge( $old, $mine, $yours, &$result ) {
2898 # This check may also protect against code injection in
2899 # case of broken installations.
2900 wfSuppressWarnings();
2901 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
2902 wfRestoreWarnings();
2905 wfDebug( "diff3 not found\n" );
2909 # Make temporary files
2911 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2912 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
2913 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
2915 fwrite( $oldtextFile, $old );
2916 fclose( $oldtextFile );
2917 fwrite( $mytextFile, $mine );
2918 fclose( $mytextFile );
2919 fwrite( $yourtextFile, $yours );
2920 fclose( $yourtextFile );
2922 # Check for a conflict
2923 $cmd = $wgDiff3 . ' -a --overlap-only ' .
2924 wfEscapeShellArg( $mytextName ) . ' ' .
2925 wfEscapeShellArg( $oldtextName ) . ' ' .
2926 wfEscapeShellArg( $yourtextName );
2927 $handle = popen( $cmd, 'r' );
2929 if( fgets( $handle, 1024 ) ) {
2937 $cmd = $wgDiff3 . ' -a -e --merge ' .
2938 wfEscapeShellArg( $mytextName, $oldtextName, $yourtextName );
2939 $handle = popen( $cmd, 'r' );
2942 $data = fread( $handle, 8192 );
2943 if ( strlen( $data ) == 0 ) {
2949 unlink( $mytextName );
2950 unlink( $oldtextName );
2951 unlink( $yourtextName );
2953 if ( $result === '' && $old !== '' && !$conflict ) {
2954 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
2961 * Returns unified plain-text diff of two texts.
2962 * Useful for machine processing of diffs.
2964 * @param $before String: the text before the changes.
2965 * @param $after String: the text after the changes.
2966 * @param $params String: command-line options for the diff command.
2967 * @return String: unified diff of $before and $after
2969 function wfDiff( $before, $after, $params = '-u' ) {
2970 if ( $before == $after ) {
2975 wfSuppressWarnings();
2976 $haveDiff = $wgDiff && file_exists( $wgDiff );
2977 wfRestoreWarnings();
2979 # This check may also protect against code injection in
2980 # case of broken installations.
2982 wfDebug( "diff executable not found\n" );
2983 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
2984 $format = new UnifiedDiffFormatter();
2985 return $format->format( $diffs );
2988 # Make temporary files
2990 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2991 $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
2993 fwrite( $oldtextFile, $before );
2994 fclose( $oldtextFile );
2995 fwrite( $newtextFile, $after );
2996 fclose( $newtextFile );
2998 // Get the diff of the two files
2999 $cmd = "$wgDiff " . $params . ' ' . wfEscapeShellArg( $oldtextName, $newtextName );
3001 $h = popen( $cmd, 'r' );
3006 $data = fread( $h, 8192 );
3007 if ( strlen( $data ) == 0 ) {
3015 unlink( $oldtextName );
3016 unlink( $newtextName );
3018 // Kill the --- and +++ lines. They're not useful.
3019 $diff_lines = explode( "\n", $diff );
3020 if ( strpos( $diff_lines[0], '---' ) === 0 ) {
3021 unset( $diff_lines[0] );
3023 if ( strpos( $diff_lines[1], '+++' ) === 0 ) {
3024 unset( $diff_lines[1] );
3027 $diff = implode( "\n", $diff_lines );
3033 * This function works like "use VERSION" in Perl, the program will die with a
3034 * backtrace if the current version of PHP is less than the version provided
3036 * This is useful for extensions which due to their nature are not kept in sync
3037 * with releases, and might depend on other versions of PHP than the main code
3039 * Note: PHP might die due to parsing errors in some cases before it ever
3040 * manages to call this function, such is life
3042 * @see perldoc -f use
3044 * @param $req_ver Mixed: the version to check, can be a string, an integer, or
3047 function wfUsePHP( $req_ver ) {
3048 $php_ver = PHP_VERSION
;
3050 if ( version_compare( $php_ver, (string)$req_ver, '<' ) ) {
3051 throw new MWException( "PHP $req_ver required--this is only $php_ver" );
3056 * This function works like "use VERSION" in Perl except it checks the version
3057 * of MediaWiki, the program will die with a backtrace if the current version
3058 * of MediaWiki is less than the version provided.
3060 * This is useful for extensions which due to their nature are not kept in sync
3063 * @see perldoc -f use
3065 * @param $req_ver Mixed: the version to check, can be a string, an integer, or
3068 function wfUseMW( $req_ver ) {
3071 if ( version_compare( $wgVersion, (string)$req_ver, '<' ) ) {
3072 throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
3077 * Return the final portion of a pathname.
3078 * Reimplemented because PHP5's "basename()" is buggy with multibyte text.
3079 * http://bugs.php.net/bug.php?id=33898
3081 * PHP's basename() only considers '\' a pathchar on Windows and Netware.
3082 * We'll consider it so always, as we don't want '\s' in our Unix paths either.
3084 * @param $path String
3085 * @param $suffix String: to remove if present
3088 function wfBaseName( $path, $suffix = '' ) {
3089 $encSuffix = ( $suffix == '' )
3091 : ( '(?:' . preg_quote( $suffix, '#' ) . ')?' );
3093 if( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
3101 * Generate a relative path name to the given file.
3102 * May explode on non-matching case-insensitive paths,
3103 * funky symlinks, etc.
3105 * @param $path String: absolute destination path including target filename
3106 * @param $from String: Absolute source path, directory only
3109 function wfRelativePath( $path, $from ) {
3110 // Normalize mixed input on Windows...
3111 $path = str_replace( '/', DIRECTORY_SEPARATOR
, $path );
3112 $from = str_replace( '/', DIRECTORY_SEPARATOR
, $from );
3114 // Trim trailing slashes -- fix for drive root
3115 $path = rtrim( $path, DIRECTORY_SEPARATOR
);
3116 $from = rtrim( $from, DIRECTORY_SEPARATOR
);
3118 $pieces = explode( DIRECTORY_SEPARATOR
, dirname( $path ) );
3119 $against = explode( DIRECTORY_SEPARATOR
, $from );
3121 if( $pieces[0] !== $against[0] ) {
3122 // Non-matching Windows drive letters?
3123 // Return a full path.
3127 // Trim off common prefix
3128 while( count( $pieces ) && count( $against )
3129 && $pieces[0] == $against[0] ) {
3130 array_shift( $pieces );
3131 array_shift( $against );
3134 // relative dots to bump us to the parent
3135 while( count( $against ) ) {
3136 array_unshift( $pieces, '..' );
3137 array_shift( $against );
3140 array_push( $pieces, wfBaseName( $path ) );
3142 return implode( DIRECTORY_SEPARATOR
, $pieces );
3146 * Do any deferred updates and clear the list
3148 * @deprecated since 1.19
3149 * @see DeferredUpdates::doUpdate()
3150 * @param $commit string
3152 function wfDoUpdates( $commit = '' ) {
3153 wfDeprecated( __METHOD__
, '1.19' );
3154 DeferredUpdates
::doUpdates( $commit );
3158 * Convert an arbitrarily-long digit string from one numeric base
3159 * to another, optionally zero-padding to a minimum column width.
3161 * Supports base 2 through 36; digit values 10-36 are represented
3162 * as lowercase letters a-z. Input is case-insensitive.
3164 * @param $input String: of digits
3165 * @param $sourceBase Integer: 2-36
3166 * @param $destBase Integer: 2-36
3167 * @param $pad Integer: 1 or greater
3168 * @param $lowercase Boolean
3169 * @return String or false on invalid input
3171 function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1, $lowercase = true ) {
3172 $input = strval( $input );
3173 if( $sourceBase < 2 ||
3178 $sourceBase != intval( $sourceBase ) ||
3179 $destBase != intval( $destBase ) ||
3180 $pad != intval( $pad ) ||
3181 !is_string( $input ) ||
3185 $digitChars = ( $lowercase ) ?
'0123456789abcdefghijklmnopqrstuvwxyz' : '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ';
3186 $inDigits = array();
3189 // Decode and validate input string
3190 $input = strtolower( $input );
3191 for( $i = 0; $i < strlen( $input ); $i++
) {
3192 $n = strpos( $digitChars, $input[$i] );
3193 if( $n === false ||
$n > $sourceBase ) {
3199 // Iterate over the input, modulo-ing out an output digit
3200 // at a time until input is gone.
3201 while( count( $inDigits ) ) {
3203 $workDigits = array();
3206 foreach( $inDigits as $digit ) {
3207 $work *= $sourceBase;
3210 if( $work < $destBase ) {
3211 // Gonna need to pull another digit.
3212 if( count( $workDigits ) ) {
3213 // Avoid zero-padding; this lets us find
3214 // the end of the input very easily when
3215 // length drops to zero.
3219 // Finally! Actual division!
3220 $workDigits[] = intval( $work / $destBase );
3222 // Isn't it annoying that most programming languages
3223 // don't have a single divide-and-remainder operator,
3224 // even though the CPU implements it that way?
3225 $work = $work %
$destBase;
3229 // All that division leaves us with a remainder,
3230 // which is conveniently our next output digit.
3231 $outChars .= $digitChars[$work];
3234 $inDigits = $workDigits;
3237 while( strlen( $outChars ) < $pad ) {
3241 return strrev( $outChars );
3245 * Create an object with a given name and an array of construct parameters
3247 * @param $name String
3248 * @param $p Array: parameters
3250 * @deprecated since 1.18, warnings in 1.18, removal in 1.20
3252 function wfCreateObject( $name, $p ) {
3253 wfDeprecated( __FUNCTION__
, '1.18' );
3254 return MWFunction
::newObj( $name, $p );
3260 function wfHttpOnlySafe() {
3261 global $wgHttpOnlyBlacklist;
3263 if( isset( $_SERVER['HTTP_USER_AGENT'] ) ) {
3264 foreach( $wgHttpOnlyBlacklist as $regex ) {
3265 if( preg_match( $regex, $_SERVER['HTTP_USER_AGENT'] ) ) {
3275 * Override session_id before session startup if php's built-in
3276 * session generation code is not secure.
3278 function wfFixSessionID() {
3279 // If the cookie or session id is already set we already have a session and should abort
3280 if ( isset( $_COOKIE[ session_name() ] ) ||
session_id() ) {
3284 // PHP's built-in session entropy is enabled if:
3285 // - entropy_file is set or you're on Windows with php 5.3.3+
3286 // - AND entropy_length is > 0
3287 // We treat it as disabled if it doesn't have an entropy length of at least 32
3289 ( wfIsWindows() && version_compare( PHP_VERSION
, '5.3.3', '>=' ) )
3290 ||
ini_get( 'session.entropy_file' )
3292 && intval( ini_get( 'session.entropy_length' ) ) >= 32;
3294 // If built-in entropy is not enabled or not sufficient override php's built in session id generation code
3295 if ( !$entropyEnabled ) {
3296 wfDebug( __METHOD__
. ": PHP's built in entropy is disabled or not sufficient, overriding session id generation using our cryptrand source.\n" );
3297 session_id( MWCryptRand
::generateHex( 32 ) );
3302 * Initialise php session
3304 * @param $sessionId Bool
3306 function wfSetupSession( $sessionId = false ) {
3307 global $wgSessionsInMemcached, $wgSessionsInObjectCache, $wgCookiePath, $wgCookieDomain,
3308 $wgCookieSecure, $wgCookieHttpOnly, $wgSessionHandler;
3309 if( $wgSessionsInObjectCache ||
$wgSessionsInMemcached ) {
3310 ObjectCacheSessionHandler
::install();
3311 } elseif( $wgSessionHandler && $wgSessionHandler != ini_get( 'session.save_handler' ) ) {
3312 # Only set this if $wgSessionHandler isn't null and session.save_handler
3313 # hasn't already been set to the desired value (that causes errors)
3314 ini_set( 'session.save_handler', $wgSessionHandler );
3316 $httpOnlySafe = wfHttpOnlySafe() && $wgCookieHttpOnly;
3317 wfDebugLog( 'cookie',
3318 'session_set_cookie_params: "' . implode( '", "',
3324 $httpOnlySafe ) ) . '"' );
3325 session_set_cookie_params( 0, $wgCookiePath, $wgCookieDomain, $wgCookieSecure, $httpOnlySafe );
3326 session_cache_limiter( 'private, must-revalidate' );
3328 session_id( $sessionId );
3332 wfSuppressWarnings();
3334 wfRestoreWarnings();
3338 * Get an object from the precompiled serialized directory
3340 * @param $name String
3341 * @return Mixed: the variable on success, false on failure
3343 function wfGetPrecompiledData( $name ) {
3346 $file = "$IP/serialized/$name";
3347 if ( file_exists( $file ) ) {
3348 $blob = file_get_contents( $file );
3350 return unserialize( $blob );
3362 function wfMemcKey( /*... */ ) {
3363 global $wgCachePrefix;
3364 $prefix = $wgCachePrefix === false ?
wfWikiID() : $wgCachePrefix;
3365 $args = func_get_args();
3366 $key = $prefix . ':' . implode( ':', $args );
3367 $key = str_replace( ' ', '_', $key );
3372 * Get a cache key for a foreign DB
3375 * @param $prefix String
3376 * @param varargs String
3379 function wfForeignMemcKey( $db, $prefix /*, ... */ ) {
3380 $args = array_slice( func_get_args(), 2 );
3382 $key = "$db-$prefix:" . implode( ':', $args );
3384 $key = $db . ':' . implode( ':', $args );
3390 * Get an ASCII string identifying this wiki
3391 * This is used as a prefix in memcached keys
3395 function wfWikiID() {
3396 global $wgDBprefix, $wgDBname;
3397 if ( $wgDBprefix ) {
3398 return "$wgDBname-$wgDBprefix";
3405 * Split a wiki ID into DB name and table prefix
3407 * @param $wiki String
3411 function wfSplitWikiID( $wiki ) {
3412 $bits = explode( '-', $wiki, 2 );
3413 if ( count( $bits ) < 2 ) {
3420 * Get a Database object.
3422 * @param $db Integer: index of the connection to get. May be DB_MASTER for the
3423 * master (for write queries), DB_SLAVE for potentially lagged read
3424 * queries, or an integer >= 0 for a particular server.
3426 * @param $groups Mixed: query groups. An array of group names that this query
3427 * belongs to. May contain a single string if the query is only
3430 * @param $wiki String: the wiki ID, or false for the current wiki
3432 * Note: multiple calls to wfGetDB(DB_SLAVE) during the course of one request
3433 * will always return the same object, unless the underlying connection or load
3434 * balancer is manually destroyed.
3436 * Note 2: use $this->getDB() in maintenance scripts that may be invoked by
3437 * updater to ensure that a proper database is being updated.
3439 * @return DatabaseBase
3441 function &wfGetDB( $db, $groups = array(), $wiki = false ) {
3442 return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
3446 * Get a load balancer object.
3448 * @param $wiki String: wiki ID, or false for the current wiki
3449 * @return LoadBalancer
3451 function wfGetLB( $wiki = false ) {
3452 return wfGetLBFactory()->getMainLB( $wiki );
3456 * Get the load balancer factory object
3460 function &wfGetLBFactory() {
3461 return LBFactory
::singleton();
3466 * Shortcut for RepoGroup::singleton()->findFile()
3468 * @param $title String or Title object
3469 * @param $options array Associative array of options:
3470 * time: requested time for an archived image, or false for the
3471 * current version. An image object will be returned which was
3472 * created at the specified time.
3474 * ignoreRedirect: If true, do not follow file redirects
3476 * private: If true, return restricted (deleted) files if the current
3477 * user is allowed to view them. Otherwise, such files will not
3480 * bypassCache: If true, do not use the process-local cache of File objects
3482 * @return File, or false if the file does not exist
3484 function wfFindFile( $title, $options = array() ) {
3485 return RepoGroup
::singleton()->findFile( $title, $options );
3489 * Get an object referring to a locally registered file.
3490 * Returns a valid placeholder object if the file does not exist.
3492 * @param $title Title|String
3493 * @return LocalFile|null A File, or null if passed an invalid Title
3495 function wfLocalFile( $title ) {
3496 return RepoGroup
::singleton()->getLocalRepo()->newFile( $title );
3500 * Stream a file to the browser. Back-compat alias for StreamFile::stream()
3501 * @deprecated since 1.19
3503 function wfStreamFile( $fname, $headers = array() ) {
3504 wfDeprecated( __FUNCTION__
, '1.19' );
3505 StreamFile
::stream( $fname, $headers );
3509 * Should low-performance queries be disabled?
3512 * @codeCoverageIgnore
3514 function wfQueriesMustScale() {
3515 global $wgMiserMode;
3517 ||
( SiteStats
::pages() > 100000
3518 && SiteStats
::edits() > 1000000
3519 && SiteStats
::users() > 10000 );
3523 * Get the path to a specified script file, respecting file
3524 * extensions; this is a wrapper around $wgScriptExtension etc.
3525 * except for 'index' and 'load' which use $wgScript/$wgLoadScript
3527 * @param $script String: script filename, sans extension
3530 function wfScript( $script = 'index' ) {
3531 global $wgScriptPath, $wgScriptExtension, $wgScript, $wgLoadScript;
3532 if ( $script === 'index' ) {
3534 } else if ( $script === 'load' ) {
3535 return $wgLoadScript;
3537 return "{$wgScriptPath}/{$script}{$wgScriptExtension}";
3542 * Get the script URL.
3544 * @return string script URL
3546 function wfGetScriptUrl() {
3547 if( isset( $_SERVER['SCRIPT_NAME'] ) ) {
3549 # as it was called, minus the query string.
3551 # Some sites use Apache rewrite rules to handle subdomains,
3552 # and have PHP set up in a weird way that causes PHP_SELF
3553 # to contain the rewritten URL instead of the one that the
3554 # outside world sees.
3556 # If in this mode, use SCRIPT_URL instead, which mod_rewrite
3557 # provides containing the "before" URL.
3558 return $_SERVER['SCRIPT_NAME'];
3560 return $_SERVER['URL'];
3565 * Convenience function converts boolean values into "true"
3566 * or "false" (string) values
3568 * @param $value Boolean
3571 function wfBoolToStr( $value ) {
3572 return $value ?
'true' : 'false';
3576 * Load an extension messages file
3578 * @deprecated since 1.16, warnings in 1.18, remove in 1.20
3579 * @codeCoverageIgnore
3581 function wfLoadExtensionMessages() {
3582 wfDeprecated( __FUNCTION__
, '1.16' );
3586 * Get a platform-independent path to the null file, e.g. /dev/null
3590 function wfGetNull() {
3591 return wfIsWindows()
3597 * Modern version of wfWaitForSlaves(). Instead of looking at replication lag
3598 * and waiting for it to go down, this waits for the slaves to catch up to the
3599 * master position. Use this when updating very large numbers of rows, as
3600 * in maintenance scripts, to avoid causing too much lag. Of course, this is
3601 * a no-op if there are no slaves.
3603 * @param $maxLag Integer (deprecated)
3604 * @param $wiki mixed Wiki identifier accepted by wfGetLB
3606 function wfWaitForSlaves( $maxLag = false, $wiki = false ) {
3607 $lb = wfGetLB( $wiki );
3608 // bug 27975 - Don't try to wait for slaves if there are none
3609 // Prevents permission error when getting master position
3610 if ( $lb->getServerCount() > 1 ) {
3611 $dbw = $lb->getConnection( DB_MASTER
);
3612 $pos = $dbw->getMasterPos();
3613 $lb->waitForAll( $pos );
3618 * Used to be used for outputting text in the installer/updater
3619 * @deprecated since 1.18, warnings in 1.18, remove in 1.20
3621 function wfOut( $s ) {
3622 wfDeprecated( __FUNCTION__
, '1.18' );
3623 global $wgCommandLineMode;
3624 if ( $wgCommandLineMode ) {
3627 echo htmlspecialchars( $s );
3633 * Count down from $n to zero on the terminal, with a one-second pause
3634 * between showing each number. For use in command-line scripts.
3635 * @codeCoverageIgnore
3638 function wfCountDown( $n ) {
3639 for ( $i = $n; $i >= 0; $i-- ) {
3641 echo str_repeat( "\x08", strlen( $i +
1 ) );
3653 * Generate a random 32-character hexadecimal token.
3654 * @param $salt Mixed: some sort of salt, if necessary, to add to random
3655 * characters before hashing.
3657 * @codeCoverageIgnore
3658 * @deprecated since 1.20; Please use MWCryptRand for security purposes and wfRandomString for pesudo-random strings
3659 * @warning This method is NOT secure. Additionally it has many callers that use it for pesudo-random purposes.
3661 function wfGenerateToken( $salt = '' ) {
3662 wfDeprecated( __METHOD__
, '1.20' );
3663 $salt = serialize( $salt );
3664 return md5( mt_rand( 0, 0x7fffffff ) . $salt );
3668 * Replace all invalid characters with -
3669 * Additional characters can be defined in $wgIllegalFileChars (see bug 20489)
3670 * By default, $wgIllegalFileChars = ':'
3672 * @param $name Mixed: filename to process
3675 function wfStripIllegalFilenameChars( $name ) {
3676 global $wgIllegalFileChars;
3677 $illegalFileChars = $wgIllegalFileChars ?
"|[" . $wgIllegalFileChars . "]" : '';
3678 $name = wfBaseName( $name );
3679 $name = preg_replace(
3680 "/[^" . Title
::legalChars() . "]" . $illegalFileChars . "/",
3688 * Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit;
3690 * @return Integer value memory was set to.
3692 function wfMemoryLimit() {
3693 global $wgMemoryLimit;
3694 $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
3695 if( $memlimit != -1 ) {
3696 $conflimit = wfShorthandToInteger( $wgMemoryLimit );
3697 if( $conflimit == -1 ) {
3698 wfDebug( "Removing PHP's memory limit\n" );
3699 wfSuppressWarnings();
3700 ini_set( 'memory_limit', $conflimit );
3701 wfRestoreWarnings();
3703 } elseif ( $conflimit > $memlimit ) {
3704 wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
3705 wfSuppressWarnings();
3706 ini_set( 'memory_limit', $conflimit );
3707 wfRestoreWarnings();
3715 * Converts shorthand byte notation to integer form
3717 * @param $string String
3720 function wfShorthandToInteger( $string = '' ) {
3721 $string = trim( $string );
3722 if( $string === '' ) {
3725 $last = $string[strlen( $string ) - 1];
3726 $val = intval( $string );
3731 // break intentionally missing
3735 // break intentionally missing
3745 * Get the normalised IETF language tag
3746 * See unit test for examples.
3748 * @param $code String: The language code.
3749 * @return String: The language code which complying with BCP 47 standards.
3751 function wfBCP47( $code ) {
3752 $codeSegment = explode( '-', $code );
3754 foreach ( $codeSegment as $segNo => $seg ) {
3755 if ( count( $codeSegment ) > 0 ) {
3756 // when previous segment is x, it is a private segment and should be lc
3757 if( $segNo > 0 && strtolower( $codeSegment[( $segNo - 1 )] ) == 'x' ) {
3758 $codeBCP[$segNo] = strtolower( $seg );
3759 // ISO 3166 country code
3760 } elseif ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) {
3761 $codeBCP[$segNo] = strtoupper( $seg );
3762 // ISO 15924 script code
3763 } elseif ( ( strlen( $seg ) == 4 ) && ( $segNo > 0 ) ) {
3764 $codeBCP[$segNo] = ucfirst( strtolower( $seg ) );
3765 // Use lowercase for other cases
3767 $codeBCP[$segNo] = strtolower( $seg );
3770 // Use lowercase for single segment
3771 $codeBCP[$segNo] = strtolower( $seg );
3774 $langCode = implode( '-', $codeBCP );
3779 * Get a cache object.
3781 * @param $inputType integer Cache type, one the the CACHE_* constants.
3784 function wfGetCache( $inputType ) {
3785 return ObjectCache
::getInstance( $inputType );
3789 * Get the main cache object
3793 function wfGetMainCache() {
3794 global $wgMainCacheType;
3795 return ObjectCache
::getInstance( $wgMainCacheType );
3799 * Get the cache object used by the message cache
3803 function wfGetMessageCacheStorage() {
3804 global $wgMessageCacheType;
3805 return ObjectCache
::getInstance( $wgMessageCacheType );
3809 * Get the cache object used by the parser cache
3813 function wfGetParserCacheStorage() {
3814 global $wgParserCacheType;
3815 return ObjectCache
::getInstance( $wgParserCacheType );
3819 * Get the cache object used by the language converter
3823 function wfGetLangConverterCacheStorage() {
3824 global $wgLanguageConverterCacheType;
3825 return ObjectCache
::getInstance( $wgLanguageConverterCacheType );
3829 * Call hook functions defined in $wgHooks
3831 * @param $event String: event name
3832 * @param $args Array: parameters passed to hook functions
3833 * @return Boolean True if no handler aborted the hook
3835 function wfRunHooks( $event, $args = array() ) {
3836 return Hooks
::run( $event, $args );
3840 * Wrapper around php's unpack.
3842 * @param $format String: The format string (See php's docs)
3843 * @param $data: A binary string of binary data
3844 * @param $length integer or false: The minimun length of $data. This is to
3845 * prevent reading beyond the end of $data. false to disable the check.
3847 * Also be careful when using this function to read unsigned 32 bit integer
3848 * because php might make it negative.
3850 * @throws MWException if $data not long enough, or if unpack fails
3851 * @return array Associative array of the extracted data
3853 function wfUnpack( $format, $data, $length=false ) {
3854 if ( $length !== false ) {
3855 $realLen = strlen( $data );
3856 if ( $realLen < $length ) {
3857 throw new MWException( "Tried to use wfUnpack on a "
3858 . "string of length $realLen, but needed one "
3859 . "of at least length $length."
3864 wfSuppressWarnings();
3865 $result = unpack( $format, $data );
3866 wfRestoreWarnings();
3868 if ( $result === false ) {
3869 // If it cannot extract the packed data.
3870 throw new MWException( "unpack could not unpack binary data" );
3876 * Determine if an image exists on the 'bad image list'.
3878 * The format of MediaWiki:Bad_image_list is as follows:
3879 * * Only list items (lines starting with "*") are considered
3880 * * The first link on a line must be a link to a bad image
3881 * * Any subsequent links on the same line are considered to be exceptions,
3882 * i.e. articles where the image may occur inline.
3884 * @param $name string the image name to check
3885 * @param $contextTitle Title|bool the page on which the image occurs, if known
3886 * @param $blacklist string wikitext of a file blacklist
3889 function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
3890 static $badImageCache = null; // based on bad_image_list msg
3891 wfProfileIn( __METHOD__
);
3894 $redirectTitle = RepoGroup
::singleton()->checkRedirect( Title
::makeTitle( NS_FILE
, $name ) );
3895 if( $redirectTitle ) {
3896 $name = $redirectTitle->getDbKey();
3899 # Run the extension hook
3901 if( !wfRunHooks( 'BadImage', array( $name, &$bad ) ) ) {
3902 wfProfileOut( __METHOD__
);
3906 $cacheable = ( $blacklist === null );
3907 if( $cacheable && $badImageCache !== null ) {
3908 $badImages = $badImageCache;
3909 } else { // cache miss
3910 if ( $blacklist === null ) {
3911 $blacklist = wfMessage( 'bad_image_list' )->inContentLanguage()->plain(); // site list
3913 # Build the list now
3914 $badImages = array();
3915 $lines = explode( "\n", $blacklist );
3916 foreach( $lines as $line ) {
3918 if ( substr( $line, 0, 1 ) !== '*' ) {
3924 if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
3928 $exceptions = array();
3929 $imageDBkey = false;
3930 foreach ( $m[1] as $i => $titleText ) {
3931 $title = Title
::newFromText( $titleText );
3932 if ( !is_null( $title ) ) {
3934 $imageDBkey = $title->getDBkey();
3936 $exceptions[$title->getPrefixedDBkey()] = true;
3941 if ( $imageDBkey !== false ) {
3942 $badImages[$imageDBkey] = $exceptions;
3946 $badImageCache = $badImages;
3950 $contextKey = $contextTitle ?
$contextTitle->getPrefixedDBkey() : false;
3951 $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
3952 wfProfileOut( __METHOD__
);