3 * Global functions used everywhere
7 if ( !defined( 'MEDIAWIKI' ) ) {
8 die( "This file is part of MediaWiki, it is not a valid entry point" );
11 // Hide compatibility functions from Doxygen
15 * Compatibility functions
17 * We support PHP 5.2.3 and up.
18 * Re-implementations of newer functions or functions in non-standard
19 * PHP extensions may be included here.
22 if( !function_exists( 'iconv' ) ) {
23 /** @codeCoverageIgnore */
24 function iconv( $from, $to, $string ) {
25 return Fallback
::iconv( $from, $to, $string );
29 if ( !function_exists( 'mb_substr' ) ) {
30 /** @codeCoverageIgnore */
31 function mb_substr( $str, $start, $count='end' ) {
32 return Fallback
::mb_substr( $str, $start, $count );
35 /** @codeCoverageIgnore */
36 function mb_substr_split_unicode( $str, $splitPos ) {
37 return Fallback
::mb_substr_split_unicode( $str, $splitPos );
41 if ( !function_exists( 'mb_strlen' ) ) {
42 /** @codeCoverageIgnore */
43 function mb_strlen( $str, $enc = '' ) {
44 return Fallback
::mb_strlen( $str, $enc );
48 if( !function_exists( 'mb_strpos' ) ) {
49 /** @codeCoverageIgnore */
50 function mb_strpos( $haystack, $needle, $offset = 0, $encoding = '' ) {
51 return Fallback
::mb_strpos( $haystack, $needle, $offset, $encoding );
56 if( !function_exists( 'mb_strrpos' ) ) {
57 /** @codeCoverageIgnore */
58 function mb_strrpos( $haystack, $needle, $offset = 0, $encoding = '' ) {
59 return Fallback
::mb_strrpos( $haystack, $needle, $offset, $encoding );
64 // Support for Wietse Venema's taint feature
65 if ( !function_exists( 'istainted' ) ) {
66 /** @codeCoverageIgnore */
67 function istainted( $var ) {
70 /** @codeCoverageIgnore */
71 function taint( $var, $level = 0 ) {}
72 /** @codeCoverageIgnore */
73 function untaint( $var, $level = 0 ) {}
74 define( 'TC_HTML', 1 );
75 define( 'TC_SHELL', 1 );
76 define( 'TC_MYSQL', 1 );
77 define( 'TC_PCRE', 1 );
78 define( 'TC_SELF', 1 );
83 * Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
88 function wfArrayDiff2( $a, $b ) {
89 return array_udiff( $a, $b, 'wfArrayDiff2_cmp' );
97 function wfArrayDiff2_cmp( $a, $b ) {
98 if ( !is_array( $a ) ) {
99 return strcmp( $a, $b );
100 } elseif ( count( $a ) !== count( $b ) ) {
101 return count( $a ) < count( $b ) ?
-1 : 1;
105 while( ( list( , $valueA ) = each( $a ) ) && ( list( , $valueB ) = each( $b ) ) ) {
106 $cmp = strcmp( $valueA, $valueB );
117 * Returns an array where the values in the first array are replaced by the
118 * values in the second array with the corresponding keys
124 function wfArrayLookup( $a, $b ) {
125 return array_flip( array_intersect( array_flip( $a ), array_keys( $b ) ) );
129 * Appends to second array if $value differs from that in $default
131 * @param $key String|Int
132 * @param $value Mixed
133 * @param $default Mixed
134 * @param $changed Array to alter
136 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
137 if ( is_null( $changed ) ) {
138 throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' );
140 if ( $default[$key] !== $value ) {
141 $changed[$key] = $value;
146 * Backwards array plus for people who haven't bothered to read the PHP manual
147 * XXX: will not darn your socks for you.
149 * @param $array1 Array
150 * @param [$array2, [...]] Arrays
153 function wfArrayMerge( $array1/* ... */ ) {
154 $args = func_get_args();
155 $args = array_reverse( $args, true );
157 foreach ( $args as $arg ) {
164 * Merge arrays in the style of getUserPermissionsErrors, with duplicate removal
166 * wfMergeErrorArrays(
167 * array( array( 'x' ) ),
168 * array( array( 'x', '2' ) ),
169 * array( array( 'x' ) ),
170 * array( array( 'y' ) )
181 function wfMergeErrorArrays( /*...*/ ) {
182 $args = func_get_args();
184 foreach ( $args as $errors ) {
185 foreach ( $errors as $params ) {
186 # @todo FIXME: Sometimes get nested arrays for $params,
187 # which leads to E_NOTICEs
188 $spec = implode( "\t", $params );
189 $out[$spec] = $params;
192 return array_values( $out );
196 * Insert array into another array after the specified *KEY*
198 * @param $array Array: The array.
199 * @param $insert Array: The array to insert.
200 * @param $after Mixed: The key to insert after
203 function wfArrayInsertAfter( $array, $insert, $after ) {
204 // Find the offset of the element to insert after.
205 $keys = array_keys( $array );
206 $offsetByKey = array_flip( $keys );
208 $offset = $offsetByKey[$after];
210 // Insert at the specified offset
211 $before = array_slice( $array, 0, $offset +
1, true );
212 $after = array_slice( $array, $offset +
1, count( $array ) - $offset, true );
214 $output = $before +
$insert +
$after;
220 * Recursively converts the parameter (an object) to an array with the same data
222 * @param $objOrArray Object|Array
223 * @param $recursive Bool
226 function wfObjectToArray( $objOrArray, $recursive = true ) {
228 if( is_object( $objOrArray ) ) {
229 $objOrArray = get_object_vars( $objOrArray );
231 foreach ( $objOrArray as $key => $value ) {
232 if ( $recursive && ( is_object( $value ) ||
is_array( $value ) ) ) {
233 $value = wfObjectToArray( $value );
236 $array[$key] = $value;
243 * Wrapper around array_map() which also taints variables
245 * @param $function Callback
246 * @param $input Array
249 function wfArrayMap( $function, $input ) {
250 $ret = array_map( $function, $input );
251 foreach ( $ret as $key => $value ) {
252 $taint = istainted( $input[$key] );
254 taint( $ret[$key], $taint );
261 * Get a random decimal value between 0 and 1, in a way
262 * not likely to give duplicate values for any realistic
263 * number of articles.
267 function wfRandom() {
268 # The maximum random value is "only" 2^31-1, so get two random
269 # values to reduce the chance of dupes
270 $max = mt_getrandmax() +
1;
271 $rand = number_format( ( mt_rand() * $max +
mt_rand() )
272 / $max / $max, 12, '.', '' );
277 * We want some things to be included as literal characters in our title URLs
278 * for prettiness, which urlencode encodes by default. According to RFC 1738,
279 * all of the following should be safe:
283 * But + is not safe because it's used to indicate a space; &= are only safe in
284 * paths and not in queries (and we don't distinguish here); ' seems kind of
285 * scary; and urlencode() doesn't touch -_. to begin with. Plus, although /
286 * is reserved, we don't care. So the list we unescape is:
290 * However, IIS7 redirects fail when the url contains a colon (Bug 22709),
291 * so no fancy : for IIS7.
293 * %2F in the page titles seems to fatally break for some reason.
298 function wfUrlencode( $s ) {
300 if ( is_null( $s ) ) {
305 if ( is_null( $needle ) ) {
306 $needle = array( '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F' );
307 if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) ||
( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false ) ) {
312 $s = urlencode( $s );
315 array( ';', '@', '$', '!', '*', '(', ')', ',', '/', ':' ),
323 * This function takes two arrays as input, and returns a CGI-style string, e.g.
324 * "days=7&limit=100". Options in the first array override options in the second.
325 * Options set to "" will not be output.
327 * @param $array1 Array ( String|Array )
328 * @param $array2 Array ( String|Array )
329 * @param $prefix String
332 function wfArrayToCGI( $array1, $array2 = null, $prefix = '' ) {
333 if ( !is_null( $array2 ) ) {
334 $array1 = $array1 +
$array2;
338 foreach ( $array1 as $key => $value ) {
339 if ( $value !== '' ) {
343 if ( $prefix !== '' ) {
344 $key = $prefix . "[$key]";
346 if ( is_array( $value ) ) {
348 foreach ( $value as $k => $v ) {
349 $cgi .= $firstTime ?
'' : '&';
350 if ( is_array( $v ) ) {
351 $cgi .= wfArrayToCGI( $v, null, $key . "[$k]" );
353 $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v );
358 if ( is_object( $value ) ) {
359 $value = $value->__toString();
361 $cgi .= urlencode( $key ) . '=' . urlencode( $value );
369 * This is the logical opposite of wfArrayToCGI(): it accepts a query string as
370 * its argument and returns the same string in array form. This allows compa-
371 * tibility with legacy functions that accept raw query strings instead of nice
372 * arrays. Of course, keys and values are urldecode()d. Don't try passing in-
373 * valid query strings, or it will explode.
375 * @param $query String: query string
376 * @return array Array version of input
378 function wfCgiToArray( $query ) {
379 if ( isset( $query[0] ) && $query[0] == '?' ) {
380 $query = substr( $query, 1 );
382 $bits = explode( '&', $query );
384 foreach ( $bits as $bit ) {
388 list( $key, $value ) = explode( '=', $bit );
389 $key = urldecode( $key );
390 $value = urldecode( $value );
391 if ( strpos( $key, '[' ) !== false ) {
392 $keys = array_reverse( explode( '[', $key ) );
393 $key = array_pop( $keys );
395 foreach ( $keys as $k ) {
396 $k = substr( $k, 0, -1 );
397 $temp = array( $k => $temp );
399 if ( isset( $ret[$key] ) ) {
400 $ret[$key] = array_merge( $ret[$key], $temp );
412 * Append a query string to an existing URL, which may or may not already
413 * have query string parameters already. If so, they will be combined.
416 * @param $query Mixed: string or associative array
419 function wfAppendQuery( $url, $query ) {
420 if ( is_array( $query ) ) {
421 $query = wfArrayToCGI( $query );
424 if( false === strpos( $url, '?' ) ) {
435 * Expand a potentially local URL to a fully-qualified URL. Assumes $wgServer
438 * The meaning of the PROTO_* constants is as follows:
439 * PROTO_HTTP: Output a URL starting with http://
440 * PROTO_HTTPS: Output a URL starting with https://
441 * PROTO_RELATIVE: Output a URL starting with // (protocol-relative URL)
442 * PROTO_CURRENT: Output a URL starting with either http:// or https:// , depending on which protocol was used for the current incoming request
443 * PROTO_CANONICAL: For URLs without a domain, like /w/index.php , use $wgCanonicalServer. For protocol-relative URLs, use the protocol of $wgCanonicalServer
444 * PROTO_INTERNAL: Like PROTO_CANONICAL, but uses $wgInternalServer instead of $wgCanonicalServer
446 * @todo this won't work with current-path-relative URLs
447 * like "subdir/foo.html", etc.
449 * @param $url String: either fully-qualified or a local path + query
450 * @param $defaultProto Mixed: one of the PROTO_* constants. Determines the
451 * protocol to use if $url or $wgServer is
453 * @return string Fully-qualified URL, current-path-relative URL or false if
454 * no valid URL can be constructed
456 function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT
) {
457 global $wgServer, $wgCanonicalServer, $wgInternalServer;
458 $serverUrl = $wgServer;
459 if ( $defaultProto === PROTO_CANONICAL
) {
460 $serverUrl = $wgCanonicalServer;
462 // Make $wgInternalServer fall back to $wgServer if not set
463 if ( $defaultProto === PROTO_INTERNAL
&& $wgInternalServer !== false ) {
464 $serverUrl = $wgInternalServer;
466 if ( $defaultProto === PROTO_CURRENT
) {
467 $defaultProto = WebRequest
::detectProtocol() . '://';
470 // Analyze $serverUrl to obtain its protocol
471 $bits = wfParseUrl( $serverUrl );
472 $serverHasProto = $bits && $bits['scheme'] != '';
474 if ( $defaultProto === PROTO_CANONICAL ||
$defaultProto === PROTO_INTERNAL
) {
475 if ( $serverHasProto ) {
476 $defaultProto = $bits['scheme'] . '://';
478 // $wgCanonicalServer or $wgInternalServer doesn't have a protocol. This really isn't supposed to happen
479 // Fall back to HTTP in this ridiculous case
480 $defaultProto = PROTO_HTTP
;
484 $defaultProtoWithoutSlashes = substr( $defaultProto, 0, -2 );
486 if ( substr( $url, 0, 2 ) == '//' ) {
487 $url = $defaultProtoWithoutSlashes . $url;
488 } elseif ( substr( $url, 0, 1 ) == '/' ) {
489 // If $serverUrl is protocol-relative, prepend $defaultProtoWithoutSlashes, otherwise leave it alone
490 $url = ( $serverHasProto ?
'' : $defaultProtoWithoutSlashes ) . $serverUrl . $url;
493 $bits = wfParseUrl( $url );
494 if ( $bits && isset( $bits['path'] ) ) {
495 $bits['path'] = wfRemoveDotSegments( $bits['path'] );
496 return wfAssembleUrl( $bits );
500 } elseif ( substr( $url, 0, 1 ) != '/' ) {
501 # URL is a relative path
502 return wfRemoveDotSegments( $url );
505 # Expanded URL is not valid.
510 * This function will reassemble a URL parsed with wfParseURL. This is useful
511 * if you need to edit part of a URL and put it back together.
513 * This is the basic structure used (brackets contain keys for $urlParts):
514 * [scheme][delimiter][user]:[pass]@[host]:[port][path]?[query]#[fragment]
516 * @todo Need to integrate this into wfExpandUrl (bug 32168)
518 * @param $urlParts Array URL parts, as output from wfParseUrl
519 * @return string URL assembled from its component parts
521 function wfAssembleUrl( $urlParts ) {
524 if ( isset( $urlParts['delimiter'] ) ) {
525 if ( isset( $urlParts['scheme'] ) ) {
526 $result .= $urlParts['scheme'];
529 $result .= $urlParts['delimiter'];
532 if ( isset( $urlParts['host'] ) ) {
533 if ( isset( $urlParts['user'] ) ) {
534 $result .= $urlParts['user'];
535 if ( isset( $urlParts['pass'] ) ) {
536 $result .= ':' . $urlParts['pass'];
541 $result .= $urlParts['host'];
543 if ( isset( $urlParts['port'] ) ) {
544 $result .= ':' . $urlParts['port'];
548 if ( isset( $urlParts['path'] ) ) {
549 $result .= $urlParts['path'];
552 if ( isset( $urlParts['query'] ) ) {
553 $result .= '?' . $urlParts['query'];
556 if ( isset( $urlParts['fragment'] ) ) {
557 $result .= '#' . $urlParts['fragment'];
564 * Remove all dot-segments in the provided URL path. For example,
565 * '/a/./b/../c/' becomes '/a/c/'. For details on the algorithm, please see
566 * RFC3986 section 5.2.4.
568 * @todo Need to integrate this into wfExpandUrl (bug 32168)
570 * @param $urlPath String URL path, potentially containing dot-segments
571 * @return string URL path with all dot-segments removed
573 function wfRemoveDotSegments( $urlPath ) {
578 if ( preg_match('%^\.\.?/%', $urlPath, $matches) ) {
579 # Step A, remove leading "../" or "./"
580 $urlPath = substr( $urlPath, strlen( $matches[0] ) );
581 } elseif ( preg_match( '%^/\.(/|$)%', $urlPath, $matches ) ) {
582 # Step B, replace leading "/.$" or "/./" with "/"
583 $start = strlen( $matches[0] );
584 $urlPath = '/' . substr( $urlPath, $start );
585 } elseif ( preg_match( '%^/\.\.(/|$)%', $urlPath, $matches ) ) {
586 # Step C, replace leading "/..$" or "/../" with "/" and
587 # remove last path component in output
588 $start = strlen( $matches[0] );
589 $urlPath = '/' . substr( $urlPath, $start );
590 $output = preg_replace('%(^|/)[^/]*$%', '', $output);
591 } elseif ( preg_match( '%^\.\.?$%', $urlPath, $matches ) ) {
592 # Step D, remove "^..$" or "^.$"
595 # Step E, move leading path segment to output
596 preg_match( '%^/?[^/]*%', $urlPath, $matches );
597 $urlPath = substr( $urlPath, strlen( $matches[0] ) );
598 $output .= $matches[0];
606 * Returns a regular expression of url protocols
608 * @param $includeProtocolRelative bool If false, remove '//' from the returned protocol list.
609 * DO NOT USE this directly, use wfUrlProtocolsWithoutProtRel() instead
612 function wfUrlProtocols( $includeProtocolRelative = true ) {
613 global $wgUrlProtocols;
615 // Cache return values separately based on $includeProtocolRelative
616 static $withProtRel = null, $withoutProtRel = null;
617 $cachedValue = $includeProtocolRelative ?
$withProtRel : $withoutProtRel;
618 if ( !is_null( $cachedValue ) ) {
622 // Support old-style $wgUrlProtocols strings, for backwards compatibility
623 // with LocalSettings files from 1.5
624 if ( is_array( $wgUrlProtocols ) ) {
625 $protocols = array();
626 foreach ( $wgUrlProtocols as $protocol ) {
627 // Filter out '//' if !$includeProtocolRelative
628 if ( $includeProtocolRelative ||
$protocol !== '//' ) {
629 $protocols[] = preg_quote( $protocol, '/' );
633 $retval = implode( '|', $protocols );
635 // Ignore $includeProtocolRelative in this case
636 // This case exists for pre-1.6 compatibility, and we can safely assume
637 // that '//' won't appear in a pre-1.6 config because protocol-relative
638 // URLs weren't supported until 1.18
639 $retval = $wgUrlProtocols;
642 // Cache return value
643 if ( $includeProtocolRelative ) {
644 $withProtRel = $retval;
646 $withoutProtRel = $retval;
652 * Like wfUrlProtocols(), but excludes '//' from the protocol list. Use this if
653 * you need a regex that matches all URL protocols but does not match protocol-
657 function wfUrlProtocolsWithoutProtRel() {
658 return wfUrlProtocols( false );
662 * parse_url() work-alike, but non-broken. Differences:
664 * 1) Does not raise warnings on bad URLs (just returns false)
665 * 2) Handles protocols that don't use :// (e.g., mailto: and news: , as well as protocol-relative URLs) correctly
666 * 3) Adds a "delimiter" element to the array, either '://', ':' or '//' (see (2))
668 * @param $url String: a URL to parse
669 * @return Array: bits of the URL in an associative array, per PHP docs
671 function wfParseUrl( $url ) {
672 global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
674 // Protocol-relative URLs are handled really badly by parse_url(). It's so bad that the easiest
675 // way to handle them is to just prepend 'http:' and strip the protocol out later
676 $wasRelative = substr( $url, 0, 2 ) == '//';
677 if ( $wasRelative ) {
680 wfSuppressWarnings();
681 $bits = parse_url( $url );
683 // parse_url() returns an array without scheme for some invalid URLs, e.g.
684 // parse_url("%0Ahttp://example.com") == array( 'host' => '%0Ahttp', 'path' => 'example.com' )
685 if ( !$bits ||
!isset( $bits['scheme'] ) ) {
689 // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
690 if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
691 $bits['delimiter'] = '://';
692 } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
693 $bits['delimiter'] = ':';
694 // parse_url detects for news: and mailto: the host part of an url as path
695 // We have to correct this wrong detection
696 if ( isset( $bits['path'] ) ) {
697 $bits['host'] = $bits['path'];
704 /* Provide an empty host for eg. file:/// urls (see bug 28627) */
705 if ( !isset( $bits['host'] ) ) {
708 /* parse_url loses the third / for file:///c:/ urls (but not on variants) */
709 if ( substr( $bits['path'], 0, 1 ) !== '/' ) {
710 $bits['path'] = '/' . $bits['path'];
714 // If the URL was protocol-relative, fix scheme and delimiter
715 if ( $wasRelative ) {
716 $bits['scheme'] = '';
717 $bits['delimiter'] = '//';
723 * Make URL indexes, appropriate for the el_index field of externallinks.
728 function wfMakeUrlIndexes( $url ) {
729 $bits = wfParseUrl( $url );
731 // Reverse the labels in the hostname, convert to lower case
732 // For emails reverse domainpart only
733 if ( $bits['scheme'] == 'mailto' ) {
734 $mailparts = explode( '@', $bits['host'], 2 );
735 if ( count( $mailparts ) === 2 ) {
736 $domainpart = strtolower( implode( '.', array_reverse( explode( '.', $mailparts[1] ) ) ) );
738 // No domain specified, don't mangle it
741 $reversedHost = $domainpart . '@' . $mailparts[0];
743 $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) );
745 // Add an extra dot to the end
746 // Why? Is it in wrong place in mailto links?
747 if ( substr( $reversedHost, -1, 1 ) !== '.' ) {
748 $reversedHost .= '.';
750 // Reconstruct the pseudo-URL
751 $prot = $bits['scheme'];
752 $index = $prot . $bits['delimiter'] . $reversedHost;
753 // Leave out user and password. Add the port, path, query and fragment
754 if ( isset( $bits['port'] ) ) {
755 $index .= ':' . $bits['port'];
757 if ( isset( $bits['path'] ) ) {
758 $index .= $bits['path'];
762 if ( isset( $bits['query'] ) ) {
763 $index .= '?' . $bits['query'];
765 if ( isset( $bits['fragment'] ) ) {
766 $index .= '#' . $bits['fragment'];
770 return array( "http:$index", "https:$index" );
772 return array( $index );
777 * Check whether a given URL has a domain that occurs in a given set of domains
778 * @param $url string URL
779 * @param $domains array Array of domains (strings)
780 * @return bool True if the host part of $url ends in one of the strings in $domains
782 function wfMatchesDomainList( $url, $domains ) {
783 $bits = wfParseUrl( $url );
784 if ( is_array( $bits ) && isset( $bits['host'] ) ) {
785 foreach ( (array)$domains as $domain ) {
786 // FIXME: This gives false positives. http://nds-nl.wikipedia.org will match nl.wikipedia.org
787 // We should use something that interprets dots instead
788 if ( substr( $bits['host'], -strlen( $domain ) ) === $domain ) {
797 * Sends a line to the debug log if enabled or, optionally, to a comment in output.
798 * In normal operation this is a NOP.
800 * Controlling globals:
801 * $wgDebugLogFile - points to the log file
802 * $wgProfileOnly - if set, normal debug messages will not be recorded.
803 * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
804 * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
806 * @param $text String
807 * @param $logonly Bool: set true to avoid appearing in HTML when $wgDebugComments is set
809 function wfDebug( $text, $logonly = false ) {
810 global $wgOut, $wgDebugLogFile, $wgDebugComments, $wgProfileOnly, $wgDebugRawPage;
811 global $wgDebugLogPrefix, $wgShowDebug;
813 static $cache = array(); // Cache of unoutputted messages
814 $text = wfDebugTimer() . $text;
816 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
820 if ( ( $wgDebugComments ||
$wgShowDebug ) && !$logonly ) {
823 if ( isset( $wgOut ) && is_object( $wgOut ) ) {
824 // add the message and any cached messages to the output
825 array_map( array( $wgOut, 'debug' ), $cache );
829 if ( wfRunHooks( 'Debug', array( $text, null /* no log group */ ) ) ) {
830 if ( $wgDebugLogFile != '' && !$wgProfileOnly ) {
831 # Strip unprintables; they can switch terminal modes when binary data
832 # gets dumped, which is pretty annoying.
833 $text = preg_replace( '![\x00-\x08\x0b\x0c\x0e-\x1a\x1c-\x1f]!', ' ', $text );
834 $text = $wgDebugLogPrefix . $text;
835 wfErrorLog( $text, $wgDebugLogFile );
841 * Returns true if debug logging should be suppressed if $wgDebugRawPage = false
843 function wfIsDebugRawPage() {
845 if ( $cache !== null ) {
848 # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
849 if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
851 isset( $_SERVER['SCRIPT_NAME'] )
852 && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
863 * Get microsecond timestamps for debug logs
867 function wfDebugTimer() {
868 global $wgDebugTimestamps;
869 if ( !$wgDebugTimestamps ) {
872 static $start = null;
874 if ( $start === null ) {
875 $start = microtime( true );
876 $prefix = "\n$start";
878 $prefix = sprintf( "%6.4f", microtime( true ) - $start );
880 $mem = sprintf( "%5.1fM", ( memory_get_usage( true ) / (1024*1024) ) );
881 return "$prefix $mem " ;
885 * Send a line giving PHP memory usage.
887 * @param $exact Bool: print exact values instead of kilobytes (default: false)
889 function wfDebugMem( $exact = false ) {
890 $mem = memory_get_usage();
892 $mem = floor( $mem / 1024 ) . ' kilobytes';
896 wfDebug( "Memory usage: $mem\n" );
900 * Send a line to a supplementary debug log file, if configured, or main debug log if not.
901 * $wgDebugLogGroups[$logGroup] should be set to a filename to send to a separate log.
903 * @param $logGroup String
904 * @param $text String
905 * @param $public Bool: whether to log the event in the public log if no private
906 * log file is specified, (default true)
908 function wfDebugLog( $logGroup, $text, $public = true ) {
909 global $wgDebugLogGroups, $wgShowHostnames;
910 $text = trim( $text ) . "\n";
911 if( isset( $wgDebugLogGroups[$logGroup] ) ) {
912 $time = wfTimestamp( TS_DB
);
914 if ( $wgShowHostnames ) {
915 $host = wfHostname();
919 if ( wfRunHooks( 'Debug', array( $text, $logGroup ) ) ) {
920 wfErrorLog( "$time $host $wiki: $text", $wgDebugLogGroups[$logGroup] );
922 } elseif ( $public === true ) {
923 wfDebug( $text, true );
928 * Log for database errors
930 * @param $text String: database error message.
932 function wfLogDBError( $text ) {
933 global $wgDBerrorLog, $wgDBname;
934 if ( $wgDBerrorLog ) {
935 $host = trim(`hostname`
);
936 $text = date( 'D M j G:i:s T Y' ) . "\t$host\t$wgDBname\t$text";
937 wfErrorLog( $text, $wgDBerrorLog );
942 * Log to a file without getting "file size exceeded" signals.
944 * Can also log to TCP or UDP with the syntax udp://host:port/prefix. This will
945 * send lines to the specified port, prefixed by the specified prefix and a space.
947 * @param $text String
948 * @param $file String filename
950 function wfErrorLog( $text, $file ) {
951 if ( substr( $file, 0, 4 ) == 'udp:' ) {
952 # Needs the sockets extension
953 if ( preg_match( '!^(tcp|udp):(?://)?\[([0-9a-fA-F:]+)\]:(\d+)(?:/(.*))?$!', $file, $m ) ) {
954 // IPv6 bracketed host
956 $port = intval( $m[3] );
957 $prefix = isset( $m[4] ) ?
$m[4] : false;
959 } elseif ( preg_match( '!^(tcp|udp):(?://)?([a-zA-Z0-9.-]+):(\d+)(?:/(.*))?$!', $file, $m ) ) {
961 if ( !IP
::isIPv4( $host ) ) {
962 $host = gethostbyname( $host );
964 $port = intval( $m[3] );
965 $prefix = isset( $m[4] ) ?
$m[4] : false;
968 throw new MWException( __METHOD__
. ': Invalid UDP specification' );
971 // Clean it up for the multiplexer
972 if ( strval( $prefix ) !== '' ) {
973 $text = preg_replace( '/^/m', $prefix . ' ', $text );
976 if ( strlen( $text ) > 65506 ) {
977 $text = substr( $text, 0, 65506 );
980 if ( substr( $text, -1 ) != "\n" ) {
983 } elseif ( strlen( $text ) > 65507 ) {
984 $text = substr( $text, 0, 65507 );
987 $sock = socket_create( $domain, SOCK_DGRAM
, SOL_UDP
);
992 socket_sendto( $sock, $text, strlen( $text ), 0, $host, $port );
993 socket_close( $sock );
995 wfSuppressWarnings();
996 $exists = file_exists( $file );
997 $size = $exists ?
filesize( $file ) : false;
998 if ( !$exists ||
( $size !== false && $size +
strlen( $text ) < 0x7fffffff ) ) {
999 file_put_contents( $file, $text, FILE_APPEND
);
1001 wfRestoreWarnings();
1008 function wfLogProfilingData() {
1009 global $wgRequestTime, $wgDebugLogFile, $wgDebugRawPage, $wgRequest;
1010 global $wgProfileLimit, $wgUser;
1012 $profiler = Profiler
::instance();
1014 # Profiling must actually be enabled...
1015 if ( $profiler->isStub() ) {
1019 // Get total page request time and only show pages that longer than
1020 // $wgProfileLimit time (default is 0)
1022 $elapsed = $now - $wgRequestTime;
1023 if ( $elapsed <= $wgProfileLimit ) {
1027 $profiler->logData();
1029 // Check whether this should be logged in the debug file.
1030 if ( $wgDebugLogFile == '' ||
( !$wgDebugRawPage && wfIsDebugRawPage() ) ) {
1035 if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1036 $forward = ' forwarded for ' . $_SERVER['HTTP_X_FORWARDED_FOR'];
1038 if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1039 $forward .= ' client IP ' . $_SERVER['HTTP_CLIENT_IP'];
1041 if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1042 $forward .= ' from ' . $_SERVER['HTTP_FROM'];
1045 $forward = "\t(proxied via {$_SERVER['REMOTE_ADDR']}{$forward})";
1047 // Don't load $wgUser at this late stage just for statistics purposes
1048 // @todo FIXME: We can detect some anons even if it is not loaded. See User::getId()
1049 if ( $wgUser->isItemLoaded( 'id' ) && $wgUser->isAnon() ) {
1050 $forward .= ' anon';
1052 $log = sprintf( "%s\t%04.3f\t%s\n",
1053 gmdate( 'YmdHis' ), $elapsed,
1054 urldecode( $wgRequest->getRequestURL() . $forward ) );
1056 wfErrorLog( $log . $profiler->getOutput(), $wgDebugLogFile );
1060 * Check if the wiki read-only lock file is present. This can be used to lock
1061 * off editing functions, but doesn't guarantee that the database will not be
1066 function wfReadOnly() {
1067 global $wgReadOnlyFile, $wgReadOnly;
1069 if ( !is_null( $wgReadOnly ) ) {
1070 return (bool)$wgReadOnly;
1072 if ( $wgReadOnlyFile == '' ) {
1075 // Set $wgReadOnly for faster access next time
1076 if ( is_file( $wgReadOnlyFile ) ) {
1077 $wgReadOnly = file_get_contents( $wgReadOnlyFile );
1079 $wgReadOnly = false;
1081 return (bool)$wgReadOnly;
1087 function wfReadOnlyReason() {
1094 * Return a Language object from $langcode
1096 * @param $langcode Mixed: either:
1097 * - a Language object
1098 * - code of the language to get the message for, if it is
1099 * a valid code create a language for that language, if
1100 * it is a string but not a valid code then make a basic
1102 * - a boolean: if it's false then use the global object for
1103 * the current user's language (as a fallback for the old parameter
1104 * functionality), or if it is true then use global object
1105 * for the wiki's content language.
1106 * @return Language object
1108 function wfGetLangObj( $langcode = false ) {
1109 # Identify which language to get or create a language object for.
1110 # Using is_object here due to Stub objects.
1111 if( is_object( $langcode ) ) {
1112 # Great, we already have the object (hopefully)!
1116 global $wgContLang, $wgLanguageCode;
1117 if( $langcode === true ||
$langcode === $wgLanguageCode ) {
1118 # $langcode is the language code of the wikis content language object.
1119 # or it is a boolean and value is true
1124 if( $langcode === false ||
$langcode === $wgLang->getCode() ) {
1125 # $langcode is the language code of user language object.
1126 # or it was a boolean and value is false
1130 $validCodes = array_keys( Language
::getLanguageNames() );
1131 if( in_array( $langcode, $validCodes ) ) {
1132 # $langcode corresponds to a valid language.
1133 return Language
::factory( $langcode );
1136 # $langcode is a string, but not a valid language code; use content language.
1137 wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1142 * Old function when $wgBetterDirectionality existed
1143 * Removed in core, kept in extensions for backwards compat.
1145 * @deprecated since 1.18
1148 function wfUILang() {
1154 * This is the new function for getting translated interface messages.
1155 * See the Message class for documentation how to use them.
1156 * The intention is that this function replaces all old wfMsg* functions.
1157 * @param $key \string Message key.
1158 * Varargs: normal message parameters.
1162 function wfMessage( $key /*...*/) {
1163 $params = func_get_args();
1164 array_shift( $params );
1165 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
1166 $params = $params[0];
1168 return new Message( $key, $params );
1172 * This function accepts multiple message keys and returns a message instance
1173 * for the first message which is non-empty. If all messages are empty then an
1174 * instance of the first message key is returned.
1175 * @param varargs: message keys
1179 function wfMessageFallback( /*...*/ ) {
1180 $args = func_get_args();
1181 return MWFunction
::callArray( 'Message::newFallbackSequence', $args );
1185 * Get a message from anywhere, for the current user language.
1187 * Use wfMsgForContent() instead if the message should NOT
1188 * change depending on the user preferences.
1190 * @param $key String: lookup key for the message, usually
1191 * defined in languages/Language.php
1193 * Parameters to the message, which can be used to insert variable text into
1194 * it, can be passed to this function in the following formats:
1195 * - One per argument, starting at the second parameter
1196 * - As an array in the second parameter
1197 * These are not shown in the function definition.
1201 function wfMsg( $key ) {
1202 $args = func_get_args();
1203 array_shift( $args );
1204 return wfMsgReal( $key, $args );
1208 * Same as above except doesn't transform the message
1210 * @param $key String
1213 function wfMsgNoTrans( $key ) {
1214 $args = func_get_args();
1215 array_shift( $args );
1216 return wfMsgReal( $key, $args, true, false, false );
1220 * Get a message from anywhere, for the current global language
1221 * set with $wgLanguageCode.
1223 * Use this if the message should NOT change dependent on the
1224 * language set in the user's preferences. This is the case for
1225 * most text written into logs, as well as link targets (such as
1226 * the name of the copyright policy page). Link titles, on the
1227 * other hand, should be shown in the UI language.
1229 * Note that MediaWiki allows users to change the user interface
1230 * language in their preferences, but a single installation
1231 * typically only contains content in one language.
1233 * Be wary of this distinction: If you use wfMsg() where you should
1234 * use wfMsgForContent(), a user of the software may have to
1235 * customize potentially hundreds of messages in
1236 * order to, e.g., fix a link in every possible language.
1238 * @param $key String: lookup key for the message, usually
1239 * defined in languages/Language.php
1242 function wfMsgForContent( $key ) {
1243 global $wgForceUIMsgAsContentMsg;
1244 $args = func_get_args();
1245 array_shift( $args );
1247 if( is_array( $wgForceUIMsgAsContentMsg ) &&
1248 in_array( $key, $wgForceUIMsgAsContentMsg ) )
1250 $forcontent = false;
1252 return wfMsgReal( $key, $args, true, $forcontent );
1256 * Same as above except doesn't transform the message
1258 * @param $key String
1261 function wfMsgForContentNoTrans( $key ) {
1262 global $wgForceUIMsgAsContentMsg;
1263 $args = func_get_args();
1264 array_shift( $args );
1266 if( is_array( $wgForceUIMsgAsContentMsg ) &&
1267 in_array( $key, $wgForceUIMsgAsContentMsg ) )
1269 $forcontent = false;
1271 return wfMsgReal( $key, $args, true, $forcontent, false );
1275 * Really get a message
1277 * @param $key String: key to get.
1279 * @param $useDB Boolean
1280 * @param $forContent Mixed: Language code, or false for user lang, true for content lang.
1281 * @param $transform Boolean: Whether or not to transform the message.
1282 * @return String: the requested message.
1284 function wfMsgReal( $key, $args, $useDB = true, $forContent = false, $transform = true ) {
1285 wfProfileIn( __METHOD__
);
1286 $message = wfMsgGetKey( $key, $useDB, $forContent, $transform );
1287 $message = wfMsgReplaceArgs( $message, $args );
1288 wfProfileOut( __METHOD__
);
1293 * Fetch a message string value, but don't replace any keys yet.
1295 * @param $key String
1296 * @param $useDB Bool
1297 * @param $langCode String: Code of the language to get the message for, or
1298 * behaves as a content language switch if it is a boolean.
1299 * @param $transform Boolean: whether to parse magic words, etc.
1302 function wfMsgGetKey( $key, $useDB = true, $langCode = false, $transform = true ) {
1303 wfRunHooks( 'NormalizeMessageKey', array( &$key, &$useDB, &$langCode, &$transform ) );
1305 $cache = MessageCache
::singleton();
1306 $message = $cache->get( $key, $useDB, $langCode );
1307 if( $message === false ) {
1308 $message = '<' . htmlspecialchars( $key ) . '>';
1309 } elseif ( $transform ) {
1310 $message = $cache->transform( $message );
1316 * Replace message parameter keys on the given formatted output.
1318 * @param $message String
1319 * @param $args Array
1323 function wfMsgReplaceArgs( $message, $args ) {
1324 # Fix windows line-endings
1325 # Some messages are split with explode("\n", $msg)
1326 $message = str_replace( "\r", '', $message );
1328 // Replace arguments
1329 if ( count( $args ) ) {
1330 if ( is_array( $args[0] ) ) {
1331 $args = array_values( $args[0] );
1333 $replacementKeys = array();
1334 foreach( $args as $n => $param ) {
1335 $replacementKeys['$' . ( $n +
1 )] = $param;
1337 $message = strtr( $message, $replacementKeys );
1344 * Return an HTML-escaped version of a message.
1345 * Parameter replacements, if any, are done *after* the HTML-escaping,
1346 * so parameters may contain HTML (eg links or form controls). Be sure
1347 * to pre-escape them if you really do want plaintext, or just wrap
1348 * the whole thing in htmlspecialchars().
1350 * @param $key String
1351 * @param string ... parameters
1354 function wfMsgHtml( $key ) {
1355 $args = func_get_args();
1356 array_shift( $args );
1357 return wfMsgReplaceArgs( htmlspecialchars( wfMsgGetKey( $key ) ), $args );
1361 * Return an HTML version of message
1362 * Parameter replacements, if any, are done *after* parsing the wiki-text message,
1363 * so parameters may contain HTML (eg links or form controls). Be sure
1364 * to pre-escape them if you really do want plaintext, or just wrap
1365 * the whole thing in htmlspecialchars().
1367 * @param $key String
1368 * @param string ... parameters
1371 function wfMsgWikiHtml( $key ) {
1372 $args = func_get_args();
1373 array_shift( $args );
1374 return wfMsgReplaceArgs(
1375 MessageCache
::singleton()->parse( wfMsgGetKey( $key ), null,
1376 /* can't be set to false */ true, /* interface */ true )->getText(),
1381 * Returns message in the requested format
1382 * @param $key String: key of the message
1383 * @param $options Array: processing rules. Can take the following options:
1384 * <i>parse</i>: parses wikitext to HTML
1385 * <i>parseinline</i>: parses wikitext to HTML and removes the surrounding
1386 * p's added by parser or tidy
1387 * <i>escape</i>: filters message through htmlspecialchars
1388 * <i>escapenoentities</i>: same, but allows entity references like   through
1389 * <i>replaceafter</i>: parameters are substituted after parsing or escaping
1390 * <i>parsemag</i>: transform the message using magic phrases
1391 * <i>content</i>: fetch message for content language instead of interface
1392 * Also can accept a single associative argument, of the form 'language' => 'xx':
1393 * <i>language</i>: Language object or language code to fetch message for
1394 * (overriden by <i>content</i>).
1395 * Behavior for conflicting options (e.g., parse+parseinline) is undefined.
1399 function wfMsgExt( $key, $options ) {
1400 $args = func_get_args();
1401 array_shift( $args );
1402 array_shift( $args );
1403 $options = (array)$options;
1405 foreach( $options as $arrayKey => $option ) {
1406 if( !preg_match( '/^[0-9]+|language$/', $arrayKey ) ) {
1407 # An unknown index, neither numeric nor "language"
1408 wfWarn( "wfMsgExt called with incorrect parameter key $arrayKey", 1, E_USER_WARNING
);
1409 } elseif( preg_match( '/^[0-9]+$/', $arrayKey ) && !in_array( $option,
1410 array( 'parse', 'parseinline', 'escape', 'escapenoentities',
1411 'replaceafter', 'parsemag', 'content' ) ) ) {
1412 # A numeric index with unknown value
1413 wfWarn( "wfMsgExt called with incorrect parameter $option", 1, E_USER_WARNING
);
1417 if( in_array( 'content', $options, true ) ) {
1420 $langCodeObj = null;
1421 } elseif( array_key_exists( 'language', $options ) ) {
1422 $forContent = false;
1423 $langCode = wfGetLangObj( $options['language'] );
1424 $langCodeObj = $langCode;
1426 $forContent = false;
1428 $langCodeObj = null;
1431 $string = wfMsgGetKey( $key, /*DB*/true, $langCode, /*Transform*/false );
1433 if( !in_array( 'replaceafter', $options, true ) ) {
1434 $string = wfMsgReplaceArgs( $string, $args );
1437 $messageCache = MessageCache
::singleton();
1438 if( in_array( 'parse', $options, true ) ) {
1439 $string = $messageCache->parse( $string, null, true, !$forContent, $langCodeObj )->getText();
1440 } elseif ( in_array( 'parseinline', $options, true ) ) {
1441 $string = $messageCache->parse( $string, null, true, !$forContent, $langCodeObj )->getText();
1443 if( preg_match( '/^<p>(.*)\n?<\/p>\n?$/sU', $string, $m ) ) {
1446 } elseif ( in_array( 'parsemag', $options, true ) ) {
1447 $string = $messageCache->transform( $string,
1448 !$forContent, $langCodeObj );
1451 if ( in_array( 'escape', $options, true ) ) {
1452 $string = htmlspecialchars ( $string );
1453 } elseif ( in_array( 'escapenoentities', $options, true ) ) {
1454 $string = Sanitizer
::escapeHtmlAllowEntities( $string );
1457 if( in_array( 'replaceafter', $options, true ) ) {
1458 $string = wfMsgReplaceArgs( $string, $args );
1465 * Since wfMsg() and co suck, they don't return false if the message key they
1466 * looked up didn't exist but a XHTML string, this function checks for the
1467 * nonexistance of messages by checking the MessageCache::get() result directly.
1469 * @param $key String: the message key looked up
1470 * @return Boolean True if the message *doesn't* exist.
1472 function wfEmptyMsg( $key ) {
1473 return MessageCache
::singleton()->get( $key, /*useDB*/true, /*content*/false ) === false;
1477 * Throw a debugging exception. This function previously once exited the process,
1478 * but now throws an exception instead, with similar results.
1480 * @param $msg String: message shown when dying.
1482 function wfDebugDieBacktrace( $msg = '' ) {
1483 throw new MWException( $msg );
1487 * Fetch server name for use in error reporting etc.
1488 * Use real server name if available, so we know which machine
1489 * in a server farm generated the current page.
1493 function wfHostname() {
1495 if ( is_null( $host ) ) {
1496 if ( function_exists( 'posix_uname' ) ) {
1497 // This function not present on Windows
1498 $uname = posix_uname();
1502 if( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1503 $host = $uname['nodename'];
1504 } elseif ( getenv( 'COMPUTERNAME' ) ) {
1505 # Windows computer name
1506 $host = getenv( 'COMPUTERNAME' );
1508 # This may be a virtual server.
1509 $host = $_SERVER['SERVER_NAME'];
1516 * Returns a HTML comment with the elapsed time since request.
1517 * This method has no side effects.
1521 function wfReportTime() {
1522 global $wgRequestTime, $wgShowHostnames;
1525 $elapsed = $now - $wgRequestTime;
1527 return $wgShowHostnames
1528 ?
sprintf( '<!-- Served by %s in %01.3f secs. -->', wfHostname(), $elapsed )
1529 : sprintf( '<!-- Served in %01.3f secs. -->', $elapsed );
1533 * Safety wrapper for debug_backtrace().
1535 * With Zend Optimizer 3.2.0 loaded, this causes segfaults under somewhat
1536 * murky circumstances, which may be triggered in part by stub objects
1537 * or other fancy talkin'.
1539 * Will return an empty array if Zend Optimizer is detected or if
1540 * debug_backtrace is disabled, otherwise the output from
1541 * debug_backtrace() (trimmed).
1543 * @param $limit int This parameter can be used to limit the number of stack frames returned
1545 * @return array of backtrace information
1547 function wfDebugBacktrace( $limit = 0 ) {
1548 static $disabled = null;
1550 if( extension_loaded( 'Zend Optimizer' ) ) {
1551 wfDebug( "Zend Optimizer detected; skipping debug_backtrace for safety.\n" );
1555 if ( is_null( $disabled ) ) {
1557 $functions = explode( ',', ini_get( 'disable_functions' ) );
1558 $functions = array_map( 'trim', $functions );
1559 $functions = array_map( 'strtolower', $functions );
1560 if ( in_array( 'debug_backtrace', $functions ) ) {
1561 wfDebug( "debug_backtrace is in disabled_functions\n" );
1569 if ( $limit && version_compare( PHP_VERSION
, '5.4.0', '>=' ) ) {
1570 return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT
, $limit ), 1 );
1572 return array_slice( debug_backtrace(), 1 );
1577 * Get a debug backtrace as a string
1581 function wfBacktrace() {
1582 global $wgCommandLineMode;
1584 if ( $wgCommandLineMode ) {
1589 $backtrace = wfDebugBacktrace();
1590 foreach( $backtrace as $call ) {
1591 if( isset( $call['file'] ) ) {
1592 $f = explode( DIRECTORY_SEPARATOR
, $call['file'] );
1593 $file = $f[count( $f ) - 1];
1597 if( isset( $call['line'] ) ) {
1598 $line = $call['line'];
1602 if ( $wgCommandLineMode ) {
1603 $msg .= "$file line $line calls ";
1605 $msg .= '<li>' . $file . ' line ' . $line . ' calls ';
1607 if( !empty( $call['class'] ) ) {
1608 $msg .= $call['class'] . $call['type'];
1610 $msg .= $call['function'] . '()';
1612 if ( $wgCommandLineMode ) {
1618 if ( $wgCommandLineMode ) {
1628 * Get the name of the function which called this function
1631 * @return Bool|string
1633 function wfGetCaller( $level = 2 ) {
1634 $backtrace = wfDebugBacktrace( $level );
1635 if ( isset( $backtrace[$level] ) ) {
1636 return wfFormatStackFrame( $backtrace[$level] );
1638 $caller = 'unknown';
1644 * Return a string consisting of callers in the stack. Useful sometimes
1645 * for profiling specific points.
1647 * @param $limit The maximum depth of the stack frame to return, or false for
1651 function wfGetAllCallers( $limit = 3 ) {
1652 $trace = array_reverse( wfDebugBacktrace() );
1653 if ( !$limit ||
$limit > count( $trace ) - 1 ) {
1654 $limit = count( $trace ) - 1;
1656 $trace = array_slice( $trace, -$limit - 1, $limit );
1657 return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1661 * Return a string representation of frame
1663 * @param $frame Array
1666 function wfFormatStackFrame( $frame ) {
1667 return isset( $frame['class'] ) ?
1668 $frame['class'] . '::' . $frame['function'] :
1673 /* Some generic result counters, pulled out of SearchEngine */
1679 * @param $offset Int
1683 function wfShowingResults( $offset, $limit ) {
1687 array( 'parseinline' ),
1688 $wgLang->formatNum( $limit ),
1689 $wgLang->formatNum( $offset +
1 )
1694 * Generate (prev x| next x) (20|50|100...) type links for paging
1696 * @param $offset String
1697 * @param $limit Integer
1698 * @param $link String
1699 * @param $query String: optional URL query parameter string
1700 * @param $atend Bool: optional param for specified if this is the last page
1702 * @deprecated in 1.19; use Language::viewPrevNext() instead
1704 function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) {
1707 $query = wfCgiToArray( $query );
1709 if( is_object( $link ) ) {
1712 $title = Title
::newFromText( $link );
1713 if( is_null( $title ) ) {
1718 return $wgLang->viewPrevNext( $title, $offset, $limit, $query, $atend );
1722 * Make a list item, used by various special pages
1724 * @param $page String Page link
1725 * @param $details String Text between brackets
1726 * @param $oppositedm Boolean Add the direction mark opposite to your
1727 * language, to display text properly
1729 * @deprecated since 1.19; use Language::specialList() instead
1731 function wfSpecialList( $page, $details, $oppositedm = true ) {
1733 return $wgLang->specialList( $page, $details, $oppositedm );
1738 * @todo FIXME: We may want to blacklist some broken browsers
1740 * @param $force Bool
1741 * @return bool Whereas client accept gzip compression
1743 function wfClientAcceptsGzip( $force = false ) {
1744 static $result = null;
1745 if ( $result === null ||
$force ) {
1747 if( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
1748 # @todo FIXME: We may want to blacklist some broken browsers
1751 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
1752 $_SERVER['HTTP_ACCEPT_ENCODING'],
1756 if( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
1760 wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
1769 * Obtain the offset and limit values from the request string;
1770 * used in special pages
1772 * @param $deflimit Int default limit if none supplied
1773 * @param $optionname String Name of a user preference to check against
1777 function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
1779 return $wgRequest->getLimitOffset( $deflimit, $optionname );
1783 * Escapes the given text so that it may be output using addWikiText()
1784 * without any linking, formatting, etc. making its way through. This
1785 * is achieved by substituting certain characters with HTML entities.
1786 * As required by the callers, <nowiki> is not used.
1788 * @param $text String: text to be escaped
1791 function wfEscapeWikiText( $text ) {
1792 $text = strtr( "\n$text", array(
1793 '"' => '"', '&' => '&', "'" => ''', '<' => '<',
1794 '=' => '=', '>' => '>', '[' => '[', ']' => ']',
1795 '{' => '{', '|' => '|', '}' => '}',
1796 "\n#" => "\n#", "\n*" => "\n*",
1797 "\n:" => "\n:", "\n;" => "\n;",
1798 '://' => '://', 'ISBN ' => 'ISBN ', 'RFC ' => 'RFC ',
1800 return substr( $text, 1 );
1804 * Get the current unix timetstamp with microseconds. Useful for profiling
1808 return microtime( true );
1812 * Sets dest to source and returns the original value of dest
1813 * If source is NULL, it just returns the value, it doesn't set the variable
1814 * If force is true, it will set the value even if source is NULL
1816 * @param $dest Mixed
1817 * @param $source Mixed
1818 * @param $force Bool
1821 function wfSetVar( &$dest, $source, $force = false ) {
1823 if ( !is_null( $source ) ||
$force ) {
1830 * As for wfSetVar except setting a bit
1834 * @param $state Bool
1836 function wfSetBit( &$dest, $bit, $state = true ) {
1837 $temp = (bool)( $dest & $bit );
1838 if ( !is_null( $state ) ) {
1849 * A wrapper around the PHP function var_export().
1850 * Either print it or add it to the regular output ($wgOut).
1852 * @param $var A PHP variable to dump.
1854 function wfVarDump( $var ) {
1856 $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
1857 if ( headers_sent() ||
!isset( $wgOut ) ||
!is_object( $wgOut ) ) {
1860 $wgOut->addHTML( $s );
1865 * Provide a simple HTTP error.
1867 * @param $code Int|String
1868 * @param $label String
1869 * @param $desc String
1871 function wfHttpError( $code, $label, $desc ) {
1874 header( "HTTP/1.0 $code $label" );
1875 header( "Status: $code $label" );
1876 $wgOut->sendCacheControl();
1878 header( 'Content-type: text/html; charset=utf-8' );
1879 print "<!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML 2.0//EN\">".
1880 '<html><head><title>' .
1881 htmlspecialchars( $label ) .
1882 '</title></head><body><h1>' .
1883 htmlspecialchars( $label ) .
1885 nl2br( htmlspecialchars( $desc ) ) .
1886 "</p></body></html>\n";
1890 * Clear away any user-level output buffers, discarding contents.
1892 * Suitable for 'starting afresh', for instance when streaming
1893 * relatively large amounts of data without buffering, or wanting to
1894 * output image files without ob_gzhandler's compression.
1896 * The optional $resetGzipEncoding parameter controls suppression of
1897 * the Content-Encoding header sent by ob_gzhandler; by default it
1898 * is left. See comments for wfClearOutputBuffers() for why it would
1901 * Note that some PHP configuration options may add output buffer
1902 * layers which cannot be removed; these are left in place.
1904 * @param $resetGzipEncoding Bool
1906 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
1907 if( $resetGzipEncoding ) {
1908 // Suppress Content-Encoding and Content-Length
1909 // headers from 1.10+s wfOutputHandler
1910 global $wgDisableOutputCompression;
1911 $wgDisableOutputCompression = true;
1913 while( $status = ob_get_status() ) {
1914 if( $status['type'] == 0 /* PHP_OUTPUT_HANDLER_INTERNAL */ ) {
1915 // Probably from zlib.output_compression or other
1916 // PHP-internal setting which can't be removed.
1918 // Give up, and hope the result doesn't break
1922 if( !ob_end_clean() ) {
1923 // Could not remove output buffer handler; abort now
1924 // to avoid getting in some kind of infinite loop.
1927 if( $resetGzipEncoding ) {
1928 if( $status['name'] == 'ob_gzhandler' ) {
1929 // Reset the 'Content-Encoding' field set by this handler
1930 // so we can start fresh.
1931 if ( function_exists( 'header_remove' ) ) {
1932 // Available since PHP 5.3.0
1933 header_remove( 'Content-Encoding' );
1935 // We need to provide a valid content-coding. See bug 28069
1936 header( 'Content-Encoding: identity' );
1945 * More legible than passing a 'false' parameter to wfResetOutputBuffers():
1947 * Clear away output buffers, but keep the Content-Encoding header
1948 * produced by ob_gzhandler, if any.
1950 * This should be used for HTTP 304 responses, where you need to
1951 * preserve the Content-Encoding header of the real result, but
1952 * also need to suppress the output of ob_gzhandler to keep to spec
1953 * and avoid breaking Firefox in rare cases where the headers and
1954 * body are broken over two packets.
1956 function wfClearOutputBuffers() {
1957 wfResetOutputBuffers( false );
1961 * Converts an Accept-* header into an array mapping string values to quality
1964 * @param $accept String
1965 * @param $def String default
1968 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
1969 # No arg means accept anything (per HTTP spec)
1971 return array( $def => 1.0 );
1976 $parts = explode( ',', $accept );
1978 foreach( $parts as $part ) {
1979 # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
1980 $values = explode( ';', trim( $part ) );
1982 if ( count( $values ) == 1 ) {
1983 $prefs[$values[0]] = 1.0;
1984 } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
1985 $prefs[$values[0]] = floatval( $match[1] );
1993 * Checks if a given MIME type matches any of the keys in the given
1994 * array. Basic wildcards are accepted in the array keys.
1996 * Returns the matching MIME type (or wildcard) if a match, otherwise
1999 * @param $type String
2000 * @param $avail Array
2004 function mimeTypeMatch( $type, $avail ) {
2005 if( array_key_exists( $type, $avail ) ) {
2008 $parts = explode( '/', $type );
2009 if( array_key_exists( $parts[0] . '/*', $avail ) ) {
2010 return $parts[0] . '/*';
2011 } elseif( array_key_exists( '*/*', $avail ) ) {
2020 * Returns the 'best' match between a client's requested internet media types
2021 * and the server's list of available types. Each list should be an associative
2022 * array of type to preference (preference is a float between 0.0 and 1.0).
2023 * Wildcards in the types are acceptable.
2025 * @param $cprefs Array: client's acceptable type list
2026 * @param $sprefs Array: server's offered types
2029 * @todo FIXME: Doesn't handle params like 'text/plain; charset=UTF-8'
2030 * XXX: generalize to negotiate other stuff
2032 function wfNegotiateType( $cprefs, $sprefs ) {
2035 foreach( array_keys( $sprefs ) as $type ) {
2036 $parts = explode( '/', $type );
2037 if( $parts[1] != '*' ) {
2038 $ckey = mimeTypeMatch( $type, $cprefs );
2040 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
2045 foreach( array_keys( $cprefs ) as $type ) {
2046 $parts = explode( '/', $type );
2047 if( $parts[1] != '*' && !array_key_exists( $type, $sprefs ) ) {
2048 $skey = mimeTypeMatch( $type, $sprefs );
2050 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
2058 foreach( array_keys( $combine ) as $type ) {
2059 if( $combine[$type] > $bestq ) {
2061 $bestq = $combine[$type];
2069 * Reference-counted warning suppression
2073 function wfSuppressWarnings( $end = false ) {
2074 static $suppressCount = 0;
2075 static $originalLevel = false;
2078 if ( $suppressCount ) {
2080 if ( !$suppressCount ) {
2081 error_reporting( $originalLevel );
2085 if ( !$suppressCount ) {
2086 // E_DEPRECATED is undefined in PHP 5.2
2087 if( !defined( 'E_DEPRECATED' ) ) {
2088 define( 'E_DEPRECATED', 8192 );
2090 $originalLevel = error_reporting( E_ALL
& ~
( E_WARNING | E_NOTICE | E_USER_WARNING | E_USER_NOTICE | E_DEPRECATED
) );
2097 * Restore error level to previous value
2099 function wfRestoreWarnings() {
2100 wfSuppressWarnings( true );
2103 # Autodetect, convert and provide timestamps of various types
2106 * Unix time - the number of seconds since 1970-01-01 00:00:00 UTC
2108 define( 'TS_UNIX', 0 );
2111 * MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
2113 define( 'TS_MW', 1 );
2116 * MySQL DATETIME (YYYY-MM-DD HH:MM:SS)
2118 define( 'TS_DB', 2 );
2121 * RFC 2822 format, for E-mail and HTTP headers
2123 define( 'TS_RFC2822', 3 );
2126 * ISO 8601 format with no timezone: 1986-02-09T20:00:00Z
2128 * This is used by Special:Export
2130 define( 'TS_ISO_8601', 4 );
2133 * An Exif timestamp (YYYY:MM:DD HH:MM:SS)
2135 * @see http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the
2136 * DateTime tag and page 36 for the DateTimeOriginal and
2137 * DateTimeDigitized tags.
2139 define( 'TS_EXIF', 5 );
2142 * Oracle format time.
2144 define( 'TS_ORACLE', 6 );
2147 * Postgres format time.
2149 define( 'TS_POSTGRES', 7 );
2154 define( 'TS_DB2', 8 );
2157 * ISO 8601 basic format with no timezone: 19860209T200000Z. This is used by ResourceLoader
2159 define( 'TS_ISO_8601_BASIC', 9 );
2162 * Get a timestamp string in one of various formats
2164 * @param $outputtype Mixed: A timestamp in one of the supported formats, the
2165 * function will autodetect which format is supplied and act
2167 * @param $ts Mixed: the timestamp to convert or 0 for the current timestamp
2168 * @return Mixed: String / false The same date in the format specified in $outputtype or false
2170 function wfTimestamp( $outputtype = TS_UNIX
, $ts = 0 ) {
2175 if ( !$ts ) { // We want to catch 0, '', null... but not date strings starting with a letter.
2178 } elseif ( preg_match( '/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)$/D', $ts, $da ) ) {
2180 } elseif ( preg_match( '/^(\d{4}):(\d\d):(\d\d) (\d\d):(\d\d):(\d\d)$/D', $ts, $da ) ) {
2182 } elseif ( preg_match( '/^(\d{4})(\d\d)(\d\d)(\d\d)(\d\d)(\d\d)$/D', $ts, $da ) ) {
2184 } elseif ( preg_match( '/^-?\d{1,13}$/D', $ts ) ) {
2187 $strtime = "@$ts"; // Undocumented?
2188 } elseif ( preg_match( '/^\d{2}-\d{2}-\d{4} \d{2}:\d{2}:\d{2}.\d{6}$/', $ts ) ) {
2189 # TS_ORACLE // session altered to DD-MM-YYYY HH24:MI:SS.FF6
2190 $strtime = preg_replace( '/(\d\d)\.(\d\d)\.(\d\d)(\.(\d+))?/', "$1:$2:$3",
2191 str_replace( '+00:00', 'UTC', $ts ) );
2192 } elseif ( preg_match( '/^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})(?:\.*\d*)?Z$/', $ts, $da ) ) {
2194 } elseif ( preg_match( '/^(\d{4})(\d{2})(\d{2})T(\d{2})(\d{2})(\d{2})(?:\.*\d*)?Z$/', $ts, $da ) ) {
2196 } elseif ( preg_match( '/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)\.*\d*[\+\- ](\d\d)$/', $ts, $da ) ) {
2198 } elseif ( preg_match( '/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)\.*\d* GMT$/', $ts, $da ) ) {
2200 } elseif (preg_match( '/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)\.\d\d\d$/', $ts, $da ) ) {
2202 } elseif ( preg_match( '/^[ \t\r\n]*([A-Z][a-z]{2},[ \t\r\n]*)?' . # Day of week
2203 '\d\d?[ \t\r\n]*[A-Z][a-z]{2}[ \t\r\n]*\d{2}(?:\d{2})?' . # dd Mon yyyy
2204 '[ \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
2205 # TS_RFC2822, accepting a trailing comment. See http://www.squid-cache.org/mail-archive/squid-users/200307/0122.html / r77171
2206 # The regex is a superset of rfc2822 for readability
2207 $strtime = strtok( $ts, ';' );
2208 } 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 ) ) {
2211 } 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 ) ) {
2216 wfDebug("wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n");
2221 static $formats = array(
2224 TS_DB
=> 'Y-m-d H:i:s',
2225 TS_ISO_8601
=> 'Y-m-d\TH:i:s\Z',
2226 TS_ISO_8601_BASIC
=> 'Ymd\THis\Z',
2227 TS_EXIF
=> 'Y:m:d H:i:s', // This shouldn't ever be used, but is included for completeness
2228 TS_RFC2822
=> 'D, d M Y H:i:s',
2229 TS_ORACLE
=> 'd-m-Y H:i:s.000000', // Was 'd-M-y h.i.s A' . ' +00:00' before r51500
2230 TS_POSTGRES
=> 'Y-m-d H:i:s',
2231 TS_DB2
=> 'Y-m-d H:i:s',
2234 if ( !isset( $formats[$outputtype] ) ) {
2235 throw new MWException( 'wfTimestamp() called with illegal output type.' );
2238 if ( function_exists( "date_create" ) ) {
2239 if ( count( $da ) ) {
2240 $ds = sprintf("%04d-%02d-%02dT%02d:%02d:%02d.00+00:00",
2241 (int)$da[1], (int)$da[2], (int)$da[3],
2242 (int)$da[4], (int)$da[5], (int)$da[6]);
2244 $d = date_create( $ds, new DateTimeZone( 'GMT' ) );
2245 } elseif ( $strtime ) {
2246 $d = date_create( $strtime, new DateTimeZone( 'GMT' ) );
2252 wfDebug("wfTimestamp() fed bogus time value: $outputtype; $ts\n");
2256 $output = $d->format( $formats[$outputtype] );
2258 if ( count( $da ) ) {
2259 // Warning! gmmktime() acts oddly if the month or day is set to 0
2260 // We may want to handle that explicitly at some point
2261 $uts = gmmktime( (int)$da[4], (int)$da[5], (int)$da[6],
2262 (int)$da[2], (int)$da[3], (int)$da[1] );
2263 } elseif ( $strtime ) {
2264 $uts = strtotime( $strtime );
2267 if ( $uts === false ) {
2268 wfDebug("wfTimestamp() can't parse the timestamp (non 32-bit time? Update php): $outputtype; $ts\n");
2272 if ( TS_UNIX
== $outputtype ) {
2275 $output = gmdate( $formats[$outputtype], $uts );
2278 if ( ( $outputtype == TS_RFC2822
) ||
( $outputtype == TS_POSTGRES
) ) {
2286 * Return a formatted timestamp, or null if input is null.
2287 * For dealing with nullable timestamp columns in the database.
2289 * @param $outputtype Integer
2293 function wfTimestampOrNull( $outputtype = TS_UNIX
, $ts = null ) {
2294 if( is_null( $ts ) ) {
2297 return wfTimestamp( $outputtype, $ts );
2302 * Convenience function; returns MediaWiki timestamp for the present time.
2306 function wfTimestampNow() {
2308 return wfTimestamp( TS_MW
, time() );
2312 * Check if the operating system is Windows
2314 * @return Bool: true if it's Windows, False otherwise.
2316 function wfIsWindows() {
2317 static $isWindows = null;
2318 if ( $isWindows === null ) {
2319 $isWindows = substr( php_uname(), 0, 7 ) == 'Windows';
2325 * Check if we are running under HipHop
2329 function wfIsHipHop() {
2330 return function_exists( 'hphp_thread_set_warmup_enabled' );
2334 * Swap two variables
2339 function swap( &$x, &$y ) {
2346 * Tries to get the system directory for temporary files. The TMPDIR, TMP, and
2347 * TEMP environment variables are then checked in sequence, and if none are set
2348 * try sys_get_temp_dir() for PHP >= 5.2.1. All else fails, return /tmp for Unix
2349 * or C:\Windows\Temp for Windows and hope for the best.
2350 * It is common to call it with tempnam().
2352 * NOTE: When possible, use instead the tmpfile() function to create
2353 * temporary files to avoid race conditions on file creation, etc.
2357 function wfTempDir() {
2358 foreach( array( 'TMPDIR', 'TMP', 'TEMP' ) as $var ) {
2359 $tmp = getenv( $var );
2360 if( $tmp && file_exists( $tmp ) && is_dir( $tmp ) && is_writable( $tmp ) ) {
2364 if( function_exists( 'sys_get_temp_dir' ) ) {
2365 return sys_get_temp_dir();
2368 return wfIsWindows() ?
'C:\Windows\Temp' : '/tmp';
2372 * Make directory, and make all parent directories if they don't exist
2374 * @param $dir String: full path to directory to create
2375 * @param $mode Integer: chmod value to use, default is $wgDirectoryMode
2376 * @param $caller String: optional caller param for debugging.
2379 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2380 global $wgDirectoryMode;
2382 if ( !is_null( $caller ) ) {
2383 wfDebug( "$caller: called wfMkdirParents($dir)\n" );
2386 if( strval( $dir ) === '' ||
file_exists( $dir ) ) {
2390 $dir = str_replace( array( '\\', '/' ), DIRECTORY_SEPARATOR
, $dir );
2392 if ( is_null( $mode ) ) {
2393 $mode = $wgDirectoryMode;
2396 // Turn off the normal warning, we're doing our own below
2397 wfSuppressWarnings();
2398 $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2399 wfRestoreWarnings();
2402 // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2403 trigger_error( __FUNCTION__
. ": failed to mkdir \"$dir\" mode $mode", E_USER_WARNING
);
2409 * Increment a statistics counter
2411 * @param $key String
2414 function wfIncrStats( $key, $count = 1 ) {
2415 global $wgStatsMethod;
2417 $count = intval( $count );
2419 if( $wgStatsMethod == 'udp' ) {
2420 global $wgUDPProfilerHost, $wgUDPProfilerPort, $wgDBname, $wgAggregateStatsID;
2423 $id = $wgAggregateStatsID !== false ?
$wgAggregateStatsID : $wgDBname;
2426 $socket = socket_create( AF_INET
, SOCK_DGRAM
, SOL_UDP
);
2427 $statline = "stats/{$id} - {$count} 1 1 1 1 -total\n";
2431 strlen( $statline ),
2437 $statline = "stats/{$id} - {$count} 1 1 1 1 {$key}\n";
2438 wfSuppressWarnings();
2442 strlen( $statline ),
2447 wfRestoreWarnings();
2448 } elseif( $wgStatsMethod == 'cache' ) {
2450 $key = wfMemcKey( 'stats', $key );
2451 if ( is_null( $wgMemc->incr( $key, $count ) ) ) {
2452 $wgMemc->add( $key, $count );
2460 * @param $nr Mixed: the number to format
2461 * @param $acc Integer: the number of digits after the decimal point, default 2
2462 * @param $round Boolean: whether or not to round the value, default true
2465 function wfPercent( $nr, $acc = 2, $round = true ) {
2466 $ret = sprintf( "%.${acc}f", $nr );
2467 return $round ?
round( $ret, $acc ) . '%' : "$ret%";
2471 * Find out whether or not a mixed variable exists in a string
2473 * @param $needle String
2474 * @param $str String
2475 * @param $insensitive Boolean
2478 function in_string( $needle, $str, $insensitive = false ) {
2480 if( $insensitive ) $func = 'stripos';
2482 return $func( $str, $needle ) !== false;
2486 * Safety wrapper around ini_get() for boolean settings.
2487 * The values returned from ini_get() are pre-normalized for settings
2488 * set via php.ini or php_flag/php_admin_flag... but *not*
2489 * for those set via php_value/php_admin_value.
2491 * It's fairly common for people to use php_value instead of php_flag,
2492 * which can leave you with an 'off' setting giving a false positive
2493 * for code that just takes the ini_get() return value as a boolean.
2495 * To make things extra interesting, setting via php_value accepts
2496 * "true" and "yes" as true, but php.ini and php_flag consider them false. :)
2497 * Unrecognized values go false... again opposite PHP's own coercion
2498 * from string to bool.
2500 * Luckily, 'properly' set settings will always come back as '0' or '1',
2501 * so we only have to worry about them and the 'improper' settings.
2503 * I frickin' hate PHP... :P
2505 * @param $setting String
2508 function wfIniGetBool( $setting ) {
2509 $val = ini_get( $setting );
2510 // 'on' and 'true' can't have whitespace around them, but '1' can.
2511 return strtolower( $val ) == 'on'
2512 ||
strtolower( $val ) == 'true'
2513 ||
strtolower( $val ) == 'yes'
2514 ||
preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2518 * Wrapper function for PHP's dl(). This doesn't work in most situations from
2519 * PHP 5.3 onward, and is usually disabled in shared environments anyway.
2521 * @param $extension String A PHP extension. The file suffix (.so or .dll)
2523 * @param $fileName String Name of the library, if not $extension.suffix
2524 * @return Bool - Whether or not the extension is loaded
2526 function wfDl( $extension, $fileName = null ) {
2527 if( extension_loaded( $extension ) ) {
2532 $sapi = php_sapi_name();
2533 if( version_compare( PHP_VERSION
, '5.3.0', '<' ) ||
2534 $sapi == 'cli' ||
$sapi == 'cgi' ||
$sapi == 'embed' )
2536 $canDl = ( function_exists( 'dl' ) && is_callable( 'dl' )
2537 && wfIniGetBool( 'enable_dl' ) && !wfIniGetBool( 'safe_mode' ) );
2541 $fileName = $fileName ?
$fileName : $extension;
2542 if( wfIsWindows() ) {
2543 $fileName = 'php_' . $fileName;
2545 wfSuppressWarnings();
2546 dl( $fileName . '.' . PHP_SHLIB_SUFFIX
);
2547 wfRestoreWarnings();
2549 return extension_loaded( $extension );
2553 * Windows-compatible version of escapeshellarg()
2554 * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
2555 * function puts single quotes in regardless of OS.
2557 * Also fixes the locale problems on Linux in PHP 5.2.6+ (bug backported to
2558 * earlier distro releases of PHP)
2563 function wfEscapeShellArg( ) {
2564 wfInitShellLocale();
2566 $args = func_get_args();
2569 foreach ( $args as $arg ) {
2576 if ( wfIsWindows() ) {
2577 // Escaping for an MSVC-style command line parser and CMD.EXE
2579 // * http://web.archive.org/web/20020708081031/http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
2580 // * http://technet.microsoft.com/en-us/library/cc723564.aspx
2583 // Double the backslashes before any double quotes. Escape the double quotes.
2584 $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE
);
2587 foreach ( $tokens as $token ) {
2588 if ( $iteration %
2 == 1 ) {
2589 // Delimiter, a double quote preceded by zero or more slashes
2590 $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
2591 } elseif ( $iteration %
4 == 2 ) {
2592 // ^ in $token will be outside quotes, need to be escaped
2593 $arg .= str_replace( '^', '^^', $token );
2594 } else { // $iteration % 4 == 0
2595 // ^ in $token will appear inside double quotes, so leave as is
2600 // Double the backslashes before the end of the string, because
2601 // we will soon add a quote
2603 if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
2604 $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
2607 // Add surrounding quotes
2608 $retVal .= '"' . $arg . '"';
2610 $retVal .= escapeshellarg( $arg );
2617 * Execute a shell command, with time and memory limits mirrored from the PHP
2618 * configuration if supported.
2619 * @param $cmd String Command line, properly escaped for shell.
2620 * @param &$retval optional, will receive the program's exit code.
2621 * (non-zero is usually failure)
2622 * @param $environ Array optional environment variables which should be
2623 * added to the executed command environment.
2624 * @return collected stdout as a string (trailing newlines stripped)
2626 function wfShellExec( $cmd, &$retval = null, $environ = array() ) {
2627 global $IP, $wgMaxShellMemory, $wgMaxShellFileSize, $wgMaxShellTime;
2630 if ( is_null( $disabled ) ) {
2632 if( wfIniGetBool( 'safe_mode' ) ) {
2633 wfDebug( "wfShellExec can't run in safe_mode, PHP's exec functions are too broken.\n" );
2634 $disabled = 'safemode';
2636 $functions = explode( ',', ini_get( 'disable_functions' ) );
2637 $functions = array_map( 'trim', $functions );
2638 $functions = array_map( 'strtolower', $functions );
2639 if ( in_array( 'passthru', $functions ) ) {
2640 wfDebug( "passthru is in disabled_functions\n" );
2641 $disabled = 'passthru';
2647 return $disabled == 'safemode' ?
2648 'Unable to run external programs in safe mode.' :
2649 'Unable to run external programs, passthru() is disabled.';
2652 wfInitShellLocale();
2655 foreach( $environ as $k => $v ) {
2656 if ( wfIsWindows() ) {
2657 /* Surrounding a set in quotes (method used by wfEscapeShellArg) makes the quotes themselves
2658 * appear in the environment variable, so we must use carat escaping as documented in
2659 * http://technet.microsoft.com/en-us/library/cc723564.aspx
2660 * Note however that the quote isn't listed there, but is needed, and the parentheses
2661 * are listed there but doesn't appear to need it.
2663 $envcmd .= "set $k=" . preg_replace( '/([&|()<>^"])/', '^\\1', $v ) . '&& ';
2665 /* Assume this is a POSIX shell, thus required to accept variable assignments before the command
2666 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_09_01
2668 $envcmd .= "$k=" . escapeshellarg( $v ) . ' ';
2671 $cmd = $envcmd . $cmd;
2673 if ( wfIsWindows() ) {
2674 if ( version_compare( PHP_VERSION
, '5.3.0', '<' ) && /* Fixed in 5.3.0 :) */
2675 ( version_compare( PHP_VERSION
, '5.2.1', '>=' ) ||
php_uname( 's' ) == 'Windows NT' ) )
2677 # Hack to work around PHP's flawed invocation of cmd.exe
2678 # http://news.php.net/php.internals/21796
2679 # Windows 9x doesn't accept any kind of quotes
2680 $cmd = '"' . $cmd . '"';
2682 } elseif ( php_uname( 's' ) == 'Linux' ) {
2683 $time = intval( $wgMaxShellTime );
2684 $mem = intval( $wgMaxShellMemory );
2685 $filesize = intval( $wgMaxShellFileSize );
2687 if ( $time > 0 && $mem > 0 ) {
2688 $script = "$IP/bin/ulimit4.sh";
2689 if ( is_executable( $script ) ) {
2690 $cmd = '/bin/bash ' . escapeshellarg( $script ) . " $time $mem $filesize " . escapeshellarg( $cmd );
2694 wfDebug( "wfShellExec: $cmd\n" );
2696 $retval = 1; // error by default?
2698 passthru( $cmd, $retval );
2699 $output = ob_get_contents();
2702 if ( $retval == 127 ) {
2703 wfDebugLog( 'exec', "Possibly missing executable file: $cmd\n" );
2709 * Workaround for http://bugs.php.net/bug.php?id=45132
2710 * escapeshellarg() destroys non-ASCII characters if LANG is not a UTF-8 locale
2712 function wfInitShellLocale() {
2713 static $done = false;
2718 global $wgShellLocale;
2719 if ( !wfIniGetBool( 'safe_mode' ) ) {
2720 putenv( "LC_CTYPE=$wgShellLocale" );
2721 setlocale( LC_CTYPE
, $wgShellLocale );
2726 * Generate a shell-escaped command line string to run a maintenance script.
2727 * Note that $parameters should be a flat array and an option with an argument
2728 * should consist of two consecutive items in the array (do not use "--option value").
2729 * @param $script string MediaWiki maintenance script path
2730 * @param $parameters Array Arguments and options to the script
2731 * @param $options Array Associative array of options:
2732 * 'php': The path to the php executable
2733 * 'wrapper': Path to a PHP wrapper to handle the maintenance script
2736 function wfShellMaintenanceCmd( $script, array $parameters = array(), array $options = array() ) {
2738 // Give site config file a chance to run the script in a wrapper.
2739 // The caller may likely want to call wfBasename() on $script.
2740 wfRunHooks( 'wfShellMaintenanceCmd', array( &$script, &$parameters, &$options ) );
2741 $cmd = isset( $options['php'] ) ?
array( $options['php'] ) : array( $wgPhpCli );
2742 if ( isset( $options['wrapper'] ) ) {
2743 $cmd[] = $options['wrapper'];
2746 // Escape each parameter for shell
2747 return implode( " ", array_map( 'wfEscapeShellArg', array_merge( $cmd, $parameters ) ) );
2751 * wfMerge attempts to merge differences between three texts.
2752 * Returns true for a clean merge and false for failure or a conflict.
2754 * @param $old String
2755 * @param $mine String
2756 * @param $yours String
2757 * @param $result String
2760 function wfMerge( $old, $mine, $yours, &$result ) {
2763 # This check may also protect against code injection in
2764 # case of broken installations.
2765 wfSuppressWarnings();
2766 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
2767 wfRestoreWarnings();
2770 wfDebug( "diff3 not found\n" );
2774 # Make temporary files
2776 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2777 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
2778 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
2780 fwrite( $oldtextFile, $old );
2781 fclose( $oldtextFile );
2782 fwrite( $mytextFile, $mine );
2783 fclose( $mytextFile );
2784 fwrite( $yourtextFile, $yours );
2785 fclose( $yourtextFile );
2787 # Check for a conflict
2788 $cmd = $wgDiff3 . ' -a --overlap-only ' .
2789 wfEscapeShellArg( $mytextName ) . ' ' .
2790 wfEscapeShellArg( $oldtextName ) . ' ' .
2791 wfEscapeShellArg( $yourtextName );
2792 $handle = popen( $cmd, 'r' );
2794 if( fgets( $handle, 1024 ) ) {
2802 $cmd = $wgDiff3 . ' -a -e --merge ' .
2803 wfEscapeShellArg( $mytextName, $oldtextName, $yourtextName );
2804 $handle = popen( $cmd, 'r' );
2807 $data = fread( $handle, 8192 );
2808 if ( strlen( $data ) == 0 ) {
2814 unlink( $mytextName );
2815 unlink( $oldtextName );
2816 unlink( $yourtextName );
2818 if ( $result === '' && $old !== '' && !$conflict ) {
2819 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
2826 * Returns unified plain-text diff of two texts.
2827 * Useful for machine processing of diffs.
2829 * @param $before String: the text before the changes.
2830 * @param $after String: the text after the changes.
2831 * @param $params String: command-line options for the diff command.
2832 * @return String: unified diff of $before and $after
2834 function wfDiff( $before, $after, $params = '-u' ) {
2835 if ( $before == $after ) {
2840 wfSuppressWarnings();
2841 $haveDiff = $wgDiff && file_exists( $wgDiff );
2842 wfRestoreWarnings();
2844 # This check may also protect against code injection in
2845 # case of broken installations.
2847 wfDebug( "diff executable not found\n" );
2848 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
2849 $format = new UnifiedDiffFormatter();
2850 return $format->format( $diffs );
2853 # Make temporary files
2855 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2856 $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
2858 fwrite( $oldtextFile, $before );
2859 fclose( $oldtextFile );
2860 fwrite( $newtextFile, $after );
2861 fclose( $newtextFile );
2863 // Get the diff of the two files
2864 $cmd = "$wgDiff " . $params . ' ' . wfEscapeShellArg( $oldtextName, $newtextName );
2866 $h = popen( $cmd, 'r' );
2871 $data = fread( $h, 8192 );
2872 if ( strlen( $data ) == 0 ) {
2880 unlink( $oldtextName );
2881 unlink( $newtextName );
2883 // Kill the --- and +++ lines. They're not useful.
2884 $diff_lines = explode( "\n", $diff );
2885 if ( strpos( $diff_lines[0], '---' ) === 0 ) {
2886 unset( $diff_lines[0] );
2888 if ( strpos( $diff_lines[1], '+++' ) === 0 ) {
2889 unset( $diff_lines[1] );
2892 $diff = implode( "\n", $diff_lines );
2898 * This function works like "use VERSION" in Perl, the program will die with a
2899 * backtrace if the current version of PHP is less than the version provided
2901 * This is useful for extensions which due to their nature are not kept in sync
2902 * with releases, and might depend on other versions of PHP than the main code
2904 * Note: PHP might die due to parsing errors in some cases before it ever
2905 * manages to call this function, such is life
2907 * @see perldoc -f use
2909 * @param $req_ver Mixed: the version to check, can be a string, an integer, or
2912 function wfUsePHP( $req_ver ) {
2913 $php_ver = PHP_VERSION
;
2915 if ( version_compare( $php_ver, (string)$req_ver, '<' ) ) {
2916 throw new MWException( "PHP $req_ver required--this is only $php_ver" );
2921 * This function works like "use VERSION" in Perl except it checks the version
2922 * of MediaWiki, the program will die with a backtrace if the current version
2923 * of MediaWiki is less than the version provided.
2925 * This is useful for extensions which due to their nature are not kept in sync
2928 * @see perldoc -f use
2930 * @param $req_ver Mixed: the version to check, can be a string, an integer, or
2933 function wfUseMW( $req_ver ) {
2936 if ( version_compare( $wgVersion, (string)$req_ver, '<' ) ) {
2937 throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
2942 * Return the final portion of a pathname.
2943 * Reimplemented because PHP5's basename() is buggy with multibyte text.
2944 * http://bugs.php.net/bug.php?id=33898
2946 * PHP's basename() only considers '\' a pathchar on Windows and Netware.
2947 * We'll consider it so always, as we don't want \s in our Unix paths either.
2949 * @param $path String
2950 * @param $suffix String: to remove if present
2953 function wfBaseName( $path, $suffix = '' ) {
2954 $encSuffix = ( $suffix == '' )
2956 : ( '(?:' . preg_quote( $suffix, '#' ) . ')?' );
2958 if( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
2966 * Generate a relative path name to the given file.
2967 * May explode on non-matching case-insensitive paths,
2968 * funky symlinks, etc.
2970 * @param $path String: absolute destination path including target filename
2971 * @param $from String: Absolute source path, directory only
2974 function wfRelativePath( $path, $from ) {
2975 // Normalize mixed input on Windows...
2976 $path = str_replace( '/', DIRECTORY_SEPARATOR
, $path );
2977 $from = str_replace( '/', DIRECTORY_SEPARATOR
, $from );
2979 // Trim trailing slashes -- fix for drive root
2980 $path = rtrim( $path, DIRECTORY_SEPARATOR
);
2981 $from = rtrim( $from, DIRECTORY_SEPARATOR
);
2983 $pieces = explode( DIRECTORY_SEPARATOR
, dirname( $path ) );
2984 $against = explode( DIRECTORY_SEPARATOR
, $from );
2986 if( $pieces[0] !== $against[0] ) {
2987 // Non-matching Windows drive letters?
2988 // Return a full path.
2992 // Trim off common prefix
2993 while( count( $pieces ) && count( $against )
2994 && $pieces[0] == $against[0] ) {
2995 array_shift( $pieces );
2996 array_shift( $against );
2999 // relative dots to bump us to the parent
3000 while( count( $against ) ) {
3001 array_unshift( $pieces, '..' );
3002 array_shift( $against );
3005 array_push( $pieces, wfBaseName( $path ) );
3007 return implode( DIRECTORY_SEPARATOR
, $pieces );
3011 * Do any deferred updates and clear the list
3013 * @deprecated since 1.19
3014 * @see DeferredUpdates::doUpdate()
3015 * @param $commit string
3017 function wfDoUpdates( $commit = '' ) {
3018 DeferredUpdates
::doUpdates( $commit );
3022 * Convert an arbitrarily-long digit string from one numeric base
3023 * to another, optionally zero-padding to a minimum column width.
3025 * Supports base 2 through 36; digit values 10-36 are represented
3026 * as lowercase letters a-z. Input is case-insensitive.
3028 * @param $input String: of digits
3029 * @param $sourceBase Integer: 2-36
3030 * @param $destBase Integer: 2-36
3031 * @param $pad Integer: 1 or greater
3032 * @param $lowercase Boolean
3033 * @return String or false on invalid input
3035 function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1, $lowercase = true ) {
3036 $input = strval( $input );
3037 if( $sourceBase < 2 ||
3042 $sourceBase != intval( $sourceBase ) ||
3043 $destBase != intval( $destBase ) ||
3044 $pad != intval( $pad ) ||
3045 !is_string( $input ) ||
3049 $digitChars = ( $lowercase ) ?
'0123456789abcdefghijklmnopqrstuvwxyz' : '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ';
3050 $inDigits = array();
3053 // Decode and validate input string
3054 $input = strtolower( $input );
3055 for( $i = 0; $i < strlen( $input ); $i++
) {
3056 $n = strpos( $digitChars, $input[$i] );
3057 if( $n === false ||
$n > $sourceBase ) {
3063 // Iterate over the input, modulo-ing out an output digit
3064 // at a time until input is gone.
3065 while( count( $inDigits ) ) {
3067 $workDigits = array();
3070 foreach( $inDigits as $digit ) {
3071 $work *= $sourceBase;
3074 if( $work < $destBase ) {
3075 // Gonna need to pull another digit.
3076 if( count( $workDigits ) ) {
3077 // Avoid zero-padding; this lets us find
3078 // the end of the input very easily when
3079 // length drops to zero.
3083 // Finally! Actual division!
3084 $workDigits[] = intval( $work / $destBase );
3086 // Isn't it annoying that most programming languages
3087 // don't have a single divide-and-remainder operator,
3088 // even though the CPU implements it that way?
3089 $work = $work %
$destBase;
3093 // All that division leaves us with a remainder,
3094 // which is conveniently our next output digit.
3095 $outChars .= $digitChars[$work];
3098 $inDigits = $workDigits;
3101 while( strlen( $outChars ) < $pad ) {
3105 return strrev( $outChars );
3109 * Create an object with a given name and an array of construct parameters
3111 * @param $name String
3112 * @param $p Array: parameters
3114 * @deprecated since 1.18, warnings in 1.18, removal in 1.20
3116 function wfCreateObject( $name, $p ) {
3117 wfDeprecated( __FUNCTION__
);
3118 return MWFunction
::newObj( $name, $p );
3124 function wfHttpOnlySafe() {
3125 global $wgHttpOnlyBlacklist;
3127 if( isset( $_SERVER['HTTP_USER_AGENT'] ) ) {
3128 foreach( $wgHttpOnlyBlacklist as $regex ) {
3129 if( preg_match( $regex, $_SERVER['HTTP_USER_AGENT'] ) ) {
3139 * Initialise php session
3141 * @param $sessionId Bool
3143 function wfSetupSession( $sessionId = false ) {
3144 global $wgSessionsInMemcached, $wgCookiePath, $wgCookieDomain,
3145 $wgCookieSecure, $wgCookieHttpOnly, $wgSessionHandler;
3146 if( $wgSessionsInMemcached ) {
3147 if ( !defined( 'MW_COMPILED' ) ) {
3149 require_once( "$IP/includes/cache/MemcachedSessions.php" );
3151 session_set_save_handler( 'memsess_open', 'memsess_close', 'memsess_read',
3152 'memsess_write', 'memsess_destroy', 'memsess_gc' );
3154 // It's necessary to register a shutdown function to call session_write_close(),
3155 // because by the time the request shutdown function for the session module is
3156 // called, $wgMemc has already been destroyed. Shutdown functions registered
3157 // this way are called before object destruction.
3158 register_shutdown_function( 'memsess_write_close' );
3159 } elseif( $wgSessionHandler && $wgSessionHandler != ini_get( 'session.save_handler' ) ) {
3160 # Only set this if $wgSessionHandler isn't null and session.save_handler
3161 # hasn't already been set to the desired value (that causes errors)
3162 ini_set( 'session.save_handler', $wgSessionHandler );
3164 $httpOnlySafe = wfHttpOnlySafe() && $wgCookieHttpOnly;
3165 wfDebugLog( 'cookie',
3166 'session_set_cookie_params: "' . implode( '", "',
3172 $httpOnlySafe ) ) . '"' );
3173 session_set_cookie_params( 0, $wgCookiePath, $wgCookieDomain, $wgCookieSecure, $httpOnlySafe );
3174 session_cache_limiter( 'private, must-revalidate' );
3176 session_id( $sessionId );
3178 wfSuppressWarnings();
3180 wfRestoreWarnings();
3184 * Get an object from the precompiled serialized directory
3186 * @param $name String
3187 * @return Mixed: the variable on success, false on failure
3189 function wfGetPrecompiledData( $name ) {
3192 $file = "$IP/serialized/$name";
3193 if ( file_exists( $file ) ) {
3194 $blob = file_get_contents( $file );
3196 return unserialize( $blob );
3208 function wfMemcKey( /*... */ ) {
3209 $args = func_get_args();
3210 $key = wfWikiID() . ':' . implode( ':', $args );
3211 $key = str_replace( ' ', '_', $key );
3216 * Get a cache key for a foreign DB
3219 * @param $prefix String
3220 * @param varargs String
3223 function wfForeignMemcKey( $db, $prefix /*, ... */ ) {
3224 $args = array_slice( func_get_args(), 2 );
3226 $key = "$db-$prefix:" . implode( ':', $args );
3228 $key = $db . ':' . implode( ':', $args );
3234 * Get an ASCII string identifying this wiki
3235 * This is used as a prefix in memcached keys
3239 function wfWikiID() {
3240 global $wgDBprefix, $wgDBname, $wgWikiID;
3241 if ( $wgWikiID !== false ) {
3243 } elseif ( $wgDBprefix ) {
3244 return "$wgDBname-$wgDBprefix";
3251 * Split a wiki ID into DB name and table prefix
3253 * @param $wiki String
3257 function wfSplitWikiID( $wiki ) {
3258 $bits = explode( '-', $wiki, 2 );
3259 if ( count( $bits ) < 2 ) {
3266 * Get a Database object.
3268 * @param $db Integer: index of the connection to get. May be DB_MASTER for the
3269 * master (for write queries), DB_SLAVE for potentially lagged read
3270 * queries, or an integer >= 0 for a particular server.
3272 * @param $groups Mixed: query groups. An array of group names that this query
3273 * belongs to. May contain a single string if the query is only
3276 * @param $wiki String: the wiki ID, or false for the current wiki
3278 * Note: multiple calls to wfGetDB(DB_SLAVE) during the course of one request
3279 * will always return the same object, unless the underlying connection or load
3280 * balancer is manually destroyed.
3282 * Note 2: use $this->getDB() in maintenance scripts that may be invoked by
3283 * updater to ensure that a proper database is being updated.
3285 * @return DatabaseBase
3287 function &wfGetDB( $db, $groups = array(), $wiki = false ) {
3288 return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
3292 * Get a load balancer object.
3294 * @param $wiki String: wiki ID, or false for the current wiki
3295 * @return LoadBalancer
3297 function wfGetLB( $wiki = false ) {
3298 return wfGetLBFactory()->getMainLB( $wiki );
3302 * Get the load balancer factory object
3306 function &wfGetLBFactory() {
3307 return LBFactory
::singleton();
3312 * Shortcut for RepoGroup::singleton()->findFile()
3314 * @param $title String or Title object
3315 * @param $options Associative array of options:
3316 * time: requested time for an archived image, or false for the
3317 * current version. An image object will be returned which was
3318 * created at the specified time.
3320 * ignoreRedirect: If true, do not follow file redirects
3322 * private: If true, return restricted (deleted) files if the current
3323 * user is allowed to view them. Otherwise, such files will not
3326 * bypassCache: If true, do not use the process-local cache of File objects
3328 * @return File, or false if the file does not exist
3330 function wfFindFile( $title, $options = array() ) {
3331 return RepoGroup
::singleton()->findFile( $title, $options );
3335 * Get an object referring to a locally registered file.
3336 * Returns a valid placeholder object if the file does not exist.
3338 * @param $title Title or String
3339 * @return File|null A File, or null if passed an invalid Title
3341 function wfLocalFile( $title ) {
3342 return RepoGroup
::singleton()->getLocalRepo()->newFile( $title );
3346 * Stream a file to the browser. Back-compat alias for StreamFile::stream()
3347 * @deprecated since 1.19
3349 function wfStreamFile( $fname, $headers = array() ) {
3350 StreamFile
::stream( $fname, $headers );
3354 * Should low-performance queries be disabled?
3357 * @codeCoverageIgnore
3359 function wfQueriesMustScale() {
3360 global $wgMiserMode;
3362 ||
( SiteStats
::pages() > 100000
3363 && SiteStats
::edits() > 1000000
3364 && SiteStats
::users() > 10000 );
3368 * Get the path to a specified script file, respecting file
3369 * extensions; this is a wrapper around $wgScriptExtension etc.
3371 * @param $script String: script filename, sans extension
3374 function wfScript( $script = 'index' ) {
3375 global $wgScriptPath, $wgScriptExtension;
3376 return "{$wgScriptPath}/{$script}{$wgScriptExtension}";
3380 * Get the script URL.
3382 * @return script URL
3384 function wfGetScriptUrl() {
3385 if( isset( $_SERVER['SCRIPT_NAME'] ) ) {
3387 # as it was called, minus the query string.
3389 # Some sites use Apache rewrite rules to handle subdomains,
3390 # and have PHP set up in a weird way that causes PHP_SELF
3391 # to contain the rewritten URL instead of the one that the
3392 # outside world sees.
3394 # If in this mode, use SCRIPT_URL instead, which mod_rewrite
3395 # provides containing the "before" URL.
3396 return $_SERVER['SCRIPT_NAME'];
3398 return $_SERVER['URL'];
3403 * Convenience function converts boolean values into "true"
3404 * or "false" (string) values
3406 * @param $value Boolean
3409 function wfBoolToStr( $value ) {
3410 return $value ?
'true' : 'false';
3414 * Load an extension messages file
3416 * @deprecated since 1.16, warnings in 1.18, remove in 1.20
3417 * @codeCoverageIgnore
3419 function wfLoadExtensionMessages() {
3420 wfDeprecated( __FUNCTION__
);
3424 * Get a platform-independent path to the null file, e.g. /dev/null
3428 function wfGetNull() {
3429 return wfIsWindows()
3435 * Throws a warning that $function is deprecated
3437 * @param $function String
3438 * @param $version String
3441 function wfDeprecated( $function, $version = false ) {
3442 static $functionsWarned = array();
3443 if ( !isset( $functionsWarned[$function] ) ) {
3444 $functionsWarned[$function] = true;
3446 global $wgDeprecationReleaseLimit;
3447 if ( $wgDeprecationReleaseLimit ) {
3448 # Strip -* off the end of $version so that branches can use the
3449 # format #.##-branchname to avoid issues if the branch is merged into
3450 # a version of MediaWiki later than what it was branched from
3451 $comparableVersion = preg_replace( '/-.*$/', '', $version );
3452 # If the comparableVersion is larger than our release limit then
3453 # skip the warning message for the deprecation
3454 if ( version_compare( $wgDeprecationReleaseLimit, $comparableVersion, '<' ) ) {
3458 wfWarn( "Use of $function was deprecated in $version.", 2 );
3460 wfWarn( "Use of $function is deprecated.", 2 );
3466 * Send a warning either to the debug log or in a PHP error depending on
3467 * $wgDevelopmentWarnings
3469 * @param $msg String: message to send
3470 * @param $callerOffset Integer: number of items to go back in the backtrace to
3471 * find the correct caller (1 = function calling wfWarn, ...)
3472 * @param $level Integer: PHP error level; only used when $wgDevelopmentWarnings
3475 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE
) {
3476 global $wgDevelopmentWarnings;
3478 $callers = wfDebugBacktrace();
3479 if ( isset( $callers[$callerOffset +
1] ) ) {
3480 $callerfunc = $callers[$callerOffset +
1];
3481 $callerfile = $callers[$callerOffset];
3482 if ( isset( $callerfile['file'] ) && isset( $callerfile['line'] ) ) {
3483 $file = $callerfile['file'] . ' at line ' . $callerfile['line'];
3485 $file = '(internal function)';
3488 if ( isset( $callerfunc['class'] ) ) {
3489 $func .= $callerfunc['class'] . '::';
3491 if ( isset( $callerfunc['function'] ) ) {
3492 $func .= $callerfunc['function'];
3494 $msg .= " [Called from $func in $file]";
3497 if ( $wgDevelopmentWarnings ) {
3498 trigger_error( $msg, $level );
3500 wfDebug( "$msg\n" );
3505 * Modern version of wfWaitForSlaves(). Instead of looking at replication lag
3506 * and waiting for it to go down, this waits for the slaves to catch up to the
3507 * master position. Use this when updating very large numbers of rows, as
3508 * in maintenance scripts, to avoid causing too much lag. Of course, this is
3509 * a no-op if there are no slaves.
3511 * @param $maxLag Integer (deprecated)
3512 * @param $wiki mixed Wiki identifier accepted by wfGetLB
3514 function wfWaitForSlaves( $maxLag = false, $wiki = false ) {
3515 $lb = wfGetLB( $wiki );
3516 // bug 27975 - Don't try to wait for slaves if there are none
3517 // Prevents permission error when getting master position
3518 if ( $lb->getServerCount() > 1 ) {
3519 $dbw = $lb->getConnection( DB_MASTER
);
3520 $pos = $dbw->getMasterPos();
3521 $lb->waitForAll( $pos );
3526 * Used to be used for outputting text in the installer/updater
3527 * @deprecated since 1.18, warnings in 1.18, remove in 1.20
3529 function wfOut( $s ) {
3530 wfDeprecated( __METHOD__
);
3531 global $wgCommandLineMode;
3532 if ( $wgCommandLineMode ) {
3535 echo htmlspecialchars( $s );
3541 * Count down from $n to zero on the terminal, with a one-second pause
3542 * between showing each number. For use in command-line scripts.
3543 * @codeCoverageIgnore
3546 function wfCountDown( $n ) {
3547 for ( $i = $n; $i >= 0; $i-- ) {
3549 echo str_repeat( "\x08", strlen( $i +
1 ) );
3561 * Generate a random 32-character hexadecimal token.
3562 * @param $salt Mixed: some sort of salt, if necessary, to add to random
3563 * characters before hashing.
3565 * @codeCoverageIgnore
3567 function wfGenerateToken( $salt = '' ) {
3568 $salt = serialize( $salt );
3569 return md5( mt_rand( 0, 0x7fffffff ) . $salt );
3573 * Replace all invalid characters with -
3575 * @param $name Mixed: filename to process
3578 function wfStripIllegalFilenameChars( $name ) {
3579 global $wgIllegalFileChars;
3580 $name = wfBaseName( $name );
3581 $name = preg_replace(
3582 "/[^" . Title
::legalChars() . "]" .
3583 ( $wgIllegalFileChars ?
"|[" . $wgIllegalFileChars . "]" : '' ) .
3592 * Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit;
3594 * @return Integer value memory was set to.
3596 function wfMemoryLimit() {
3597 global $wgMemoryLimit;
3598 $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
3599 if( $memlimit != -1 ) {
3600 $conflimit = wfShorthandToInteger( $wgMemoryLimit );
3601 if( $conflimit == -1 ) {
3602 wfDebug( "Removing PHP's memory limit\n" );
3603 wfSuppressWarnings();
3604 ini_set( 'memory_limit', $conflimit );
3605 wfRestoreWarnings();
3607 } elseif ( $conflimit > $memlimit ) {
3608 wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
3609 wfSuppressWarnings();
3610 ini_set( 'memory_limit', $conflimit );
3611 wfRestoreWarnings();
3619 * Converts shorthand byte notation to integer form
3621 * @param $string String
3624 function wfShorthandToInteger( $string = '' ) {
3625 $string = trim( $string );
3626 if( $string === '' ) {
3629 $last = $string[strlen( $string ) - 1];
3630 $val = intval( $string );
3635 // break intentionally missing
3639 // break intentionally missing
3649 * Get the normalised IETF language tag
3650 * See unit test for examples.
3652 * @param $code String: The language code.
3653 * @return String: The language code which complying with BCP 47 standards.
3655 function wfBCP47( $code ) {
3656 $codeSegment = explode( '-', $code );
3658 foreach ( $codeSegment as $segNo => $seg ) {
3659 if ( count( $codeSegment ) > 0 ) {
3660 // when previous segment is x, it is a private segment and should be lc
3661 if( $segNo > 0 && strtolower( $codeSegment[( $segNo - 1 )] ) == 'x' ) {
3662 $codeBCP[$segNo] = strtolower( $seg );
3663 // ISO 3166 country code
3664 } elseif ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) {
3665 $codeBCP[$segNo] = strtoupper( $seg );
3666 // ISO 15924 script code
3667 } elseif ( ( strlen( $seg ) == 4 ) && ( $segNo > 0 ) ) {
3668 $codeBCP[$segNo] = ucfirst( strtolower( $seg ) );
3669 // Use lowercase for other cases
3671 $codeBCP[$segNo] = strtolower( $seg );
3674 // Use lowercase for single segment
3675 $codeBCP[$segNo] = strtolower( $seg );
3678 $langCode = implode( '-', $codeBCP );
3683 * Get a cache object.
3685 * @param $inputType integer Cache type, one the the CACHE_* constants.
3688 function wfGetCache( $inputType ) {
3689 return ObjectCache
::getInstance( $inputType );
3693 * Get the main cache object
3697 function wfGetMainCache() {
3698 global $wgMainCacheType;
3699 return ObjectCache
::getInstance( $wgMainCacheType );
3703 * Get the cache object used by the message cache
3707 function wfGetMessageCacheStorage() {
3708 global $wgMessageCacheType;
3709 return ObjectCache
::getInstance( $wgMessageCacheType );
3713 * Get the cache object used by the parser cache
3717 function wfGetParserCacheStorage() {
3718 global $wgParserCacheType;
3719 return ObjectCache
::getInstance( $wgParserCacheType );
3723 * Call hook functions defined in $wgHooks
3725 * @param $event String: event name
3726 * @param $args Array: parameters passed to hook functions
3729 function wfRunHooks( $event, $args = array() ) {
3730 return Hooks
::run( $event, $args );
3734 * Wrapper around php's unpack.
3736 * @param $format String: The format string (See php's docs)
3737 * @param $data: A binary string of binary data
3738 * @param $length integer or false: The minimun length of $data. This is to
3739 * prevent reading beyond the end of $data. false to disable the check.
3741 * Also be careful when using this function to read unsigned 32 bit integer
3742 * because php might make it negative.
3744 * @throws MWException if $data not long enough, or if unpack fails
3745 * @return Associative array of the extracted data
3747 function wfUnpack( $format, $data, $length=false ) {
3748 if ( $length !== false ) {
3749 $realLen = strlen( $data );
3750 if ( $realLen < $length ) {
3751 throw new MWException( "Tried to use wfUnpack on a "
3752 . "string of length $realLen, but needed one "
3753 . "of at least length $length."
3758 wfSuppressWarnings();
3759 $result = unpack( $format, $data );
3760 wfRestoreWarnings();
3762 if ( $result === false ) {
3763 // If it cannot extract the packed data.
3764 throw new MWException( "unpack could not unpack binary data" );