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.
85 function wfArrayDiff2( $a, $b ) {
86 return array_udiff( $a, $b, 'wfArrayDiff2_cmp' );
94 function wfArrayDiff2_cmp( $a, $b ) {
95 if ( !is_array( $a ) ) {
96 return strcmp( $a, $b );
97 } elseif ( count( $a ) !== count( $b ) ) {
98 return count( $a ) < count( $b ) ?
-1 : 1;
102 while( ( list( , $valueA ) = each( $a ) ) && ( list( , $valueB ) = each( $b ) ) ) {
103 $cmp = strcmp( $valueA, $valueB );
114 * Returns an array where the values in the first array are replaced by the
115 * values in the second array with the corresponding keys
121 function wfArrayLookup( $a, $b ) {
122 return array_flip( array_intersect( array_flip( $a ), array_keys( $b ) ) );
126 * Appends to second array if $value differs from that in $default
128 * @param $key String|Int
129 * @param $value Mixed
130 * @param $default Mixed
131 * @param $changed Array to alter
133 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
134 if ( is_null( $changed ) ) {
135 throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' );
137 if ( $default[$key] !== $value ) {
138 $changed[$key] = $value;
143 * Backwards array plus for people who haven't bothered to read the PHP manual
144 * XXX: will not darn your socks for you.
146 * @param $array1 Array
147 * @param [$array2, [...]] Arrays
150 function wfArrayMerge( $array1/* ... */ ) {
151 $args = func_get_args();
152 $args = array_reverse( $args, true );
154 foreach ( $args as $arg ) {
161 * Merge arrays in the style of getUserPermissionsErrors, with duplicate removal
163 * wfMergeErrorArrays(
164 * array( array( 'x' ) ),
165 * array( array( 'x', '2' ) ),
166 * array( array( 'x' ) ),
167 * array( array( 'y') )
178 function wfMergeErrorArrays( /*...*/ ) {
179 $args = func_get_args();
181 foreach ( $args as $errors ) {
182 foreach ( $errors as $params ) {
183 # @todo FIXME: Sometimes get nested arrays for $params,
184 # which leads to E_NOTICEs
185 $spec = implode( "\t", $params );
186 $out[$spec] = $params;
189 return array_values( $out );
193 * Insert array into another array after the specified *KEY*
195 * @param $array Array: The array.
196 * @param $insert Array: The array to insert.
197 * @param $after Mixed: The key to insert after
200 function wfArrayInsertAfter( $array, $insert, $after ) {
201 // Find the offset of the element to insert after.
202 $keys = array_keys( $array );
203 $offsetByKey = array_flip( $keys );
205 $offset = $offsetByKey[$after];
207 // Insert at the specified offset
208 $before = array_slice( $array, 0, $offset +
1, true );
209 $after = array_slice( $array, $offset +
1, count( $array ) - $offset, true );
211 $output = $before +
$insert +
$after;
217 * Recursively converts the parameter (an object) to an array with the same data
219 * @param $objOrArray Object|Array
220 * @param $recursive Bool
223 function wfObjectToArray( $objOrArray, $recursive = true ) {
225 if( is_object( $objOrArray ) ) {
226 $objOrArray = get_object_vars( $objOrArray );
228 foreach ( $objOrArray as $key => $value ) {
229 if ( $recursive && ( is_object( $value ) ||
is_array( $value ) ) ) {
230 $value = wfObjectToArray( $value );
233 $array[$key] = $value;
240 * Wrapper around array_map() which also taints variables
242 * @param $function Callback
243 * @param $input Array
246 function wfArrayMap( $function, $input ) {
247 $ret = array_map( $function, $input );
248 foreach ( $ret as $key => $value ) {
249 $taint = istainted( $input[$key] );
251 taint( $ret[$key], $taint );
258 * Get a random decimal value between 0 and 1, in a way
259 * not likely to give duplicate values for any realistic
260 * number of articles.
264 function wfRandom() {
265 # The maximum random value is "only" 2^31-1, so get two random
266 # values to reduce the chance of dupes
267 $max = mt_getrandmax() +
1;
268 $rand = number_format( ( mt_rand() * $max +
mt_rand() )
269 / $max / $max, 12, '.', '' );
274 * We want some things to be included as literal characters in our title URLs
275 * for prettiness, which urlencode encodes by default. According to RFC 1738,
276 * all of the following should be safe:
280 * But + is not safe because it's used to indicate a space; &= are only safe in
281 * paths and not in queries (and we don't distinguish here); ' seems kind of
282 * scary; and urlencode() doesn't touch -_. to begin with. Plus, although /
283 * is reserved, we don't care. So the list we unescape is:
287 * However, IIS7 redirects fail when the url contains a colon (Bug 22709),
288 * so no fancy : for IIS7.
290 * %2F in the page titles seems to fatally break for some reason.
295 function wfUrlencode( $s ) {
297 if ( is_null( $s ) ) {
302 if ( is_null( $needle ) ) {
303 $needle = array( '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F' );
304 if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) ||
( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false ) ) {
309 $s = urlencode( $s );
312 array( ';', '@', '$', '!', '*', '(', ')', ',', '/', ':' ),
320 * This function takes two arrays as input, and returns a CGI-style string, e.g.
321 * "days=7&limit=100". Options in the first array override options in the second.
322 * Options set to "" will not be output.
324 * @param $array1 Array ( String|Array )
325 * @param $array2 Array ( String|Array )
326 * @param $prefix String
329 function wfArrayToCGI( $array1, $array2 = null, $prefix = '' ) {
330 if ( !is_null( $array2 ) ) {
331 $array1 = $array1 +
$array2;
335 foreach ( $array1 as $key => $value ) {
336 if ( $value !== '' ) {
340 if ( $prefix !== '' ) {
341 $key = $prefix . "[$key]";
343 if ( is_array( $value ) ) {
345 foreach ( $value as $k => $v ) {
346 $cgi .= $firstTime ?
'' : '&';
347 if ( is_array( $v ) ) {
348 $cgi .= wfArrayToCGI( $v, null, $key . "[$k]" );
350 $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v );
355 if ( is_object( $value ) ) {
356 $value = $value->__toString();
358 $cgi .= urlencode( $key ) . '=' . urlencode( $value );
366 * This is the logical opposite of wfArrayToCGI(): it accepts a query string as
367 * its argument and returns the same string in array form. This allows compa-
368 * tibility with legacy functions that accept raw query strings instead of nice
369 * arrays. Of course, keys and values are urldecode()d. Don't try passing in-
370 * valid query strings, or it will explode.
372 * @param $query String: query string
373 * @return array Array version of input
375 function wfCgiToArray( $query ) {
376 if ( isset( $query[0] ) && $query[0] == '?' ) {
377 $query = substr( $query, 1 );
379 $bits = explode( '&', $query );
381 foreach ( $bits as $bit ) {
385 list( $key, $value ) = explode( '=', $bit );
386 $key = urldecode( $key );
387 $value = urldecode( $value );
388 if ( strpos( $key, '[' ) !== false ) {
389 $keys = array_reverse( explode( '[', $key ) );
390 $key = array_pop( $keys );
392 foreach ( $keys as $k ) {
393 $k = substr( $k, 0, -1 );
394 $temp = array( $k => $temp );
396 if ( isset( $ret[$key] ) ) {
397 $ret[$key] = array_merge( $ret[$key], $temp );
409 * Append a query string to an existing URL, which may or may not already
410 * have query string parameters already. If so, they will be combined.
413 * @param $query Mixed: string or associative array
416 function wfAppendQuery( $url, $query ) {
417 if ( is_array( $query ) ) {
418 $query = wfArrayToCGI( $query );
421 if( false === strpos( $url, '?' ) ) {
432 * Expand a potentially local URL to a fully-qualified URL. Assumes $wgServer
435 * The meaning of the PROTO_* constants is as follows:
436 * PROTO_HTTP: Output a URL starting with http://
437 * PROTO_HTTPS: Output a URL starting with https://
438 * PROTO_RELATIVE: Output a URL starting with // (protocol-relative URL)
439 * PROTO_CURRENT: Output a URL starting with either http:// or https:// , depending on which protocol was used for the current incoming request
441 * @todo this won't work with current-path-relative URLs
442 * like "subdir/foo.html", etc.
444 * @param $url String: either fully-qualified or a local path + query
445 * @param $defaultProto Mixed: one of the PROTO_* constants. Determines the protocol to use if $url or $wgServer is protocol-relative
446 * @return string Fully-qualified URL
448 function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT
) {
450 if ( $defaultProto === PROTO_CURRENT
) {
451 $defaultProto = WebRequest
::detectProtocol() . '://';
454 // Analyze $wgServer to obtain its protocol
455 $bits = wfParseUrl( $wgServer );
456 $serverHasProto = $bits && $bits['scheme'] != '';
457 $defaultProtoWithoutSlashes = substr( $defaultProto, 0, -2 );
459 if( substr( $url, 0, 2 ) == '//' ) {
460 return $defaultProtoWithoutSlashes . $url;
461 } elseif( substr( $url, 0, 1 ) == '/' ) {
462 // If $wgServer is protocol-relative, prepend $defaultProtoWithoutSlashes, otherwise leave it alone
463 return ( $serverHasProto ?
'' : $defaultProtoWithoutSlashes ) . $wgServer . $url;
470 * Returns a regular expression of url protocols
472 * @param $includeProtocolRelative bool If false, remove '//' from the returned protocol list.
473 * DO NOT USE this directy, use wfUrlProtocolsWithoutProtRel() instead
476 function wfUrlProtocols( $includeProtocolRelative = true ) {
477 global $wgUrlProtocols;
479 // Cache return values separately based on $includeProtocolRelative
480 static $retval = array( true => null, false => null );
481 if ( !is_null( $retval[$includeProtocolRelative] ) ) {
482 return $retval[$includeProtocolRelative];
485 // Support old-style $wgUrlProtocols strings, for backwards compatibility
486 // with LocalSettings files from 1.5
487 if ( is_array( $wgUrlProtocols ) ) {
488 $protocols = array();
489 foreach ( $wgUrlProtocols as $protocol ) {
490 // Filter out '//' if !$includeProtocolRelative
491 if ( $includeProtocolRelative ||
$protocol !== '//' ) {
492 $protocols[] = preg_quote( $protocol, '/' );
496 $retval[$includeProtocolRelative] = implode( '|', $protocols );
498 // Ignore $includeProtocolRelative in this case
499 // This case exists for pre-1.6 compatibility, and we can safely assume
500 // that '//' won't appear in a pre-1.6 config because protocol-relative
501 // URLs weren't supported until 1.18
502 $retval[$includeProtocolRelative] = $wgUrlProtocols;
504 return $retval[$includeProtocolRelative];
508 * Like wfUrlProtocols(), but excludes '//' from the protocol list. Use this if
509 * you need a regex that matches all URL protocols but does not match protocol-
512 function wfUrlProtocolsWithoutProtRel() {
513 return wfUrlProtocols( false );
517 * parse_url() work-alike, but non-broken. Differences:
519 * 1) Does not raise warnings on bad URLs (just returns false)
520 * 2) Handles protocols that don't use :// (e.g., mailto: and news: , as well as protocol-relative URLs) correctly
521 * 3) Adds a "delimiter" element to the array, either '://', ':' or '//' (see (2))
523 * @param $url String: a URL to parse
524 * @return Array: bits of the URL in an associative array, per PHP docs
526 function wfParseUrl( $url ) {
527 global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
529 // Protocol-relative URLs are handled really badly by parse_url(). It's so bad that the easiest
530 // way to handle them is to just prepend 'http:' and strip the protocol out later
531 $wasRelative = substr( $url, 0, 2 ) == '//';
532 if ( $wasRelative ) {
535 wfSuppressWarnings();
536 $bits = parse_url( $url );
538 // parse_url() returns an array without scheme for some invalid URLs, e.g.
539 // parse_url("%0Ahttp://example.com") == array( 'host' => '%0Ahttp', 'path' => 'example.com' )
540 if ( !$bits ||
!isset( $bits['scheme'] ) ) {
544 // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
545 if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
546 $bits['delimiter'] = '://';
547 } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
548 $bits['delimiter'] = ':';
549 // parse_url detects for news: and mailto: the host part of an url as path
550 // We have to correct this wrong detection
551 if ( isset( $bits['path'] ) ) {
552 $bits['host'] = $bits['path'];
559 /* Provide an empty host for eg. file:/// urls (see bug 28627) */
560 if ( !isset( $bits['host'] ) ) {
563 /* parse_url loses the third / for file:///c:/ urls (but not on variants) */
564 if ( substr( $bits['path'], 0, 1 ) !== '/' ) {
565 $bits['path'] = '/' . $bits['path'];
569 // If the URL was protocol-relative, fix scheme and delimiter
570 if ( $wasRelative ) {
571 $bits['scheme'] = '';
572 $bits['delimiter'] = '//';
578 * Make a URL index, appropriate for the el_index field of externallinks.
583 function wfMakeUrlIndex( $url ) {
584 $bits = wfParseUrl( $url );
586 // Reverse the labels in the hostname, convert to lower case
587 // For emails reverse domainpart only
588 if ( $bits['scheme'] == 'mailto' ) {
589 $mailparts = explode( '@', $bits['host'], 2 );
590 if ( count( $mailparts ) === 2 ) {
591 $domainpart = strtolower( implode( '.', array_reverse( explode( '.', $mailparts[1] ) ) ) );
593 // No domain specified, don't mangle it
596 $reversedHost = $domainpart . '@' . $mailparts[0];
598 $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) );
600 // Add an extra dot to the end
601 // Why? Is it in wrong place in mailto links?
602 if ( substr( $reversedHost, -1, 1 ) !== '.' ) {
603 $reversedHost .= '.';
605 // Reconstruct the pseudo-URL
606 $prot = $bits['scheme'];
607 $index = $prot . $bits['delimiter'] . $reversedHost;
608 // Leave out user and password. Add the port, path, query and fragment
609 if ( isset( $bits['port'] ) ) {
610 $index .= ':' . $bits['port'];
612 if ( isset( $bits['path'] ) ) {
613 $index .= $bits['path'];
617 if ( isset( $bits['query'] ) ) {
618 $index .= '?' . $bits['query'];
620 if ( isset( $bits['fragment'] ) ) {
621 $index .= '#' . $bits['fragment'];
627 * Sends a line to the debug log if enabled or, optionally, to a comment in output.
628 * In normal operation this is a NOP.
630 * Controlling globals:
631 * $wgDebugLogFile - points to the log file
632 * $wgProfileOnly - if set, normal debug messages will not be recorded.
633 * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
634 * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
636 * @param $text String
637 * @param $logonly Bool: set true to avoid appearing in HTML when $wgDebugComments is set
639 function wfDebug( $text, $logonly = false ) {
640 global $wgOut, $wgDebugLogFile, $wgDebugComments, $wgProfileOnly, $wgDebugRawPage;
641 global $wgDebugLogPrefix, $wgShowDebug;
643 static $cache = array(); // Cache of unoutputted messages
644 $text = wfDebugTimer() . $text;
646 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
650 if ( ( $wgDebugComments ||
$wgShowDebug ) && !$logonly ) {
653 if ( isset( $wgOut ) && is_object( $wgOut ) ) {
654 // add the message and any cached messages to the output
655 array_map( array( $wgOut, 'debug' ), $cache );
659 if ( wfRunHooks( 'Debug', array( $text, null /* no log group */ ) ) ) {
660 if ( $wgDebugLogFile != '' && !$wgProfileOnly ) {
661 # Strip unprintables; they can switch terminal modes when binary data
662 # gets dumped, which is pretty annoying.
663 $text = preg_replace( '![\x00-\x08\x0b\x0c\x0e-\x1f]!', ' ', $text );
664 $text = $wgDebugLogPrefix . $text;
665 wfErrorLog( $text, $wgDebugLogFile );
671 * Returns true if debug logging should be suppressed if $wgDebugRawPage = false
673 function wfIsDebugRawPage() {
675 if ( $cache !== null ) {
678 # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
679 if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
681 isset( $_SERVER['SCRIPT_NAME'] )
682 && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
693 * Get microsecond timestamps for debug logs
697 function wfDebugTimer() {
698 global $wgDebugTimestamps;
699 if ( !$wgDebugTimestamps ) {
702 static $start = null;
704 if ( $start === null ) {
705 $start = microtime( true );
706 $prefix = "\n$start";
708 $prefix = sprintf( "%6.4f", microtime( true ) - $start );
711 return $prefix . ' ';
715 * Send a line giving PHP memory usage.
717 * @param $exact Bool: print exact values instead of kilobytes (default: false)
719 function wfDebugMem( $exact = false ) {
720 $mem = memory_get_usage();
722 $mem = floor( $mem / 1024 ) . ' kilobytes';
726 wfDebug( "Memory usage: $mem\n" );
730 * Send a line to a supplementary debug log file, if configured, or main debug log if not.
731 * $wgDebugLogGroups[$logGroup] should be set to a filename to send to a separate log.
733 * @param $logGroup String
734 * @param $text String
735 * @param $public Bool: whether to log the event in the public log if no private
736 * log file is specified, (default true)
738 function wfDebugLog( $logGroup, $text, $public = true ) {
739 global $wgDebugLogGroups, $wgShowHostnames;
740 $text = trim( $text ) . "\n";
741 if( isset( $wgDebugLogGroups[$logGroup] ) ) {
742 $time = wfTimestamp( TS_DB
);
744 if ( $wgShowHostnames ) {
745 $host = wfHostname();
749 if ( wfRunHooks( 'Debug', array( $text, $logGroup ) ) ) {
750 wfErrorLog( "$time $host $wiki: $text", $wgDebugLogGroups[$logGroup] );
752 } elseif ( $public === true ) {
753 wfDebug( $text, true );
758 * Log for database errors
760 * @param $text String: database error message.
762 function wfLogDBError( $text ) {
763 global $wgDBerrorLog, $wgDBname;
764 if ( $wgDBerrorLog ) {
765 $host = trim(`hostname`
);
766 $text = date( 'D M j G:i:s T Y' ) . "\t$host\t$wgDBname\t$text";
767 wfErrorLog( $text, $wgDBerrorLog );
772 * Log to a file without getting "file size exceeded" signals.
774 * Can also log to TCP or UDP with the syntax udp://host:port/prefix. This will
775 * send lines to the specified port, prefixed by the specified prefix and a space.
777 * @param $text String
778 * @param $file String filename
780 function wfErrorLog( $text, $file ) {
781 if ( substr( $file, 0, 4 ) == 'udp:' ) {
782 # Needs the sockets extension
783 if ( preg_match( '!^(tcp|udp):(?://)?\[([0-9a-fA-F:]+)\]:(\d+)(?:/(.*))?$!', $file, $m ) ) {
784 // IPv6 bracketed host
786 $port = intval( $m[3] );
787 $prefix = isset( $m[4] ) ?
$m[4] : false;
789 } elseif ( preg_match( '!^(tcp|udp):(?://)?([a-zA-Z0-9.-]+):(\d+)(?:/(.*))?$!', $file, $m ) ) {
791 if ( !IP
::isIPv4( $host ) ) {
792 $host = gethostbyname( $host );
794 $port = intval( $m[3] );
795 $prefix = isset( $m[4] ) ?
$m[4] : false;
798 throw new MWException( __METHOD__
. ': Invalid UDP specification' );
801 // Clean it up for the multiplexer
802 if ( strval( $prefix ) !== '' ) {
803 $text = preg_replace( '/^/m', $prefix . ' ', $text );
806 if ( strlen( $text ) > 65534 ) {
807 $text = substr( $text, 0, 65534 );
810 if ( substr( $text, -1 ) != "\n" ) {
813 } elseif ( strlen( $text ) > 65535 ) {
814 $text = substr( $text, 0, 65535 );
817 $sock = socket_create( $domain, SOCK_DGRAM
, SOL_UDP
);
821 socket_sendto( $sock, $text, strlen( $text ), 0, $host, $port );
822 socket_close( $sock );
824 wfSuppressWarnings();
825 $exists = file_exists( $file );
826 $size = $exists ?
filesize( $file ) : false;
827 if ( !$exists ||
( $size !== false && $size +
strlen( $text ) < 0x7fffffff ) ) {
828 file_put_contents( $file, $text, FILE_APPEND
);
837 function wfLogProfilingData() {
838 global $wgRequestTime, $wgDebugLogFile, $wgDebugRawPage, $wgRequest;
839 global $wgProfileLimit, $wgUser;
841 $profiler = Profiler
::instance();
843 # Profiling must actually be enabled...
844 if ( $profiler->isStub() ) {
848 // Get total page request time and only show pages that longer than
849 // $wgProfileLimit time (default is 0)
851 $elapsed = $now - $wgRequestTime;
852 if ( $elapsed <= $wgProfileLimit ) {
856 $profiler->logData();
858 // Check whether this should be logged in the debug file.
859 if ( $wgDebugLogFile == '' ||
( !$wgDebugRawPage && wfIsDebugRawPage() ) ) {
864 if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
865 $forward = ' forwarded for ' . $_SERVER['HTTP_X_FORWARDED_FOR'];
867 if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
868 $forward .= ' client IP ' . $_SERVER['HTTP_CLIENT_IP'];
870 if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
871 $forward .= ' from ' . $_SERVER['HTTP_FROM'];
874 $forward = "\t(proxied via {$_SERVER['REMOTE_ADDR']}{$forward})";
876 // Don't load $wgUser at this late stage just for statistics purposes
877 // @todo FIXME: We can detect some anons even if it is not loaded. See User::getId()
878 if ( $wgUser->isItemLoaded( 'id' ) && $wgUser->isAnon() ) {
881 $log = sprintf( "%s\t%04.3f\t%s\n",
882 gmdate( 'YmdHis' ), $elapsed,
883 urldecode( $wgRequest->getRequestURL() . $forward ) );
885 wfErrorLog( $log . $profiler->getOutput(), $wgDebugLogFile );
889 * Check if the wiki read-only lock file is present. This can be used to lock
890 * off editing functions, but doesn't guarantee that the database will not be
895 function wfReadOnly() {
896 global $wgReadOnlyFile, $wgReadOnly;
898 if ( !is_null( $wgReadOnly ) ) {
899 return (bool)$wgReadOnly;
901 if ( $wgReadOnlyFile == '' ) {
904 // Set $wgReadOnly for faster access next time
905 if ( is_file( $wgReadOnlyFile ) ) {
906 $wgReadOnly = file_get_contents( $wgReadOnlyFile );
910 return (bool)$wgReadOnly;
913 function wfReadOnlyReason() {
920 * Return a Language object from $langcode
922 * @param $langcode Mixed: either:
923 * - a Language object
924 * - code of the language to get the message for, if it is
925 * a valid code create a language for that language, if
926 * it is a string but not a valid code then make a basic
928 * - a boolean: if it's false then use the current users
929 * language (as a fallback for the old parameter
930 * functionality), or if it is true then use the wikis
931 * @return Language object
933 function wfGetLangObj( $langcode = false ) {
934 # Identify which language to get or create a language object for.
935 # Using is_object here due to Stub objects.
936 if( is_object( $langcode ) ) {
937 # Great, we already have the object (hopefully)!
941 global $wgContLang, $wgLanguageCode;
942 if( $langcode === true ||
$langcode === $wgLanguageCode ) {
943 # $langcode is the language code of the wikis content language object.
944 # or it is a boolean and value is true
949 if( $langcode === false ||
$langcode === $wgLang->getCode() ) {
950 # $langcode is the language code of user language object.
951 # or it was a boolean and value is false
955 $validCodes = array_keys( Language
::getLanguageNames() );
956 if( in_array( $langcode, $validCodes ) ) {
957 # $langcode corresponds to a valid language.
958 return Language
::factory( $langcode );
961 # $langcode is a string, but not a valid language code; use content language.
962 wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
967 * Old function when $wgBetterDirectionality existed
968 * Removed in core, kept in extensions for backwards compat.
970 * @deprecated since 1.18
973 function wfUILang() {
979 * This is the new function for getting translated interface messages.
980 * See the Message class for documentation how to use them.
981 * The intention is that this function replaces all old wfMsg* functions.
982 * @param $key \string Message key.
983 * Varargs: normal message parameters.
987 function wfMessage( $key /*...*/) {
988 $params = func_get_args();
989 array_shift( $params );
990 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
991 $params = $params[0];
993 return new Message( $key, $params );
997 * This function accepts multiple message keys and returns a message instance
998 * for the first message which is non-empty. If all messages are empty then an
999 * instance of the first message key is returned.
1000 * @param varargs: message keys
1004 function wfMessageFallback( /*...*/ ) {
1005 $args = func_get_args();
1006 return MWFunction
::callArray( 'Message::newFallbackSequence', $args );
1010 * Get a message from anywhere, for the current user language.
1012 * Use wfMsgForContent() instead if the message should NOT
1013 * change depending on the user preferences.
1015 * @param $key String: lookup key for the message, usually
1016 * defined in languages/Language.php
1018 * Parameters to the message, which can be used to insert variable text into
1019 * it, can be passed to this function in the following formats:
1020 * - One per argument, starting at the second parameter
1021 * - As an array in the second parameter
1022 * These are not shown in the function definition.
1026 function wfMsg( $key ) {
1027 $args = func_get_args();
1028 array_shift( $args );
1029 return wfMsgReal( $key, $args );
1033 * Same as above except doesn't transform the message
1035 * @param $key String
1038 function wfMsgNoTrans( $key ) {
1039 $args = func_get_args();
1040 array_shift( $args );
1041 return wfMsgReal( $key, $args, true, false, false );
1045 * Get a message from anywhere, for the current global language
1046 * set with $wgLanguageCode.
1048 * Use this if the message should NOT change dependent on the
1049 * language set in the user's preferences. This is the case for
1050 * most text written into logs, as well as link targets (such as
1051 * the name of the copyright policy page). Link titles, on the
1052 * other hand, should be shown in the UI language.
1054 * Note that MediaWiki allows users to change the user interface
1055 * language in their preferences, but a single installation
1056 * typically only contains content in one language.
1058 * Be wary of this distinction: If you use wfMsg() where you should
1059 * use wfMsgForContent(), a user of the software may have to
1060 * customize potentially hundreds of messages in
1061 * order to, e.g., fix a link in every possible language.
1063 * @param $key String: lookup key for the message, usually
1064 * defined in languages/Language.php
1067 function wfMsgForContent( $key ) {
1068 global $wgForceUIMsgAsContentMsg;
1069 $args = func_get_args();
1070 array_shift( $args );
1072 if( is_array( $wgForceUIMsgAsContentMsg ) &&
1073 in_array( $key, $wgForceUIMsgAsContentMsg ) )
1075 $forcontent = false;
1077 return wfMsgReal( $key, $args, true, $forcontent );
1081 * Same as above except doesn't transform the message
1083 * @param $key String
1086 function wfMsgForContentNoTrans( $key ) {
1087 global $wgForceUIMsgAsContentMsg;
1088 $args = func_get_args();
1089 array_shift( $args );
1091 if( is_array( $wgForceUIMsgAsContentMsg ) &&
1092 in_array( $key, $wgForceUIMsgAsContentMsg ) )
1094 $forcontent = false;
1096 return wfMsgReal( $key, $args, true, $forcontent, false );
1100 * Really get a message
1102 * @param $key String: key to get.
1104 * @param $useDB Boolean
1105 * @param $forContent Mixed: Language code, or false for user lang, true for content lang.
1106 * @param $transform Boolean: Whether or not to transform the message.
1107 * @return String: the requested message.
1109 function wfMsgReal( $key, $args, $useDB = true, $forContent = false, $transform = true ) {
1110 wfProfileIn( __METHOD__
);
1111 $message = wfMsgGetKey( $key, $useDB, $forContent, $transform );
1112 $message = wfMsgReplaceArgs( $message, $args );
1113 wfProfileOut( __METHOD__
);
1118 * Fetch a message string value, but don't replace any keys yet.
1120 * @param $key String
1121 * @param $useDB Bool
1122 * @param $langCode String: Code of the language to get the message for, or
1123 * behaves as a content language switch if it is a boolean.
1124 * @param $transform Boolean: whether to parse magic words, etc.
1127 function wfMsgGetKey( $key, $useDB = true, $langCode = false, $transform = true ) {
1128 wfRunHooks( 'NormalizeMessageKey', array( &$key, &$useDB, &$langCode, &$transform ) );
1130 $cache = MessageCache
::singleton();
1131 $message = $cache->get( $key, $useDB, $langCode );
1132 if( $message === false ) {
1133 $message = '<' . htmlspecialchars( $key ) . '>';
1134 } elseif ( $transform ) {
1135 $message = $cache->transform( $message );
1141 * Replace message parameter keys on the given formatted output.
1143 * @param $message String
1144 * @param $args Array
1148 function wfMsgReplaceArgs( $message, $args ) {
1149 # Fix windows line-endings
1150 # Some messages are split with explode("\n", $msg)
1151 $message = str_replace( "\r", '', $message );
1153 // Replace arguments
1154 if ( count( $args ) ) {
1155 if ( is_array( $args[0] ) ) {
1156 $args = array_values( $args[0] );
1158 $replacementKeys = array();
1159 foreach( $args as $n => $param ) {
1160 $replacementKeys['$' . ( $n +
1 )] = $param;
1162 $message = strtr( $message, $replacementKeys );
1169 * Return an HTML-escaped version of a message.
1170 * Parameter replacements, if any, are done *after* the HTML-escaping,
1171 * so parameters may contain HTML (eg links or form controls). Be sure
1172 * to pre-escape them if you really do want plaintext, or just wrap
1173 * the whole thing in htmlspecialchars().
1175 * @param $key String
1176 * @param string ... parameters
1179 function wfMsgHtml( $key ) {
1180 $args = func_get_args();
1181 array_shift( $args );
1182 return wfMsgReplaceArgs( htmlspecialchars( wfMsgGetKey( $key ) ), $args );
1186 * Return an HTML version of message
1187 * Parameter replacements, if any, are done *after* parsing the wiki-text message,
1188 * so parameters may contain HTML (eg links or form controls). Be sure
1189 * to pre-escape them if you really do want plaintext, or just wrap
1190 * the whole thing in htmlspecialchars().
1192 * @param $key String
1193 * @param string ... parameters
1196 function wfMsgWikiHtml( $key ) {
1197 $args = func_get_args();
1198 array_shift( $args );
1199 return wfMsgReplaceArgs(
1200 MessageCache
::singleton()->parse( wfMsgGetKey( $key ), null,
1201 /* can't be set to false */ true, /* interface */ true )->getText(),
1206 * Returns message in the requested format
1207 * @param $key String: key of the message
1208 * @param $options Array: processing rules. Can take the following options:
1209 * <i>parse</i>: parses wikitext to HTML
1210 * <i>parseinline</i>: parses wikitext to HTML and removes the surrounding
1211 * p's added by parser or tidy
1212 * <i>escape</i>: filters message through htmlspecialchars
1213 * <i>escapenoentities</i>: same, but allows entity references like   through
1214 * <i>replaceafter</i>: parameters are substituted after parsing or escaping
1215 * <i>parsemag</i>: transform the message using magic phrases
1216 * <i>content</i>: fetch message for content language instead of interface
1217 * Also can accept a single associative argument, of the form 'language' => 'xx':
1218 * <i>language</i>: Language object or language code to fetch message for
1219 * (overriden by <i>content</i>).
1220 * Behavior for conflicting options (e.g., parse+parseinline) is undefined.
1224 function wfMsgExt( $key, $options ) {
1225 $args = func_get_args();
1226 array_shift( $args );
1227 array_shift( $args );
1228 $options = (array)$options;
1230 foreach( $options as $arrayKey => $option ) {
1231 if( !preg_match( '/^[0-9]+|language$/', $arrayKey ) ) {
1232 # An unknown index, neither numeric nor "language"
1233 wfWarn( "wfMsgExt called with incorrect parameter key $arrayKey", 1, E_USER_WARNING
);
1234 } elseif( preg_match( '/^[0-9]+$/', $arrayKey ) && !in_array( $option,
1235 array( 'parse', 'parseinline', 'escape', 'escapenoentities',
1236 'replaceafter', 'parsemag', 'content' ) ) ) {
1237 # A numeric index with unknown value
1238 wfWarn( "wfMsgExt called with incorrect parameter $option", 1, E_USER_WARNING
);
1242 if( in_array( 'content', $options, true ) ) {
1245 $langCodeObj = null;
1246 } elseif( array_key_exists( 'language', $options ) ) {
1247 $forContent = false;
1248 $langCode = wfGetLangObj( $options['language'] );
1249 $langCodeObj = $langCode;
1251 $forContent = false;
1253 $langCodeObj = null;
1256 $string = wfMsgGetKey( $key, /*DB*/true, $langCode, /*Transform*/false );
1258 if( !in_array( 'replaceafter', $options, true ) ) {
1259 $string = wfMsgReplaceArgs( $string, $args );
1262 $messageCache = MessageCache
::singleton();
1263 if( in_array( 'parse', $options, true ) ) {
1264 $string = $messageCache->parse( $string, null, true, !$forContent, $langCodeObj )->getText();
1265 } elseif ( in_array( 'parseinline', $options, true ) ) {
1266 $string = $messageCache->parse( $string, null, true, !$forContent, $langCodeObj )->getText();
1268 if( preg_match( '/^<p>(.*)\n?<\/p>\n?$/sU', $string, $m ) ) {
1271 } elseif ( in_array( 'parsemag', $options, true ) ) {
1272 $string = $messageCache->transform( $string,
1273 !$forContent, $langCodeObj );
1276 if ( in_array( 'escape', $options, true ) ) {
1277 $string = htmlspecialchars ( $string );
1278 } elseif ( in_array( 'escapenoentities', $options, true ) ) {
1279 $string = Sanitizer
::escapeHtmlAllowEntities( $string );
1282 if( in_array( 'replaceafter', $options, true ) ) {
1283 $string = wfMsgReplaceArgs( $string, $args );
1290 * Since wfMsg() and co suck, they don't return false if the message key they
1291 * looked up didn't exist but a XHTML string, this function checks for the
1292 * nonexistance of messages by checking the MessageCache::get() result directly.
1294 * @param $key String: the message key looked up
1295 * @return Boolean True if the message *doesn't* exist.
1297 function wfEmptyMsg( $key ) {
1298 return MessageCache
::singleton()->get( $key, /*useDB*/true, /*content*/false ) === false;
1302 * Throw a debugging exception. This function previously once exited the process,
1303 * but now throws an exception instead, with similar results.
1305 * @param $msg String: message shown when dieing.
1307 function wfDebugDieBacktrace( $msg = '' ) {
1308 throw new MWException( $msg );
1312 * Fetch server name for use in error reporting etc.
1313 * Use real server name if available, so we know which machine
1314 * in a server farm generated the current page.
1318 function wfHostname() {
1320 if ( is_null( $host ) ) {
1321 if ( function_exists( 'posix_uname' ) ) {
1322 // This function not present on Windows
1323 $uname = posix_uname();
1327 if( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1328 $host = $uname['nodename'];
1329 } elseif ( getenv( 'COMPUTERNAME' ) ) {
1330 # Windows computer name
1331 $host = getenv( 'COMPUTERNAME' );
1333 # This may be a virtual server.
1334 $host = $_SERVER['SERVER_NAME'];
1341 * Returns a HTML comment with the elapsed time since request.
1342 * This method has no side effects.
1346 function wfReportTime() {
1347 global $wgRequestTime, $wgShowHostnames;
1350 $elapsed = $now - $wgRequestTime;
1352 return $wgShowHostnames
1353 ?
sprintf( '<!-- Served by %s in %01.3f secs. -->', wfHostname(), $elapsed )
1354 : sprintf( '<!-- Served in %01.3f secs. -->', $elapsed );
1358 * Safety wrapper for debug_backtrace().
1360 * With Zend Optimizer 3.2.0 loaded, this causes segfaults under somewhat
1361 * murky circumstances, which may be triggered in part by stub objects
1362 * or other fancy talkin'.
1364 * Will return an empty array if Zend Optimizer is detected or if
1365 * debug_backtrace is disabled, otherwise the output from
1366 * debug_backtrace() (trimmed).
1368 * @return array of backtrace information
1370 function wfDebugBacktrace( $limit = 0 ) {
1371 static $disabled = null;
1373 if( extension_loaded( 'Zend Optimizer' ) ) {
1374 wfDebug( "Zend Optimizer detected; skipping debug_backtrace for safety.\n" );
1378 if ( is_null( $disabled ) ) {
1380 $functions = explode( ',', ini_get( 'disable_functions' ) );
1381 $functions = array_map( 'trim', $functions );
1382 $functions = array_map( 'strtolower', $functions );
1383 if ( in_array( 'debug_backtrace', $functions ) ) {
1384 wfDebug( "debug_backtrace is in disabled_functions\n" );
1392 if ( $limit && version_compare( PHP_VERSION
, '5.4.0', '>=' ) ) {
1393 return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT
, 1 ), 1 );
1395 return array_slice( debug_backtrace(), 1 );
1400 * Get a debug backtrace as a string
1404 function wfBacktrace() {
1405 global $wgCommandLineMode;
1407 if ( $wgCommandLineMode ) {
1412 $backtrace = wfDebugBacktrace();
1413 foreach( $backtrace as $call ) {
1414 if( isset( $call['file'] ) ) {
1415 $f = explode( DIRECTORY_SEPARATOR
, $call['file'] );
1416 $file = $f[count( $f ) - 1];
1420 if( isset( $call['line'] ) ) {
1421 $line = $call['line'];
1425 if ( $wgCommandLineMode ) {
1426 $msg .= "$file line $line calls ";
1428 $msg .= '<li>' . $file . ' line ' . $line . ' calls ';
1430 if( !empty( $call['class'] ) ) {
1431 $msg .= $call['class'] . $call['type'];
1433 $msg .= $call['function'] . '()';
1435 if ( $wgCommandLineMode ) {
1441 if ( $wgCommandLineMode ) {
1451 * Get the name of the function which called this function
1454 * @return Bool|string
1456 function wfGetCaller( $level = 2 ) {
1457 $backtrace = wfDebugBacktrace( $level );
1458 if ( isset( $backtrace[$level] ) ) {
1459 return wfFormatStackFrame( $backtrace[$level] );
1461 $caller = 'unknown';
1467 * Return a string consisting of callers in the stack. Useful sometimes
1468 * for profiling specific points.
1470 * @param $limit The maximum depth of the stack frame to return, or false for
1474 function wfGetAllCallers( $limit = 3 ) {
1475 $trace = array_reverse( wfDebugBacktrace() );
1476 if ( !$limit ||
$limit > count( $trace ) - 1 ) {
1477 $limit = count( $trace ) - 1;
1479 $trace = array_slice( $trace, -$limit - 1, $limit );
1480 return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1484 * Return a string representation of frame
1486 * @param $frame Array
1489 function wfFormatStackFrame( $frame ) {
1490 return isset( $frame['class'] ) ?
1491 $frame['class'] . '::' . $frame['function'] :
1496 /* Some generic result counters, pulled out of SearchEngine */
1502 * @param $offset Int
1506 function wfShowingResults( $offset, $limit ) {
1510 array( 'parseinline' ),
1511 $wgLang->formatNum( $limit ),
1512 $wgLang->formatNum( $offset +
1 )
1517 * Generate (prev x| next x) (20|50|100...) type links for paging
1519 * @param $offset String
1520 * @param $limit Integer
1521 * @param $link String
1522 * @param $query String: optional URL query parameter string
1523 * @param $atend Bool: optional param for specified if this is the last page
1526 function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) {
1528 $fmtLimit = $wgLang->formatNum( $limit );
1529 // @todo FIXME: Why on earth this needs one message for the text and another one for tooltip?
1530 # Get prev/next link display text
1531 $prev = wfMsgExt( 'prevn', array( 'parsemag', 'escape' ), $fmtLimit );
1532 $next = wfMsgExt( 'nextn', array( 'parsemag', 'escape' ), $fmtLimit );
1533 # Get prev/next link title text
1534 $pTitle = wfMsgExt( 'prevn-title', array( 'parsemag', 'escape' ), $fmtLimit );
1535 $nTitle = wfMsgExt( 'nextn-title', array( 'parsemag', 'escape' ), $fmtLimit );
1536 # Fetch the title object
1537 if( is_object( $link ) ) {
1540 $title = Title
::newFromText( $link );
1541 if( is_null( $title ) ) {
1545 # Make 'previous' link
1546 if( 0 != $offset ) {
1547 $po = $offset - $limit;
1548 $po = max( $po, 0 );
1549 $q = "limit={$limit}&offset={$po}";
1550 if( $query != '' ) {
1553 $plink = '<a href="' . $title->escapeLocalURL( $q ) . "\" title=\"{$pTitle}\" class=\"mw-prevlink\">{$prev}</a>";
1558 $no = $offset +
$limit;
1559 $q = "limit={$limit}&offset={$no}";
1560 if( $query != '' ) {
1566 $nlink = '<a href="' . $title->escapeLocalURL( $q ) . "\" title=\"{$nTitle}\" class=\"mw-nextlink\">{$next}</a>";
1568 # Make links to set number of items per page
1569 $nums = $wgLang->pipeList( array(
1570 wfNumLink( $offset, 20, $title, $query ),
1571 wfNumLink( $offset, 50, $title, $query ),
1572 wfNumLink( $offset, 100, $title, $query ),
1573 wfNumLink( $offset, 250, $title, $query ),
1574 wfNumLink( $offset, 500, $title, $query )
1576 return wfMsgHtml( 'viewprevnext', $plink, $nlink, $nums );
1580 * Generate links for (20|50|100...) items-per-page links
1582 * @param $offset String
1583 * @param $limit Integer
1584 * @param $title Title
1585 * @param $query String: optional URL query parameter string
1587 function wfNumLink( $offset, $limit, $title, $query = '' ) {
1589 if( $query == '' ) {
1594 $q .= "limit={$limit}&offset={$offset}";
1595 $fmtLimit = $wgLang->formatNum( $limit );
1596 $lTitle = wfMsgExt( 'shown-title', array( 'parsemag', 'escape' ), $limit );
1597 $s = '<a href="' . $title->escapeLocalURL( $q ) . "\" title=\"{$lTitle}\" class=\"mw-numlink\">{$fmtLimit}</a>";
1603 * @todo FIXME: We may want to blacklist some broken browsers
1605 * @param $force Bool
1606 * @return bool Whereas client accept gzip compression
1608 function wfClientAcceptsGzip( $force = false ) {
1609 static $result = null;
1610 if ( $result === null ||
$force ) {
1612 if( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
1613 # @todo FIXME: We may want to blacklist some broken browsers
1616 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
1617 $_SERVER['HTTP_ACCEPT_ENCODING'],
1621 if( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
1625 wfDebug( " accepts gzip\n" );
1634 * Obtain the offset and limit values from the request string;
1635 * used in special pages
1637 * @param $deflimit Int default limit if none supplied
1638 * @param $optionname String Name of a user preference to check against
1642 function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
1644 return $wgRequest->getLimitOffset( $deflimit, $optionname );
1648 * Escapes the given text so that it may be output using addWikiText()
1649 * without any linking, formatting, etc. making its way through. This
1650 * is achieved by substituting certain characters with HTML entities.
1651 * As required by the callers, <nowiki> is not used.
1653 * @param $text String: text to be escaped
1656 function wfEscapeWikiText( $text ) {
1657 $text = strtr( "\n$text", array(
1658 '"' => '"', '&' => '&', "'" => ''', '<' => '<',
1659 '=' => '=', '>' => '>', '[' => '[', ']' => ']',
1660 '{' => '{', '|' => '|', '}' => '}',
1661 "\n#" => "\n#", "\n*" => "\n*",
1662 "\n:" => "\n:", "\n;" => "\n;",
1663 '://' => '://', 'ISBN ' => 'ISBN ', 'RFC ' => 'RFC ',
1665 return substr( $text, 1 );
1669 * Get the current unix timetstamp with microseconds. Useful for profiling
1673 return microtime( true );
1677 * Sets dest to source and returns the original value of dest
1678 * If source is NULL, it just returns the value, it doesn't set the variable
1679 * If force is true, it will set the value even if source is NULL
1681 * @param $dest Mixed
1682 * @param $source Mixed
1683 * @param $force Bool
1686 function wfSetVar( &$dest, $source, $force = false ) {
1688 if ( !is_null( $source ) ||
$force ) {
1695 * As for wfSetVar except setting a bit
1699 * @param $state Bool
1701 function wfSetBit( &$dest, $bit, $state = true ) {
1702 $temp = (bool)( $dest & $bit );
1703 if ( !is_null( $state ) ) {
1714 * Windows-compatible version of escapeshellarg()
1715 * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
1716 * function puts single quotes in regardless of OS.
1718 * Also fixes the locale problems on Linux in PHP 5.2.6+ (bug backported to
1719 * earlier distro releases of PHP)
1724 function wfEscapeShellArg( ) {
1725 wfInitShellLocale();
1727 $args = func_get_args();
1730 foreach ( $args as $arg ) {
1737 if ( wfIsWindows() ) {
1738 // Escaping for an MSVC-style command line parser and CMD.EXE
1740 // * http://web.archive.org/web/20020708081031/http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
1741 // * http://technet.microsoft.com/en-us/library/cc723564.aspx
1744 // Double the backslashes before any double quotes. Escape the double quotes.
1745 $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE
);
1748 foreach ( $tokens as $token ) {
1749 if ( $iteration %
2 == 1 ) {
1750 // Delimiter, a double quote preceded by zero or more slashes
1751 $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
1752 } elseif ( $iteration %
4 == 2 ) {
1753 // ^ in $token will be outside quotes, need to be escaped
1754 $arg .= str_replace( '^', '^^', $token );
1755 } else { // $iteration % 4 == 0
1756 // ^ in $token will appear inside double quotes, so leave as is
1761 // Double the backslashes before the end of the string, because
1762 // we will soon add a quote
1764 if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
1765 $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
1768 // Add surrounding quotes
1769 $retVal .= '"' . $arg . '"';
1771 $retVal .= escapeshellarg( $arg );
1778 * wfMerge attempts to merge differences between three texts.
1779 * Returns true for a clean merge and false for failure or a conflict.
1781 * @param $old String
1782 * @param $mine String
1783 * @param $yours String
1784 * @param $result String
1787 function wfMerge( $old, $mine, $yours, &$result ) {
1790 # This check may also protect against code injection in
1791 # case of broken installations.
1792 wfSuppressWarnings();
1793 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
1794 wfRestoreWarnings();
1797 wfDebug( "diff3 not found\n" );
1801 # Make temporary files
1803 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
1804 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
1805 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
1807 fwrite( $oldtextFile, $old );
1808 fclose( $oldtextFile );
1809 fwrite( $mytextFile, $mine );
1810 fclose( $mytextFile );
1811 fwrite( $yourtextFile, $yours );
1812 fclose( $yourtextFile );
1814 # Check for a conflict
1815 $cmd = $wgDiff3 . ' -a --overlap-only ' .
1816 wfEscapeShellArg( $mytextName ) . ' ' .
1817 wfEscapeShellArg( $oldtextName ) . ' ' .
1818 wfEscapeShellArg( $yourtextName );
1819 $handle = popen( $cmd, 'r' );
1821 if( fgets( $handle, 1024 ) ) {
1829 $cmd = $wgDiff3 . ' -a -e --merge ' .
1830 wfEscapeShellArg( $mytextName, $oldtextName, $yourtextName );
1831 $handle = popen( $cmd, 'r' );
1834 $data = fread( $handle, 8192 );
1835 if ( strlen( $data ) == 0 ) {
1841 unlink( $mytextName );
1842 unlink( $oldtextName );
1843 unlink( $yourtextName );
1845 if ( $result === '' && $old !== '' && !$conflict ) {
1846 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
1853 * Returns unified plain-text diff of two texts.
1854 * Useful for machine processing of diffs.
1856 * @param $before String: the text before the changes.
1857 * @param $after String: the text after the changes.
1858 * @param $params String: command-line options for the diff command.
1859 * @return String: unified diff of $before and $after
1861 function wfDiff( $before, $after, $params = '-u' ) {
1862 if ( $before == $after ) {
1867 wfSuppressWarnings();
1868 $haveDiff = $wgDiff && file_exists( $wgDiff );
1869 wfRestoreWarnings();
1871 # This check may also protect against code injection in
1872 # case of broken installations.
1874 wfDebug( "diff executable not found\n" );
1875 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
1876 $format = new UnifiedDiffFormatter();
1877 return $format->format( $diffs );
1880 # Make temporary files
1882 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
1883 $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
1885 fwrite( $oldtextFile, $before );
1886 fclose( $oldtextFile );
1887 fwrite( $newtextFile, $after );
1888 fclose( $newtextFile );
1890 // Get the diff of the two files
1891 $cmd = "$wgDiff " . $params . ' ' . wfEscapeShellArg( $oldtextName, $newtextName );
1893 $h = popen( $cmd, 'r' );
1898 $data = fread( $h, 8192 );
1899 if ( strlen( $data ) == 0 ) {
1907 unlink( $oldtextName );
1908 unlink( $newtextName );
1910 // Kill the --- and +++ lines. They're not useful.
1911 $diff_lines = explode( "\n", $diff );
1912 if ( strpos( $diff_lines[0], '---' ) === 0 ) {
1913 unset( $diff_lines[0] );
1915 if ( strpos( $diff_lines[1], '+++' ) === 0 ) {
1916 unset( $diff_lines[1] );
1919 $diff = implode( "\n", $diff_lines );
1925 * A wrapper around the PHP function var_export().
1926 * Either print it or add it to the regular output ($wgOut).
1928 * @param $var A PHP variable to dump.
1930 function wfVarDump( $var ) {
1932 $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
1933 if ( headers_sent() ||
!isset( $wgOut ) ||
!is_object( $wgOut ) ) {
1936 $wgOut->addHTML( $s );
1941 * Provide a simple HTTP error.
1943 * @param $code Int|String
1944 * @param $label String
1945 * @param $desc String
1947 function wfHttpError( $code, $label, $desc ) {
1950 header( "HTTP/1.0 $code $label" );
1951 header( "Status: $code $label" );
1952 $wgOut->sendCacheControl();
1954 header( 'Content-type: text/html; charset=utf-8' );
1955 print "<!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML 2.0//EN\">".
1956 '<html><head><title>' .
1957 htmlspecialchars( $label ) .
1958 '</title></head><body><h1>' .
1959 htmlspecialchars( $label ) .
1961 nl2br( htmlspecialchars( $desc ) ) .
1962 "</p></body></html>\n";
1966 * Clear away any user-level output buffers, discarding contents.
1968 * Suitable for 'starting afresh', for instance when streaming
1969 * relatively large amounts of data without buffering, or wanting to
1970 * output image files without ob_gzhandler's compression.
1972 * The optional $resetGzipEncoding parameter controls suppression of
1973 * the Content-Encoding header sent by ob_gzhandler; by default it
1974 * is left. See comments for wfClearOutputBuffers() for why it would
1977 * Note that some PHP configuration options may add output buffer
1978 * layers which cannot be removed; these are left in place.
1980 * @param $resetGzipEncoding Bool
1982 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
1983 if( $resetGzipEncoding ) {
1984 // Suppress Content-Encoding and Content-Length
1985 // headers from 1.10+s wfOutputHandler
1986 global $wgDisableOutputCompression;
1987 $wgDisableOutputCompression = true;
1989 while( $status = ob_get_status() ) {
1990 if( $status['type'] == 0 /* PHP_OUTPUT_HANDLER_INTERNAL */ ) {
1991 // Probably from zlib.output_compression or other
1992 // PHP-internal setting which can't be removed.
1994 // Give up, and hope the result doesn't break
1998 if( !ob_end_clean() ) {
1999 // Could not remove output buffer handler; abort now
2000 // to avoid getting in some kind of infinite loop.
2003 if( $resetGzipEncoding ) {
2004 if( $status['name'] == 'ob_gzhandler' ) {
2005 // Reset the 'Content-Encoding' field set by this handler
2006 // so we can start fresh.
2007 if ( function_exists( 'header_remove' ) ) {
2008 // Available since PHP 5.3.0
2009 header_remove( 'Content-Encoding' );
2011 // We need to provide a valid content-coding. See bug 28069
2012 header( 'Content-Encoding: identity' );
2021 * More legible than passing a 'false' parameter to wfResetOutputBuffers():
2023 * Clear away output buffers, but keep the Content-Encoding header
2024 * produced by ob_gzhandler, if any.
2026 * This should be used for HTTP 304 responses, where you need to
2027 * preserve the Content-Encoding header of the real result, but
2028 * also need to suppress the output of ob_gzhandler to keep to spec
2029 * and avoid breaking Firefox in rare cases where the headers and
2030 * body are broken over two packets.
2032 function wfClearOutputBuffers() {
2033 wfResetOutputBuffers( false );
2037 * Converts an Accept-* header into an array mapping string values to quality
2040 * @param $accept String
2041 * @param $def String default
2044 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
2045 # No arg means accept anything (per HTTP spec)
2047 return array( $def => 1.0 );
2052 $parts = explode( ',', $accept );
2054 foreach( $parts as $part ) {
2055 # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
2056 $values = explode( ';', trim( $part ) );
2058 if ( count( $values ) == 1 ) {
2059 $prefs[$values[0]] = 1.0;
2060 } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
2061 $prefs[$values[0]] = floatval( $match[1] );
2069 * Checks if a given MIME type matches any of the keys in the given
2070 * array. Basic wildcards are accepted in the array keys.
2072 * Returns the matching MIME type (or wildcard) if a match, otherwise
2075 * @param $type String
2076 * @param $avail Array
2080 function mimeTypeMatch( $type, $avail ) {
2081 if( array_key_exists( $type, $avail ) ) {
2084 $parts = explode( '/', $type );
2085 if( array_key_exists( $parts[0] . '/*', $avail ) ) {
2086 return $parts[0] . '/*';
2087 } elseif( array_key_exists( '*/*', $avail ) ) {
2096 * Returns the 'best' match between a client's requested internet media types
2097 * and the server's list of available types. Each list should be an associative
2098 * array of type to preference (preference is a float between 0.0 and 1.0).
2099 * Wildcards in the types are acceptable.
2101 * @param $cprefs Array: client's acceptable type list
2102 * @param $sprefs Array: server's offered types
2105 * @todo FIXME: Doesn't handle params like 'text/plain; charset=UTF-8'
2106 * XXX: generalize to negotiate other stuff
2108 function wfNegotiateType( $cprefs, $sprefs ) {
2111 foreach( array_keys($sprefs) as $type ) {
2112 $parts = explode( '/', $type );
2113 if( $parts[1] != '*' ) {
2114 $ckey = mimeTypeMatch( $type, $cprefs );
2116 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
2121 foreach( array_keys( $cprefs ) as $type ) {
2122 $parts = explode( '/', $type );
2123 if( $parts[1] != '*' && !array_key_exists( $type, $sprefs ) ) {
2124 $skey = mimeTypeMatch( $type, $sprefs );
2126 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
2134 foreach( array_keys( $combine ) as $type ) {
2135 if( $combine[$type] > $bestq ) {
2137 $bestq = $combine[$type];
2145 * Reference-counted warning suppression
2149 function wfSuppressWarnings( $end = false ) {
2150 static $suppressCount = 0;
2151 static $originalLevel = false;
2154 if ( $suppressCount ) {
2156 if ( !$suppressCount ) {
2157 error_reporting( $originalLevel );
2161 if ( !$suppressCount ) {
2162 // E_DEPRECATED is undefined in PHP 5.2
2163 if( !defined( 'E_DEPRECATED' ) ){
2164 define( 'E_DEPRECATED', 8192 );
2166 $originalLevel = error_reporting( E_ALL
& ~
( E_WARNING | E_NOTICE | E_USER_WARNING | E_USER_NOTICE | E_DEPRECATED
) );
2173 * Restore error level to previous value
2175 function wfRestoreWarnings() {
2176 wfSuppressWarnings( true );
2179 # Autodetect, convert and provide timestamps of various types
2182 * Unix time - the number of seconds since 1970-01-01 00:00:00 UTC
2184 define( 'TS_UNIX', 0 );
2187 * MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
2189 define( 'TS_MW', 1 );
2192 * MySQL DATETIME (YYYY-MM-DD HH:MM:SS)
2194 define( 'TS_DB', 2 );
2197 * RFC 2822 format, for E-mail and HTTP headers
2199 define( 'TS_RFC2822', 3 );
2202 * ISO 8601 format with no timezone: 1986-02-09T20:00:00Z
2204 * This is used by Special:Export
2206 define( 'TS_ISO_8601', 4 );
2209 * An Exif timestamp (YYYY:MM:DD HH:MM:SS)
2211 * @see http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the
2212 * DateTime tag and page 36 for the DateTimeOriginal and
2213 * DateTimeDigitized tags.
2215 define( 'TS_EXIF', 5 );
2218 * Oracle format time.
2220 define( 'TS_ORACLE', 6 );
2223 * Postgres format time.
2225 define( 'TS_POSTGRES', 7 );
2230 define( 'TS_DB2', 8 );
2233 * ISO 8601 basic format with no timezone: 19860209T200000Z. This is used by ResourceLoader
2235 define( 'TS_ISO_8601_BASIC', 9 );
2238 * Get a timestamp string in one of various formats
2240 * @param $outputtype Mixed: A timestamp in one of the supported formats, the
2241 * function will autodetect which format is supplied and act
2243 * @param $ts Mixed: the timestamp to convert or 0 for the current timestamp
2244 * @return Mixed: String / false The same date in the format specified in $outputtype or false
2246 function wfTimestamp( $outputtype = TS_UNIX
, $ts = 0 ) {
2251 if ( !$ts ) { // We want to catch 0, '', null... but not date strings starting with a letter.
2254 } elseif ( preg_match( '/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)$/D', $ts, $da ) ) {
2256 } elseif ( preg_match( '/^(\d{4}):(\d\d):(\d\d) (\d\d):(\d\d):(\d\d)$/D', $ts, $da ) ) {
2258 } elseif ( preg_match( '/^(\d{4})(\d\d)(\d\d)(\d\d)(\d\d)(\d\d)$/D', $ts, $da ) ) {
2260 } elseif ( preg_match( '/^-?\d{1,13}$/D', $ts ) ) {
2263 $strtime = "@$ts"; // Undocumented?
2264 } elseif ( preg_match( '/^\d{2}-\d{2}-\d{4} \d{2}:\d{2}:\d{2}.\d{6}$/', $ts ) ) {
2265 # TS_ORACLE // session altered to DD-MM-YYYY HH24:MI:SS.FF6
2266 $strtime = preg_replace( '/(\d\d)\.(\d\d)\.(\d\d)(\.(\d+))?/', "$1:$2:$3",
2267 str_replace( '+00:00', 'UTC', $ts ) );
2268 } elseif ( preg_match( '/^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})(?:\.*\d*)?Z$/', $ts, $da ) ) {
2270 } elseif ( preg_match( '/^(\d{4})(\d{2})(\d{2})T(\d{2})(\d{2})(\d{2})(?:\.*\d*)?Z$/', $ts, $da ) ) {
2272 } elseif ( preg_match( '/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)\.*\d*[\+\- ](\d\d)$/', $ts, $da ) ) {
2274 } elseif ( preg_match( '/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)\.*\d* GMT$/', $ts, $da ) ) {
2276 } elseif (preg_match('/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)\.\d\d\d$/',$ts,$da)) {
2278 } elseif ( preg_match( '/^[ \t\r\n]*([A-Z][a-z]{2},[ \t\r\n]*)?' . # Day of week
2279 '\d\d?[ \t\r\n]*[A-Z][a-z]{2}[ \t\r\n]*\d{2}(?:\d{2})?' . # dd Mon yyyy
2280 '[ \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
2281 # TS_RFC2822, accepting a trailing comment. See http://www.squid-cache.org/mail-archive/squid-users/200307/0122.html / r77171
2282 # The regex is a superset of rfc2822 for readability
2283 $strtime = strtok( $ts, ';' );
2284 } 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 ) ) {
2287 } 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 ) ) {
2292 wfDebug("wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n");
2297 static $formats = array(
2300 TS_DB
=> 'Y-m-d H:i:s',
2301 TS_ISO_8601
=> 'Y-m-d\TH:i:s\Z',
2302 TS_ISO_8601_BASIC
=> 'Ymd\THis\Z',
2303 TS_EXIF
=> 'Y:m:d H:i:s', // This shouldn't ever be used, but is included for completeness
2304 TS_RFC2822
=> 'D, d M Y H:i:s',
2305 TS_ORACLE
=> 'd-m-Y H:i:s.000000', // Was 'd-M-y h.i.s A' . ' +00:00' before r51500
2306 TS_POSTGRES
=> 'Y-m-d H:i:s',
2307 TS_DB2
=> 'Y-m-d H:i:s',
2310 if ( !isset( $formats[$outputtype] ) ) {
2311 throw new MWException( 'wfTimestamp() called with illegal output type.' );
2314 if ( function_exists( "date_create" ) ) {
2315 if ( count( $da ) ) {
2316 $ds = sprintf("%04d-%02d-%02dT%02d:%02d:%02d.00+00:00",
2317 (int)$da[1], (int)$da[2], (int)$da[3],
2318 (int)$da[4], (int)$da[5], (int)$da[6]);
2320 $d = date_create( $ds, new DateTimeZone( 'GMT' ) );
2321 } elseif ( $strtime ) {
2322 $d = date_create( $strtime, new DateTimeZone( 'GMT' ) );
2328 wfDebug("wfTimestamp() fed bogus time value: $outputtype; $ts\n");
2332 $output = $d->format( $formats[$outputtype] );
2334 if ( count( $da ) ) {
2335 // Warning! gmmktime() acts oddly if the month or day is set to 0
2336 // We may want to handle that explicitly at some point
2337 $uts = gmmktime( (int)$da[4], (int)$da[5], (int)$da[6],
2338 (int)$da[2], (int)$da[3], (int)$da[1] );
2339 } elseif ( $strtime ) {
2340 $uts = strtotime( $strtime );
2343 if ( $uts === false ) {
2344 wfDebug("wfTimestamp() can't parse the timestamp (non 32-bit time? Update php): $outputtype; $ts\n");
2348 if ( TS_UNIX
== $outputtype ) {
2351 $output = gmdate( $formats[$outputtype], $uts );
2354 if ( ( $outputtype == TS_RFC2822
) ||
( $outputtype == TS_POSTGRES
) ) {
2362 * Return a formatted timestamp, or null if input is null.
2363 * For dealing with nullable timestamp columns in the database.
2365 * @param $outputtype Integer
2369 function wfTimestampOrNull( $outputtype = TS_UNIX
, $ts = null ) {
2370 if( is_null( $ts ) ) {
2373 return wfTimestamp( $outputtype, $ts );
2378 * Convenience function; returns MediaWiki timestamp for the present time.
2382 function wfTimestampNow() {
2384 return wfTimestamp( TS_MW
, time() );
2388 * Check if the operating system is Windows
2390 * @return Bool: true if it's Windows, False otherwise.
2392 function wfIsWindows() {
2393 static $isWindows = null;
2394 if ( $isWindows === null ) {
2395 $isWindows = substr( php_uname(), 0, 7 ) == 'Windows';
2401 * Check if we are running under HipHop
2405 function wfIsHipHop() {
2406 return function_exists( 'hphp_thread_set_warmup_enabled' );
2410 * Swap two variables
2415 function swap( &$x, &$y ) {
2422 * Tries to get the system directory for temporary files. The TMPDIR, TMP, and
2423 * TEMP environment variables are then checked in sequence, and if none are set
2424 * try sys_get_temp_dir() for PHP >= 5.2.1. All else fails, return /tmp for Unix
2425 * or C:\Windows\Temp for Windows and hope for the best.
2426 * It is common to call it with tempnam().
2428 * NOTE: When possible, use instead the tmpfile() function to create
2429 * temporary files to avoid race conditions on file creation, etc.
2433 function wfTempDir() {
2434 foreach( array( 'TMPDIR', 'TMP', 'TEMP' ) as $var ) {
2435 $tmp = getenv( $var );
2436 if( $tmp && file_exists( $tmp ) && is_dir( $tmp ) && is_writable( $tmp ) ) {
2440 if( function_exists( 'sys_get_temp_dir' ) ) {
2441 return sys_get_temp_dir();
2444 return wfIsWindows() ?
'C:\Windows\Temp' : '/tmp';
2448 * Make directory, and make all parent directories if they don't exist
2450 * @param $dir String: full path to directory to create
2451 * @param $mode Integer: chmod value to use, default is $wgDirectoryMode
2452 * @param $caller String: optional caller param for debugging.
2455 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2456 global $wgDirectoryMode;
2458 if ( !is_null( $caller ) ) {
2459 wfDebug( "$caller: called wfMkdirParents($dir)" );
2462 if( strval( $dir ) === '' ||
file_exists( $dir ) ) {
2466 $dir = str_replace( array( '\\', '/' ), DIRECTORY_SEPARATOR
, $dir );
2468 if ( is_null( $mode ) ) {
2469 $mode = $wgDirectoryMode;
2472 // Turn off the normal warning, we're doing our own below
2473 wfSuppressWarnings();
2474 $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2475 wfRestoreWarnings();
2478 // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2479 trigger_error( __FUNCTION__
. ": failed to mkdir \"$dir\" mode $mode", E_USER_WARNING
);
2485 * Increment a statistics counter
2487 * @param $key String
2490 function wfIncrStats( $key, $count = 1 ) {
2491 global $wgStatsMethod;
2493 $count = intval( $count );
2495 if( $wgStatsMethod == 'udp' ) {
2496 global $wgUDPProfilerHost, $wgUDPProfilerPort, $wgDBname, $wgAggregateStatsID;
2499 $id = $wgAggregateStatsID !== false ?
$wgAggregateStatsID : $wgDBname;
2502 $socket = socket_create( AF_INET
, SOCK_DGRAM
, SOL_UDP
);
2503 $statline = "stats/{$id} - {$count} 1 1 1 1 -total\n";
2507 strlen( $statline ),
2513 $statline = "stats/{$id} - {$count} 1 1 1 1 {$key}\n";
2514 wfSuppressWarnings();
2518 strlen( $statline ),
2523 wfRestoreWarnings();
2524 } elseif( $wgStatsMethod == 'cache' ) {
2526 $key = wfMemcKey( 'stats', $key );
2527 if ( is_null( $wgMemc->incr( $key, $count ) ) ) {
2528 $wgMemc->add( $key, $count );
2536 * @param $nr Mixed: the number to format
2537 * @param $acc Integer: the number of digits after the decimal point, default 2
2538 * @param $round Boolean: whether or not to round the value, default true
2541 function wfPercent( $nr, $acc = 2, $round = true ) {
2542 $ret = sprintf( "%.${acc}f", $nr );
2543 return $round ?
round( $ret, $acc ) . '%' : "$ret%";
2547 * Find out whether or not a mixed variable exists in a string
2549 * @param $needle String
2550 * @param $str String
2551 * @param $insensitive Boolean
2554 function in_string( $needle, $str, $insensitive = false ) {
2556 if( $insensitive ) $func = 'stripos';
2558 return $func( $str, $needle ) !== false;
2562 * Make a list item, used by various special pages
2564 * @param $page String Page link
2565 * @param $details String Text between brackets
2566 * @param $oppositedm Boolean Add the direction mark opposite to your
2567 * language, to display text properly
2570 function wfSpecialList( $page, $details, $oppositedm = true ) {
2572 $dirmark = ( $oppositedm ?
$wgLang->getDirMark( true ) : '' ) .
2573 $wgLang->getDirMark();
2574 $details = $details ?
$dirmark . " ($details)" : '';
2575 return $page . $details;
2579 * Safety wrapper around ini_get() for boolean settings.
2580 * The values returned from ini_get() are pre-normalized for settings
2581 * set via php.ini or php_flag/php_admin_flag... but *not*
2582 * for those set via php_value/php_admin_value.
2584 * It's fairly common for people to use php_value instead of php_flag,
2585 * which can leave you with an 'off' setting giving a false positive
2586 * for code that just takes the ini_get() return value as a boolean.
2588 * To make things extra interesting, setting via php_value accepts
2589 * "true" and "yes" as true, but php.ini and php_flag consider them false. :)
2590 * Unrecognized values go false... again opposite PHP's own coercion
2591 * from string to bool.
2593 * Luckily, 'properly' set settings will always come back as '0' or '1',
2594 * so we only have to worry about them and the 'improper' settings.
2596 * I frickin' hate PHP... :P
2598 * @param $setting String
2601 function wfIniGetBool( $setting ) {
2602 $val = ini_get( $setting );
2603 // 'on' and 'true' can't have whitespace around them, but '1' can.
2604 return strtolower( $val ) == 'on'
2605 ||
strtolower( $val ) == 'true'
2606 ||
strtolower( $val ) == 'yes'
2607 ||
preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2611 * Wrapper function for PHP's dl(). This doesn't work in most situations from
2612 * PHP 5.3 onward, and is usually disabled in shared environments anyway.
2614 * @param $extension String A PHP extension. The file suffix (.so or .dll)
2616 * @param $fileName String Name of the library, if not $extension.suffix
2617 * @return Bool - Whether or not the extension is loaded
2619 function wfDl( $extension, $fileName = null ) {
2620 if( extension_loaded( $extension ) ) {
2625 $sapi = php_sapi_name();
2626 if( version_compare( PHP_VERSION
, '5.3.0', '<' ) ||
2627 $sapi == 'cli' ||
$sapi == 'cgi' ||
$sapi == 'embed' )
2629 $canDl = ( function_exists( 'dl' ) && is_callable( 'dl' )
2630 && wfIniGetBool( 'enable_dl' ) && !wfIniGetBool( 'safe_mode' ) );
2634 $fileName = $fileName ?
$fileName : $extension;
2635 if( wfIsWindows() ) {
2636 $fileName = 'php_' . $fileName;
2638 wfSuppressWarnings();
2639 dl( $fileName . '.' . PHP_SHLIB_SUFFIX
);
2640 wfRestoreWarnings();
2642 return extension_loaded( $extension );
2646 * Execute a shell command, with time and memory limits mirrored from the PHP
2647 * configuration if supported.
2648 * @param $cmd String Command line, properly escaped for shell.
2649 * @param &$retval optional, will receive the program's exit code.
2650 * (non-zero is usually failure)
2651 * @param $environ Array optional environment variables which should be
2652 * added to the executed command environment.
2653 * @return collected stdout as a string (trailing newlines stripped)
2655 function wfShellExec( $cmd, &$retval = null, $environ = array() ) {
2656 global $IP, $wgMaxShellMemory, $wgMaxShellFileSize, $wgMaxShellTime;
2659 if ( is_null( $disabled ) ) {
2661 if( wfIniGetBool( 'safe_mode' ) ) {
2662 wfDebug( "wfShellExec can't run in safe_mode, PHP's exec functions are too broken.\n" );
2663 $disabled = 'safemode';
2665 $functions = explode( ',', ini_get( 'disable_functions' ) );
2666 $functions = array_map( 'trim', $functions );
2667 $functions = array_map( 'strtolower', $functions );
2668 if ( in_array( 'passthru', $functions ) ) {
2669 wfDebug( "passthru is in disabled_functions\n" );
2670 $disabled = 'passthru';
2676 return $disabled == 'safemode' ?
2677 'Unable to run external programs in safe mode.' :
2678 'Unable to run external programs, passthru() is disabled.';
2681 wfInitShellLocale();
2684 foreach( $environ as $k => $v ) {
2685 if ( wfIsWindows() ) {
2686 /* Surrounding a set in quotes (method used by wfEscapeShellArg) makes the quotes themselves
2687 * appear in the environment variable, so we must use carat escaping as documented in
2688 * http://technet.microsoft.com/en-us/library/cc723564.aspx
2689 * Note however that the quote isn't listed there, but is needed, and the parentheses
2690 * are listed there but doesn't appear to need it.
2692 $envcmd .= "set $k=" . preg_replace( '/([&|()<>^"])/', '^\\1', $v ) . '&& ';
2694 /* Assume this is a POSIX shell, thus required to accept variable assignments before the command
2695 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_09_01
2697 $envcmd .= "$k=" . escapeshellarg( $v ) . ' ';
2700 $cmd = $envcmd . $cmd;
2702 if ( wfIsWindows() ) {
2703 if ( version_compare( PHP_VERSION
, '5.3.0', '<' ) && /* Fixed in 5.3.0 :) */
2704 ( version_compare( PHP_VERSION
, '5.2.1', '>=' ) ||
php_uname( 's' ) == 'Windows NT' ) )
2706 # Hack to work around PHP's flawed invocation of cmd.exe
2707 # http://news.php.net/php.internals/21796
2708 # Windows 9x doesn't accept any kind of quotes
2709 $cmd = '"' . $cmd . '"';
2711 } elseif ( php_uname( 's' ) == 'Linux' ) {
2712 $time = intval( $wgMaxShellTime );
2713 $mem = intval( $wgMaxShellMemory );
2714 $filesize = intval( $wgMaxShellFileSize );
2716 if ( $time > 0 && $mem > 0 ) {
2717 $script = "$IP/bin/ulimit4.sh";
2718 if ( is_executable( $script ) ) {
2719 $cmd = '/bin/bash ' . escapeshellarg( $script ) . " $time $mem $filesize " . escapeshellarg( $cmd );
2723 wfDebug( "wfShellExec: $cmd\n" );
2725 $retval = 1; // error by default?
2727 passthru( $cmd, $retval );
2728 $output = ob_get_contents();
2731 if ( $retval == 127 ) {
2732 wfDebugLog( 'exec', "Possibly missing executable file: $cmd\n" );
2738 * Workaround for http://bugs.php.net/bug.php?id=45132
2739 * escapeshellarg() destroys non-ASCII characters if LANG is not a UTF-8 locale
2741 function wfInitShellLocale() {
2742 static $done = false;
2747 global $wgShellLocale;
2748 if ( !wfIniGetBool( 'safe_mode' ) ) {
2749 putenv( "LC_CTYPE=$wgShellLocale" );
2750 setlocale( LC_CTYPE
, $wgShellLocale );
2755 * This function works like "use VERSION" in Perl, the program will die with a
2756 * backtrace if the current version of PHP is less than the version provided
2758 * This is useful for extensions which due to their nature are not kept in sync
2759 * with releases, and might depend on other versions of PHP than the main code
2761 * Note: PHP might die due to parsing errors in some cases before it ever
2762 * manages to call this function, such is life
2764 * @see perldoc -f use
2766 * @param $req_ver Mixed: the version to check, can be a string, an integer, or
2769 function wfUsePHP( $req_ver ) {
2770 $php_ver = PHP_VERSION
;
2772 if ( version_compare( $php_ver, (string)$req_ver, '<' ) ) {
2773 throw new MWException( "PHP $req_ver required--this is only $php_ver" );
2778 * This function works like "use VERSION" in Perl except it checks the version
2779 * of MediaWiki, the program will die with a backtrace if the current version
2780 * of MediaWiki is less than the version provided.
2782 * This is useful for extensions which due to their nature are not kept in sync
2785 * @see perldoc -f use
2787 * @param $req_ver Mixed: the version to check, can be a string, an integer, or
2790 function wfUseMW( $req_ver ) {
2793 if ( version_compare( $wgVersion, (string)$req_ver, '<' ) ) {
2794 throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
2799 * Return the final portion of a pathname.
2800 * Reimplemented because PHP5's basename() is buggy with multibyte text.
2801 * http://bugs.php.net/bug.php?id=33898
2803 * PHP's basename() only considers '\' a pathchar on Windows and Netware.
2804 * We'll consider it so always, as we don't want \s in our Unix paths either.
2806 * @param $path String
2807 * @param $suffix String: to remove if present
2810 function wfBaseName( $path, $suffix = '' ) {
2811 $encSuffix = ( $suffix == '' )
2813 : ( '(?:' . preg_quote( $suffix, '#' ) . ')?' );
2815 if( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
2823 * Generate a relative path name to the given file.
2824 * May explode on non-matching case-insensitive paths,
2825 * funky symlinks, etc.
2827 * @param $path String: absolute destination path including target filename
2828 * @param $from String: Absolute source path, directory only
2831 function wfRelativePath( $path, $from ) {
2832 // Normalize mixed input on Windows...
2833 $path = str_replace( '/', DIRECTORY_SEPARATOR
, $path );
2834 $from = str_replace( '/', DIRECTORY_SEPARATOR
, $from );
2836 // Trim trailing slashes -- fix for drive root
2837 $path = rtrim( $path, DIRECTORY_SEPARATOR
);
2838 $from = rtrim( $from, DIRECTORY_SEPARATOR
);
2840 $pieces = explode( DIRECTORY_SEPARATOR
, dirname( $path ) );
2841 $against = explode( DIRECTORY_SEPARATOR
, $from );
2843 if( $pieces[0] !== $against[0] ) {
2844 // Non-matching Windows drive letters?
2845 // Return a full path.
2849 // Trim off common prefix
2850 while( count( $pieces ) && count( $against )
2851 && $pieces[0] == $against[0] ) {
2852 array_shift( $pieces );
2853 array_shift( $against );
2856 // relative dots to bump us to the parent
2857 while( count( $against ) ) {
2858 array_unshift( $pieces, '..' );
2859 array_shift( $against );
2862 array_push( $pieces, wfBaseName( $path ) );
2864 return implode( DIRECTORY_SEPARATOR
, $pieces );
2868 * Do any deferred updates and clear the list
2870 * @param $commit String: set to 'commit' to commit after every update to
2871 * prevent lock contention
2873 function wfDoUpdates( $commit = '' ) {
2874 global $wgDeferredUpdateList;
2876 wfProfileIn( __METHOD__
);
2878 // No need to get master connections in case of empty updates array
2879 if ( !count( $wgDeferredUpdateList ) ) {
2880 wfProfileOut( __METHOD__
);
2884 $doCommit = $commit == 'commit';
2886 $dbw = wfGetDB( DB_MASTER
);
2889 foreach ( $wgDeferredUpdateList as $update ) {
2890 $update->doUpdate();
2892 if ( $doCommit && $dbw->trxLevel() ) {
2897 $wgDeferredUpdateList = array();
2898 wfProfileOut( __METHOD__
);
2902 * Convert an arbitrarily-long digit string from one numeric base
2903 * to another, optionally zero-padding to a minimum column width.
2905 * Supports base 2 through 36; digit values 10-36 are represented
2906 * as lowercase letters a-z. Input is case-insensitive.
2908 * @param $input String: of digits
2909 * @param $sourceBase Integer: 2-36
2910 * @param $destBase Integer: 2-36
2911 * @param $pad Integer: 1 or greater
2912 * @param $lowercase Boolean
2913 * @return String or false on invalid input
2915 function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1, $lowercase = true ) {
2916 $input = strval( $input );
2917 if( $sourceBase < 2 ||
2922 $sourceBase != intval( $sourceBase ) ||
2923 $destBase != intval( $destBase ) ||
2924 $pad != intval( $pad ) ||
2925 !is_string( $input ) ||
2929 $digitChars = ( $lowercase ) ?
'0123456789abcdefghijklmnopqrstuvwxyz' : '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ';
2930 $inDigits = array();
2933 // Decode and validate input string
2934 $input = strtolower( $input );
2935 for( $i = 0; $i < strlen( $input ); $i++
) {
2936 $n = strpos( $digitChars, $input[$i] );
2937 if( $n === false ||
$n > $sourceBase ) {
2943 // Iterate over the input, modulo-ing out an output digit
2944 // at a time until input is gone.
2945 while( count( $inDigits ) ) {
2947 $workDigits = array();
2950 foreach( $inDigits as $digit ) {
2951 $work *= $sourceBase;
2954 if( $work < $destBase ) {
2955 // Gonna need to pull another digit.
2956 if( count( $workDigits ) ) {
2957 // Avoid zero-padding; this lets us find
2958 // the end of the input very easily when
2959 // length drops to zero.
2963 // Finally! Actual division!
2964 $workDigits[] = intval( $work / $destBase );
2966 // Isn't it annoying that most programming languages
2967 // don't have a single divide-and-remainder operator,
2968 // even though the CPU implements it that way?
2969 $work = $work %
$destBase;
2973 // All that division leaves us with a remainder,
2974 // which is conveniently our next output digit.
2975 $outChars .= $digitChars[$work];
2978 $inDigits = $workDigits;
2981 while( strlen( $outChars ) < $pad ) {
2985 return strrev( $outChars );
2989 * Create an object with a given name and an array of construct parameters
2991 * @param $name String
2992 * @param $p Array: parameters
2993 * @deprecated since 1.18, warnings in 1.18, removal in 1.20
2995 function wfCreateObject( $name, $p ) {
2996 wfDeprecated( __FUNCTION__
);
2997 return MWFunction
::newObj( $name, $p );
3000 function wfHttpOnlySafe() {
3001 global $wgHttpOnlyBlacklist;
3003 if( isset( $_SERVER['HTTP_USER_AGENT'] ) ) {
3004 foreach( $wgHttpOnlyBlacklist as $regex ) {
3005 if( preg_match( $regex, $_SERVER['HTTP_USER_AGENT'] ) ) {
3015 * Initialise php session
3017 * @param $sessionId Bool
3019 function wfSetupSession( $sessionId = false ) {
3020 global $wgSessionsInMemcached, $wgCookiePath, $wgCookieDomain,
3021 $wgCookieSecure, $wgCookieHttpOnly, $wgSessionHandler;
3022 if( $wgSessionsInMemcached ) {
3023 if ( !defined( 'MW_COMPILED' ) ) {
3025 require_once( "$IP/includes/cache/MemcachedSessions.php" );
3027 session_set_save_handler( 'memsess_open', 'memsess_close', 'memsess_read',
3028 'memsess_write', 'memsess_destroy', 'memsess_gc' );
3030 // It's necessary to register a shutdown function to call session_write_close(),
3031 // because by the time the request shutdown function for the session module is
3032 // called, $wgMemc has already been destroyed. Shutdown functions registered
3033 // this way are called before object destruction.
3034 register_shutdown_function( 'memsess_write_close' );
3035 } elseif( $wgSessionHandler && $wgSessionHandler != ini_get( 'session.save_handler' ) ) {
3036 # Only set this if $wgSessionHandler isn't null and session.save_handler
3037 # hasn't already been set to the desired value (that causes errors)
3038 ini_set( 'session.save_handler', $wgSessionHandler );
3040 $httpOnlySafe = wfHttpOnlySafe() && $wgCookieHttpOnly;
3041 wfDebugLog( 'cookie',
3042 'session_set_cookie_params: "' . implode( '", "',
3048 $httpOnlySafe ) ) . '"' );
3049 session_set_cookie_params( 0, $wgCookiePath, $wgCookieDomain, $wgCookieSecure, $httpOnlySafe );
3050 session_cache_limiter( 'private, must-revalidate' );
3052 session_id( $sessionId );
3054 wfSuppressWarnings();
3056 wfRestoreWarnings();
3060 * Get an object from the precompiled serialized directory
3062 * @param $name String
3063 * @return Mixed: the variable on success, false on failure
3065 function wfGetPrecompiledData( $name ) {
3068 $file = "$IP/serialized/$name";
3069 if ( file_exists( $file ) ) {
3070 $blob = file_get_contents( $file );
3072 return unserialize( $blob );
3084 function wfMemcKey( /*... */ ) {
3085 $args = func_get_args();
3086 $key = wfWikiID() . ':' . implode( ':', $args );
3087 $key = str_replace( ' ', '_', $key );
3092 * Get a cache key for a foreign DB
3095 * @param $prefix String
3096 * @param varargs String
3099 function wfForeignMemcKey( $db, $prefix /*, ... */ ) {
3100 $args = array_slice( func_get_args(), 2 );
3102 $key = "$db-$prefix:" . implode( ':', $args );
3104 $key = $db . ':' . implode( ':', $args );
3110 * Get an ASCII string identifying this wiki
3111 * This is used as a prefix in memcached keys
3115 function wfWikiID() {
3116 global $wgDBprefix, $wgDBname;
3117 if ( $wgDBprefix ) {
3118 return "$wgDBname-$wgDBprefix";
3125 * Split a wiki ID into DB name and table prefix
3127 * @param $wiki String
3128 * @param $bits String
3130 function wfSplitWikiID( $wiki ) {
3131 $bits = explode( '-', $wiki, 2 );
3132 if ( count( $bits ) < 2 ) {
3139 * Get a Database object.
3141 * @param $db Integer: index of the connection to get. May be DB_MASTER for the
3142 * master (for write queries), DB_SLAVE for potentially lagged read
3143 * queries, or an integer >= 0 for a particular server.
3145 * @param $groups Mixed: query groups. An array of group names that this query
3146 * belongs to. May contain a single string if the query is only
3149 * @param $wiki String: the wiki ID, or false for the current wiki
3151 * Note: multiple calls to wfGetDB(DB_SLAVE) during the course of one request
3152 * will always return the same object, unless the underlying connection or load
3153 * balancer is manually destroyed.
3155 * Note 2: use $this->getDB() in maintenance scripts that may be invoked by
3156 * updater to ensure that a proper database is being updated.
3158 * @return DatabaseBase
3160 function &wfGetDB( $db, $groups = array(), $wiki = false ) {
3161 return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
3165 * Get a load balancer object.
3167 * @param $wiki String: wiki ID, or false for the current wiki
3168 * @return LoadBalancer
3170 function wfGetLB( $wiki = false ) {
3171 return wfGetLBFactory()->getMainLB( $wiki );
3175 * Get the load balancer factory object
3179 function &wfGetLBFactory() {
3180 return LBFactory
::singleton();
3185 * Shortcut for RepoGroup::singleton()->findFile()
3187 * @param $title String or Title object
3188 * @param $options Associative array of options:
3189 * time: requested time for an archived image, or false for the
3190 * current version. An image object will be returned which was
3191 * created at the specified time.
3193 * ignoreRedirect: If true, do not follow file redirects
3195 * private: If true, return restricted (deleted) files if the current
3196 * user is allowed to view them. Otherwise, such files will not
3199 * bypassCache: If true, do not use the process-local cache of File objects
3201 * @return File, or false if the file does not exist
3203 function wfFindFile( $title, $options = array() ) {
3204 return RepoGroup
::singleton()->findFile( $title, $options );
3208 * Get an object referring to a locally registered file.
3209 * Returns a valid placeholder object if the file does not exist.
3211 * @param $title Title or String
3212 * @return File, or null if passed an invalid Title
3214 function wfLocalFile( $title ) {
3215 return RepoGroup
::singleton()->getLocalRepo()->newFile( $title );
3219 * Stream a file to the browser. Back-compat alias for StreamFile::stream()
3220 * @deprecated since 1.19
3222 function wfStreamFile( $fname, $headers = array() ) {
3223 StreamFile
::stream( $fname, $headers );
3227 * Should low-performance queries be disabled?
3230 * @codeCoverageIgnore
3232 function wfQueriesMustScale() {
3233 global $wgMiserMode;
3235 ||
( SiteStats
::pages() > 100000
3236 && SiteStats
::edits() > 1000000
3237 && SiteStats
::users() > 10000 );
3241 * Get the path to a specified script file, respecting file
3242 * extensions; this is a wrapper around $wgScriptExtension etc.
3244 * @param $script String: script filename, sans extension
3247 function wfScript( $script = 'index' ) {
3248 global $wgScriptPath, $wgScriptExtension;
3249 return "{$wgScriptPath}/{$script}{$wgScriptExtension}";
3253 * Get the script URL.
3255 * @return script URL
3257 function wfGetScriptUrl() {
3258 if( isset( $_SERVER['SCRIPT_NAME'] ) ) {
3260 # as it was called, minus the query string.
3262 # Some sites use Apache rewrite rules to handle subdomains,
3263 # and have PHP set up in a weird way that causes PHP_SELF
3264 # to contain the rewritten URL instead of the one that the
3265 # outside world sees.
3267 # If in this mode, use SCRIPT_URL instead, which mod_rewrite
3268 # provides containing the "before" URL.
3269 return $_SERVER['SCRIPT_NAME'];
3271 return $_SERVER['URL'];
3276 * Convenience function converts boolean values into "true"
3277 * or "false" (string) values
3279 * @param $value Boolean
3282 function wfBoolToStr( $value ) {
3283 return $value ?
'true' : 'false';
3287 * Load an extension messages file
3289 * @deprecated since 1.16, warnings in 1.18, remove in 1.20
3290 * @codeCoverageIgnore
3292 function wfLoadExtensionMessages() {
3293 wfDeprecated( __FUNCTION__
);
3297 * Get a platform-independent path to the null file, e.g. /dev/null
3301 function wfGetNull() {
3302 return wfIsWindows()
3308 * Throws a warning that $function is deprecated
3310 * @param $function String
3313 function wfDeprecated( $function ) {
3314 static $functionsWarned = array();
3315 if ( !isset( $functionsWarned[$function] ) ) {
3316 $functionsWarned[$function] = true;
3317 wfWarn( "Use of $function is deprecated.", 2 );
3322 * Send a warning either to the debug log or in a PHP error depending on
3323 * $wgDevelopmentWarnings
3325 * @param $msg String: message to send
3326 * @param $callerOffset Integer: number of items to go back in the backtrace to
3327 * find the correct caller (1 = function calling wfWarn, ...)
3328 * @param $level Integer: PHP error level; only used when $wgDevelopmentWarnings
3331 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE
) {
3332 global $wgDevelopmentWarnings;
3334 $callers = wfDebugBacktrace();
3335 if ( isset( $callers[$callerOffset +
1] ) ) {
3336 $callerfunc = $callers[$callerOffset +
1];
3337 $callerfile = $callers[$callerOffset];
3338 if ( isset( $callerfile['file'] ) && isset( $callerfile['line'] ) ) {
3339 $file = $callerfile['file'] . ' at line ' . $callerfile['line'];
3341 $file = '(internal function)';
3344 if ( isset( $callerfunc['class'] ) ) {
3345 $func .= $callerfunc['class'] . '::';
3347 if ( isset( $callerfunc['function'] ) ) {
3348 $func .= $callerfunc['function'];
3350 $msg .= " [Called from $func in $file]";
3353 if ( $wgDevelopmentWarnings ) {
3354 trigger_error( $msg, $level );
3356 wfDebug( "$msg\n" );
3361 * Modern version of wfWaitForSlaves(). Instead of looking at replication lag
3362 * and waiting for it to go down, this waits for the slaves to catch up to the
3363 * master position. Use this when updating very large numbers of rows, as
3364 * in maintenance scripts, to avoid causing too much lag. Of course, this is
3365 * a no-op if there are no slaves.
3367 * @param $maxLag Integer (deprecated)
3368 * @param $wiki mixed Wiki identifier accepted by wfGetLB
3371 function wfWaitForSlaves( $maxLag = false, $wiki = false ) {
3372 $lb = wfGetLB( $wiki );
3373 // bug 27975 - Don't try to wait for slaves if there are none
3374 // Prevents permission error when getting master position
3375 if ( $lb->getServerCount() > 1 ) {
3376 $dbw = $lb->getConnection( DB_MASTER
);
3377 $pos = $dbw->getMasterPos();
3378 $lb->waitForAll( $pos );
3383 * Used to be used for outputting text in the installer/updater
3384 * @deprecated since 1.18, warnings in 1.18, remove in 1.20
3386 function wfOut( $s ) {
3387 wfDeprecated( __METHOD__
);
3388 global $wgCommandLineMode;
3389 if ( $wgCommandLineMode ) {
3392 echo htmlspecialchars( $s );
3398 * Count down from $n to zero on the terminal, with a one-second pause
3399 * between showing each number. For use in command-line scripts.
3400 * @codeCoverageIgnore
3402 function wfCountDown( $n ) {
3403 for ( $i = $n; $i >= 0; $i-- ) {
3405 echo str_repeat( "\x08", strlen( $i +
1 ) );
3417 * Generate a random 32-character hexadecimal token.
3418 * @param $salt Mixed: some sort of salt, if necessary, to add to random
3419 * characters before hashing.
3421 * @codeCoverageIgnore
3423 function wfGenerateToken( $salt = '' ) {
3424 $salt = serialize( $salt );
3425 return md5( mt_rand( 0, 0x7fffffff ) . $salt );
3429 * Replace all invalid characters with -
3431 * @param $name Mixed: filename to process
3434 function wfStripIllegalFilenameChars( $name ) {
3435 global $wgIllegalFileChars;
3436 $name = wfBaseName( $name );
3437 $name = preg_replace(
3438 "/[^" . Title
::legalChars() . "]" .
3439 ( $wgIllegalFileChars ?
"|[" . $wgIllegalFileChars . "]" : '' ) .
3448 * Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit;
3450 * @return Integer value memory was set to.
3452 function wfMemoryLimit() {
3453 global $wgMemoryLimit;
3454 $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
3455 if( $memlimit != -1 ) {
3456 $conflimit = wfShorthandToInteger( $wgMemoryLimit );
3457 if( $conflimit == -1 ) {
3458 wfDebug( "Removing PHP's memory limit\n" );
3459 wfSuppressWarnings();
3460 ini_set( 'memory_limit', $conflimit );
3461 wfRestoreWarnings();
3463 } elseif ( $conflimit > $memlimit ) {
3464 wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
3465 wfSuppressWarnings();
3466 ini_set( 'memory_limit', $conflimit );
3467 wfRestoreWarnings();
3475 * Converts shorthand byte notation to integer form
3477 * @param $string String
3480 function wfShorthandToInteger( $string = '' ) {
3481 $string = trim( $string );
3482 if( $string === '' ) {
3485 $last = $string[strlen( $string ) - 1];
3486 $val = intval( $string );
3491 // break intentionally missing
3495 // break intentionally missing
3505 * Get the normalised IETF language tag
3506 * See unit test for examples.
3508 * @param $code String: The language code.
3509 * @return $langCode String: The language code which complying with BCP 47 standards.
3511 function wfBCP47( $code ) {
3512 $codeSegment = explode( '-', $code );
3514 foreach ( $codeSegment as $segNo => $seg ) {
3515 if ( count( $codeSegment ) > 0 ) {
3516 // when previous segment is x, it is a private segment and should be lc
3517 if( $segNo > 0 && strtolower( $codeSegment[($segNo - 1)] ) == 'x') {
3518 $codeBCP[$segNo] = strtolower( $seg );
3519 // ISO 3166 country code
3520 } elseif ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) {
3521 $codeBCP[$segNo] = strtoupper( $seg );
3522 // ISO 15924 script code
3523 } elseif ( ( strlen( $seg ) == 4 ) && ( $segNo > 0 ) ) {
3524 $codeBCP[$segNo] = ucfirst( strtolower( $seg ) );
3525 // Use lowercase for other cases
3527 $codeBCP[$segNo] = strtolower( $seg );
3530 // Use lowercase for single segment
3531 $codeBCP[$segNo] = strtolower( $seg );
3534 $langCode = implode( '-', $codeBCP );
3539 * Get a cache object.
3541 * @param $inputType integer Cache type, one the the CACHE_* constants.
3544 function wfGetCache( $inputType ) {
3545 return ObjectCache
::getInstance( $inputType );
3549 * Get the main cache object
3553 function wfGetMainCache() {
3554 global $wgMainCacheType;
3555 return ObjectCache
::getInstance( $wgMainCacheType );
3559 * Get the cache object used by the message cache
3563 function wfGetMessageCacheStorage() {
3564 global $wgMessageCacheType;
3565 return ObjectCache
::getInstance( $wgMessageCacheType );
3569 * Get the cache object used by the parser cache
3573 function wfGetParserCacheStorage() {
3574 global $wgParserCacheType;
3575 return ObjectCache
::getInstance( $wgParserCacheType );
3579 * Call hook functions defined in $wgHooks
3581 * @param $event String: event name
3582 * @param $args Array: parameters passed to hook functions
3585 function wfRunHooks( $event, $args = array() ) {
3586 return Hooks
::run( $event, $args );