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
440 * PROTO_CANONICAL: For URLs without a domain, like /w/index.php , use $wgCanonicalServer. For protocol-relative URLs, use the protocol of $wgCanonicalServer
441 * PROTO_INTERNAL: Like PROTO_CANONICAL, but uses $wgInternalServer instead of $wgCanonicalServer
443 * @todo this won't work with current-path-relative URLs
444 * like "subdir/foo.html", etc.
446 * @param $url String: either fully-qualified or a local path + query
447 * @param $defaultProto Mixed: one of the PROTO_* constants. Determines the protocol to use if $url or $wgServer is protocol-relative
448 * @return string Fully-qualified URL
450 function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT
) {
451 global $wgServer, $wgCanonicalServer, $wgInternalServer;
452 $serverUrl = $wgServer;
453 if ( $defaultProto === PROTO_CANONICAL
) {
454 $serverUrl = $wgCanonicalServer;
456 // Make $wgInternalServer fall back to $wgServer if not set
457 if ( $defaultProto === PROTO_INTERNAL
&& $wgInternalServer !== false ) {
458 $serverUrl = $wgInternalServer;
460 if ( $defaultProto === PROTO_CURRENT
) {
461 $defaultProto = WebRequest
::detectProtocol() . '://';
464 // Analyze $serverUrl to obtain its protocol
465 $bits = wfParseUrl( $serverUrl );
466 $serverHasProto = $bits && $bits['scheme'] != '';
468 if ( $defaultProto === PROTO_CANONICAL ||
$defaultProto === PROTO_INTERNAL
) {
469 if ( $serverHasProto ) {
470 $defaultProto = $bits['scheme'] . '://';
472 // $wgCanonicalServer or $wgInternalServer doesn't have a protocol. This really isn't supposed to happen
473 // Fall back to HTTP in this ridiculous case
474 $defaultProto = PROTO_HTTP
;
478 $defaultProtoWithoutSlashes = substr( $defaultProto, 0, -2 );
480 if( substr( $url, 0, 2 ) == '//' ) {
481 return $defaultProtoWithoutSlashes . $url;
482 } elseif( substr( $url, 0, 1 ) == '/' ) {
483 // If $serverUrl is protocol-relative, prepend $defaultProtoWithoutSlashes, otherwise leave it alone
484 return ( $serverHasProto ?
'' : $defaultProtoWithoutSlashes ) . $serverUrl . $url;
491 * Returns a regular expression of url protocols
493 * @param $includeProtocolRelative bool If false, remove '//' from the returned protocol list.
494 * DO NOT USE this directy, use wfUrlProtocolsWithoutProtRel() instead
497 function wfUrlProtocols( $includeProtocolRelative = true ) {
498 global $wgUrlProtocols;
500 // Cache return values separately based on $includeProtocolRelative
501 static $withProtRel = null, $withoutProtRel = null;
502 $cachedValue = $includeProtocolRelative ?
$withProtRel : $withoutProtRel;
503 if ( !is_null( $cachedValue ) ) {
507 // Support old-style $wgUrlProtocols strings, for backwards compatibility
508 // with LocalSettings files from 1.5
509 if ( is_array( $wgUrlProtocols ) ) {
510 $protocols = array();
511 foreach ( $wgUrlProtocols as $protocol ) {
512 // Filter out '//' if !$includeProtocolRelative
513 if ( $includeProtocolRelative ||
$protocol !== '//' ) {
514 $protocols[] = preg_quote( $protocol, '/' );
518 $retval = implode( '|', $protocols );
520 // Ignore $includeProtocolRelative in this case
521 // This case exists for pre-1.6 compatibility, and we can safely assume
522 // that '//' won't appear in a pre-1.6 config because protocol-relative
523 // URLs weren't supported until 1.18
524 $retval = $wgUrlProtocols;
527 // Cache return value
528 if ( $includeProtocolRelative ) {
529 $withProtRel = $retval;
531 $withoutProtRel = $retval;
537 * Like wfUrlProtocols(), but excludes '//' from the protocol list. Use this if
538 * you need a regex that matches all URL protocols but does not match protocol-
541 function wfUrlProtocolsWithoutProtRel() {
542 return wfUrlProtocols( false );
546 * parse_url() work-alike, but non-broken. Differences:
548 * 1) Does not raise warnings on bad URLs (just returns false)
549 * 2) Handles protocols that don't use :// (e.g., mailto: and news: , as well as protocol-relative URLs) correctly
550 * 3) Adds a "delimiter" element to the array, either '://', ':' or '//' (see (2))
552 * @param $url String: a URL to parse
553 * @return Array: bits of the URL in an associative array, per PHP docs
555 function wfParseUrl( $url ) {
556 global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
558 // Protocol-relative URLs are handled really badly by parse_url(). It's so bad that the easiest
559 // way to handle them is to just prepend 'http:' and strip the protocol out later
560 $wasRelative = substr( $url, 0, 2 ) == '//';
561 if ( $wasRelative ) {
564 wfSuppressWarnings();
565 $bits = parse_url( $url );
567 // parse_url() returns an array without scheme for some invalid URLs, e.g.
568 // parse_url("%0Ahttp://example.com") == array( 'host' => '%0Ahttp', 'path' => 'example.com' )
569 if ( !$bits ||
!isset( $bits['scheme'] ) ) {
573 // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
574 if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
575 $bits['delimiter'] = '://';
576 } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
577 $bits['delimiter'] = ':';
578 // parse_url detects for news: and mailto: the host part of an url as path
579 // We have to correct this wrong detection
580 if ( isset( $bits['path'] ) ) {
581 $bits['host'] = $bits['path'];
588 /* Provide an empty host for eg. file:/// urls (see bug 28627) */
589 if ( !isset( $bits['host'] ) ) {
592 /* parse_url loses the third / for file:///c:/ urls (but not on variants) */
593 if ( substr( $bits['path'], 0, 1 ) !== '/' ) {
594 $bits['path'] = '/' . $bits['path'];
598 // If the URL was protocol-relative, fix scheme and delimiter
599 if ( $wasRelative ) {
600 $bits['scheme'] = '';
601 $bits['delimiter'] = '//';
607 * Make a URL index, appropriate for the el_index field of externallinks.
612 function wfMakeUrlIndex( $url ) {
613 $bits = wfParseUrl( $url );
615 // Reverse the labels in the hostname, convert to lower case
616 // For emails reverse domainpart only
617 if ( $bits['scheme'] == 'mailto' ) {
618 $mailparts = explode( '@', $bits['host'], 2 );
619 if ( count( $mailparts ) === 2 ) {
620 $domainpart = strtolower( implode( '.', array_reverse( explode( '.', $mailparts[1] ) ) ) );
622 // No domain specified, don't mangle it
625 $reversedHost = $domainpart . '@' . $mailparts[0];
627 $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) );
629 // Add an extra dot to the end
630 // Why? Is it in wrong place in mailto links?
631 if ( substr( $reversedHost, -1, 1 ) !== '.' ) {
632 $reversedHost .= '.';
634 // Reconstruct the pseudo-URL
635 $prot = $bits['scheme'];
636 $index = $prot . $bits['delimiter'] . $reversedHost;
637 // Leave out user and password. Add the port, path, query and fragment
638 if ( isset( $bits['port'] ) ) {
639 $index .= ':' . $bits['port'];
641 if ( isset( $bits['path'] ) ) {
642 $index .= $bits['path'];
646 if ( isset( $bits['query'] ) ) {
647 $index .= '?' . $bits['query'];
649 if ( isset( $bits['fragment'] ) ) {
650 $index .= '#' . $bits['fragment'];
656 * Check whether a given URL has a domain that occurs in a given set of domains
657 * @param $url string URL
658 * @param $domains array Array of domains (strings)
659 * @return bool True if the host part of $url ends in one of the strings in $domains
661 function wfMatchesDomainList( $url, $domains ) {
662 $bits = wfParseUrl( $url );
663 if ( is_array( $bits ) && isset( $bits['host'] ) ) {
664 foreach ( (array)$domains as $domain ) {
665 // FIXME: This gives false positives. http://nds-nl.wikipedia.org will match nl.wikipedia.org
666 // We should use something that interprets dots instead
667 if ( substr( $bits['host'], -strlen( $domain ) ) === $domain ) {
676 * Sends a line to the debug log if enabled or, optionally, to a comment in output.
677 * In normal operation this is a NOP.
679 * Controlling globals:
680 * $wgDebugLogFile - points to the log file
681 * $wgProfileOnly - if set, normal debug messages will not be recorded.
682 * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
683 * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
685 * @param $text String
686 * @param $logonly Bool: set true to avoid appearing in HTML when $wgDebugComments is set
688 function wfDebug( $text, $logonly = false ) {
689 global $wgOut, $wgDebugLogFile, $wgDebugComments, $wgProfileOnly, $wgDebugRawPage;
690 global $wgDebugLogPrefix, $wgShowDebug;
692 static $cache = array(); // Cache of unoutputted messages
693 $text = wfDebugTimer() . $text;
695 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
699 if ( ( $wgDebugComments ||
$wgShowDebug ) && !$logonly ) {
702 if ( isset( $wgOut ) && is_object( $wgOut ) ) {
703 // add the message and any cached messages to the output
704 array_map( array( $wgOut, 'debug' ), $cache );
708 if ( wfRunHooks( 'Debug', array( $text, null /* no log group */ ) ) ) {
709 if ( $wgDebugLogFile != '' && !$wgProfileOnly ) {
710 # Strip unprintables; they can switch terminal modes when binary data
711 # gets dumped, which is pretty annoying.
712 $text = preg_replace( '![\x00-\x08\x0b\x0c\x0e-\x1f]!', ' ', $text );
713 $text = $wgDebugLogPrefix . $text;
714 wfErrorLog( $text, $wgDebugLogFile );
720 * Returns true if debug logging should be suppressed if $wgDebugRawPage = false
722 function wfIsDebugRawPage() {
724 if ( $cache !== null ) {
727 # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
728 if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
730 isset( $_SERVER['SCRIPT_NAME'] )
731 && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
742 * Get microsecond timestamps for debug logs
746 function wfDebugTimer() {
747 global $wgDebugTimestamps;
748 if ( !$wgDebugTimestamps ) {
751 static $start = null;
753 if ( $start === null ) {
754 $start = microtime( true );
755 $prefix = "\n$start";
757 $prefix = sprintf( "%6.4f", microtime( true ) - $start );
760 return $prefix . ' ';
764 * Send a line giving PHP memory usage.
766 * @param $exact Bool: print exact values instead of kilobytes (default: false)
768 function wfDebugMem( $exact = false ) {
769 $mem = memory_get_usage();
771 $mem = floor( $mem / 1024 ) . ' kilobytes';
775 wfDebug( "Memory usage: $mem\n" );
779 * Send a line to a supplementary debug log file, if configured, or main debug log if not.
780 * $wgDebugLogGroups[$logGroup] should be set to a filename to send to a separate log.
782 * @param $logGroup String
783 * @param $text String
784 * @param $public Bool: whether to log the event in the public log if no private
785 * log file is specified, (default true)
787 function wfDebugLog( $logGroup, $text, $public = true ) {
788 global $wgDebugLogGroups, $wgShowHostnames;
789 $text = trim( $text ) . "\n";
790 if( isset( $wgDebugLogGroups[$logGroup] ) ) {
791 $time = wfTimestamp( TS_DB
);
793 if ( $wgShowHostnames ) {
794 $host = wfHostname();
798 if ( wfRunHooks( 'Debug', array( $text, $logGroup ) ) ) {
799 wfErrorLog( "$time $host $wiki: $text", $wgDebugLogGroups[$logGroup] );
801 } elseif ( $public === true ) {
802 wfDebug( $text, true );
807 * Log for database errors
809 * @param $text String: database error message.
811 function wfLogDBError( $text ) {
812 global $wgDBerrorLog, $wgDBname;
813 if ( $wgDBerrorLog ) {
814 $host = trim(`hostname`
);
815 $text = date( 'D M j G:i:s T Y' ) . "\t$host\t$wgDBname\t$text";
816 wfErrorLog( $text, $wgDBerrorLog );
821 * Log to a file without getting "file size exceeded" signals.
823 * Can also log to TCP or UDP with the syntax udp://host:port/prefix. This will
824 * send lines to the specified port, prefixed by the specified prefix and a space.
826 * @param $text String
827 * @param $file String filename
829 function wfErrorLog( $text, $file ) {
830 if ( substr( $file, 0, 4 ) == 'udp:' ) {
831 # Needs the sockets extension
832 if ( preg_match( '!^(tcp|udp):(?://)?\[([0-9a-fA-F:]+)\]:(\d+)(?:/(.*))?$!', $file, $m ) ) {
833 // IPv6 bracketed host
835 $port = intval( $m[3] );
836 $prefix = isset( $m[4] ) ?
$m[4] : false;
838 } elseif ( preg_match( '!^(tcp|udp):(?://)?([a-zA-Z0-9.-]+):(\d+)(?:/(.*))?$!', $file, $m ) ) {
840 if ( !IP
::isIPv4( $host ) ) {
841 $host = gethostbyname( $host );
843 $port = intval( $m[3] );
844 $prefix = isset( $m[4] ) ?
$m[4] : false;
847 throw new MWException( __METHOD__
. ': Invalid UDP specification' );
850 // Clean it up for the multiplexer
851 if ( strval( $prefix ) !== '' ) {
852 $text = preg_replace( '/^/m', $prefix . ' ', $text );
855 if ( strlen( $text ) > 65534 ) {
856 $text = substr( $text, 0, 65534 );
859 if ( substr( $text, -1 ) != "\n" ) {
862 } elseif ( strlen( $text ) > 65535 ) {
863 $text = substr( $text, 0, 65535 );
866 $sock = socket_create( $domain, SOCK_DGRAM
, SOL_UDP
);
871 $len = strlen( $text );
872 $maxLen = socket_get_option( $sock, SOL_UDP
, SO_SNDBUF
);
874 if ( $len > $maxLen ) {
877 socket_sendto( $sock, $text, $len, 0, $host, $port );
878 socket_close( $sock );
880 wfSuppressWarnings();
881 $exists = file_exists( $file );
882 $size = $exists ?
filesize( $file ) : false;
883 if ( !$exists ||
( $size !== false && $size +
strlen( $text ) < 0x7fffffff ) ) {
884 file_put_contents( $file, $text, FILE_APPEND
);
893 function wfLogProfilingData() {
894 global $wgRequestTime, $wgDebugLogFile, $wgDebugRawPage, $wgRequest;
895 global $wgProfileLimit, $wgUser;
897 $profiler = Profiler
::instance();
899 # Profiling must actually be enabled...
900 if ( $profiler->isStub() ) {
904 // Get total page request time and only show pages that longer than
905 // $wgProfileLimit time (default is 0)
907 $elapsed = $now - $wgRequestTime;
908 if ( $elapsed <= $wgProfileLimit ) {
912 $profiler->logData();
914 // Check whether this should be logged in the debug file.
915 if ( $wgDebugLogFile == '' ||
( !$wgDebugRawPage && wfIsDebugRawPage() ) ) {
920 if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
921 $forward = ' forwarded for ' . $_SERVER['HTTP_X_FORWARDED_FOR'];
923 if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
924 $forward .= ' client IP ' . $_SERVER['HTTP_CLIENT_IP'];
926 if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
927 $forward .= ' from ' . $_SERVER['HTTP_FROM'];
930 $forward = "\t(proxied via {$_SERVER['REMOTE_ADDR']}{$forward})";
932 // Don't load $wgUser at this late stage just for statistics purposes
933 // @todo FIXME: We can detect some anons even if it is not loaded. See User::getId()
934 if ( $wgUser->isItemLoaded( 'id' ) && $wgUser->isAnon() ) {
937 $log = sprintf( "%s\t%04.3f\t%s\n",
938 gmdate( 'YmdHis' ), $elapsed,
939 urldecode( $wgRequest->getRequestURL() . $forward ) );
941 wfErrorLog( $log . $profiler->getOutput(), $wgDebugLogFile );
945 * Check if the wiki read-only lock file is present. This can be used to lock
946 * off editing functions, but doesn't guarantee that the database will not be
951 function wfReadOnly() {
952 global $wgReadOnlyFile, $wgReadOnly;
954 if ( !is_null( $wgReadOnly ) ) {
955 return (bool)$wgReadOnly;
957 if ( $wgReadOnlyFile == '' ) {
960 // Set $wgReadOnly for faster access next time
961 if ( is_file( $wgReadOnlyFile ) ) {
962 $wgReadOnly = file_get_contents( $wgReadOnlyFile );
966 return (bool)$wgReadOnly;
969 function wfReadOnlyReason() {
976 * Return a Language object from $langcode
978 * @param $langcode Mixed: either:
979 * - a Language object
980 * - code of the language to get the message for, if it is
981 * a valid code create a language for that language, if
982 * it is a string but not a valid code then make a basic
984 * - a boolean: if it's false then use the current users
985 * language (as a fallback for the old parameter
986 * functionality), or if it is true then use the wikis
987 * @return Language object
989 function wfGetLangObj( $langcode = false ) {
990 # Identify which language to get or create a language object for.
991 # Using is_object here due to Stub objects.
992 if( is_object( $langcode ) ) {
993 # Great, we already have the object (hopefully)!
997 global $wgContLang, $wgLanguageCode;
998 if( $langcode === true ||
$langcode === $wgLanguageCode ) {
999 # $langcode is the language code of the wikis content language object.
1000 # or it is a boolean and value is true
1005 if( $langcode === false ||
$langcode === $wgLang->getCode() ) {
1006 # $langcode is the language code of user language object.
1007 # or it was a boolean and value is false
1011 $validCodes = array_keys( Language
::getLanguageNames() );
1012 if( in_array( $langcode, $validCodes ) ) {
1013 # $langcode corresponds to a valid language.
1014 return Language
::factory( $langcode );
1017 # $langcode is a string, but not a valid language code; use content language.
1018 wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1023 * Old function when $wgBetterDirectionality existed
1024 * Removed in core, kept in extensions for backwards compat.
1026 * @deprecated since 1.18
1029 function wfUILang() {
1035 * This is the new function for getting translated interface messages.
1036 * See the Message class for documentation how to use them.
1037 * The intention is that this function replaces all old wfMsg* functions.
1038 * @param $key \string Message key.
1039 * Varargs: normal message parameters.
1043 function wfMessage( $key /*...*/) {
1044 $params = func_get_args();
1045 array_shift( $params );
1046 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
1047 $params = $params[0];
1049 return new Message( $key, $params );
1053 * This function accepts multiple message keys and returns a message instance
1054 * for the first message which is non-empty. If all messages are empty then an
1055 * instance of the first message key is returned.
1056 * @param varargs: message keys
1060 function wfMessageFallback( /*...*/ ) {
1061 $args = func_get_args();
1062 return MWFunction
::callArray( 'Message::newFallbackSequence', $args );
1066 * Get a message from anywhere, for the current user language.
1068 * Use wfMsgForContent() instead if the message should NOT
1069 * change depending on the user preferences.
1071 * @param $key String: lookup key for the message, usually
1072 * defined in languages/Language.php
1074 * Parameters to the message, which can be used to insert variable text into
1075 * it, can be passed to this function in the following formats:
1076 * - One per argument, starting at the second parameter
1077 * - As an array in the second parameter
1078 * These are not shown in the function definition.
1082 function wfMsg( $key ) {
1083 $args = func_get_args();
1084 array_shift( $args );
1085 return wfMsgReal( $key, $args );
1089 * Same as above except doesn't transform the message
1091 * @param $key String
1094 function wfMsgNoTrans( $key ) {
1095 $args = func_get_args();
1096 array_shift( $args );
1097 return wfMsgReal( $key, $args, true, false, false );
1101 * Get a message from anywhere, for the current global language
1102 * set with $wgLanguageCode.
1104 * Use this if the message should NOT change dependent on the
1105 * language set in the user's preferences. This is the case for
1106 * most text written into logs, as well as link targets (such as
1107 * the name of the copyright policy page). Link titles, on the
1108 * other hand, should be shown in the UI language.
1110 * Note that MediaWiki allows users to change the user interface
1111 * language in their preferences, but a single installation
1112 * typically only contains content in one language.
1114 * Be wary of this distinction: If you use wfMsg() where you should
1115 * use wfMsgForContent(), a user of the software may have to
1116 * customize potentially hundreds of messages in
1117 * order to, e.g., fix a link in every possible language.
1119 * @param $key String: lookup key for the message, usually
1120 * defined in languages/Language.php
1123 function wfMsgForContent( $key ) {
1124 global $wgForceUIMsgAsContentMsg;
1125 $args = func_get_args();
1126 array_shift( $args );
1128 if( is_array( $wgForceUIMsgAsContentMsg ) &&
1129 in_array( $key, $wgForceUIMsgAsContentMsg ) )
1131 $forcontent = false;
1133 return wfMsgReal( $key, $args, true, $forcontent );
1137 * Same as above except doesn't transform the message
1139 * @param $key String
1142 function wfMsgForContentNoTrans( $key ) {
1143 global $wgForceUIMsgAsContentMsg;
1144 $args = func_get_args();
1145 array_shift( $args );
1147 if( is_array( $wgForceUIMsgAsContentMsg ) &&
1148 in_array( $key, $wgForceUIMsgAsContentMsg ) )
1150 $forcontent = false;
1152 return wfMsgReal( $key, $args, true, $forcontent, false );
1156 * Really get a message
1158 * @param $key String: key to get.
1160 * @param $useDB Boolean
1161 * @param $forContent Mixed: Language code, or false for user lang, true for content lang.
1162 * @param $transform Boolean: Whether or not to transform the message.
1163 * @return String: the requested message.
1165 function wfMsgReal( $key, $args, $useDB = true, $forContent = false, $transform = true ) {
1166 wfProfileIn( __METHOD__
);
1167 $message = wfMsgGetKey( $key, $useDB, $forContent, $transform );
1168 $message = wfMsgReplaceArgs( $message, $args );
1169 wfProfileOut( __METHOD__
);
1174 * Fetch a message string value, but don't replace any keys yet.
1176 * @param $key String
1177 * @param $useDB Bool
1178 * @param $langCode String: Code of the language to get the message for, or
1179 * behaves as a content language switch if it is a boolean.
1180 * @param $transform Boolean: whether to parse magic words, etc.
1183 function wfMsgGetKey( $key, $useDB = true, $langCode = false, $transform = true ) {
1184 wfRunHooks( 'NormalizeMessageKey', array( &$key, &$useDB, &$langCode, &$transform ) );
1186 $cache = MessageCache
::singleton();
1187 $message = $cache->get( $key, $useDB, $langCode );
1188 if( $message === false ) {
1189 $message = '<' . htmlspecialchars( $key ) . '>';
1190 } elseif ( $transform ) {
1191 $message = $cache->transform( $message );
1197 * Replace message parameter keys on the given formatted output.
1199 * @param $message String
1200 * @param $args Array
1204 function wfMsgReplaceArgs( $message, $args ) {
1205 # Fix windows line-endings
1206 # Some messages are split with explode("\n", $msg)
1207 $message = str_replace( "\r", '', $message );
1209 // Replace arguments
1210 if ( count( $args ) ) {
1211 if ( is_array( $args[0] ) ) {
1212 $args = array_values( $args[0] );
1214 $replacementKeys = array();
1215 foreach( $args as $n => $param ) {
1216 $replacementKeys['$' . ( $n +
1 )] = $param;
1218 $message = strtr( $message, $replacementKeys );
1225 * Return an HTML-escaped version of a message.
1226 * Parameter replacements, if any, are done *after* the HTML-escaping,
1227 * so parameters may contain HTML (eg links or form controls). Be sure
1228 * to pre-escape them if you really do want plaintext, or just wrap
1229 * the whole thing in htmlspecialchars().
1231 * @param $key String
1232 * @param string ... parameters
1235 function wfMsgHtml( $key ) {
1236 $args = func_get_args();
1237 array_shift( $args );
1238 return wfMsgReplaceArgs( htmlspecialchars( wfMsgGetKey( $key ) ), $args );
1242 * Return an HTML version of message
1243 * Parameter replacements, if any, are done *after* parsing the wiki-text message,
1244 * so parameters may contain HTML (eg links or form controls). Be sure
1245 * to pre-escape them if you really do want plaintext, or just wrap
1246 * the whole thing in htmlspecialchars().
1248 * @param $key String
1249 * @param string ... parameters
1252 function wfMsgWikiHtml( $key ) {
1253 $args = func_get_args();
1254 array_shift( $args );
1255 return wfMsgReplaceArgs(
1256 MessageCache
::singleton()->parse( wfMsgGetKey( $key ), null,
1257 /* can't be set to false */ true, /* interface */ true )->getText(),
1262 * Returns message in the requested format
1263 * @param $key String: key of the message
1264 * @param $options Array: processing rules. Can take the following options:
1265 * <i>parse</i>: parses wikitext to HTML
1266 * <i>parseinline</i>: parses wikitext to HTML and removes the surrounding
1267 * p's added by parser or tidy
1268 * <i>escape</i>: filters message through htmlspecialchars
1269 * <i>escapenoentities</i>: same, but allows entity references like   through
1270 * <i>replaceafter</i>: parameters are substituted after parsing or escaping
1271 * <i>parsemag</i>: transform the message using magic phrases
1272 * <i>content</i>: fetch message for content language instead of interface
1273 * Also can accept a single associative argument, of the form 'language' => 'xx':
1274 * <i>language</i>: Language object or language code to fetch message for
1275 * (overriden by <i>content</i>).
1276 * Behavior for conflicting options (e.g., parse+parseinline) is undefined.
1280 function wfMsgExt( $key, $options ) {
1281 $args = func_get_args();
1282 array_shift( $args );
1283 array_shift( $args );
1284 $options = (array)$options;
1286 foreach( $options as $arrayKey => $option ) {
1287 if( !preg_match( '/^[0-9]+|language$/', $arrayKey ) ) {
1288 # An unknown index, neither numeric nor "language"
1289 wfWarn( "wfMsgExt called with incorrect parameter key $arrayKey", 1, E_USER_WARNING
);
1290 } elseif( preg_match( '/^[0-9]+$/', $arrayKey ) && !in_array( $option,
1291 array( 'parse', 'parseinline', 'escape', 'escapenoentities',
1292 'replaceafter', 'parsemag', 'content' ) ) ) {
1293 # A numeric index with unknown value
1294 wfWarn( "wfMsgExt called with incorrect parameter $option", 1, E_USER_WARNING
);
1298 if( in_array( 'content', $options, true ) ) {
1301 $langCodeObj = null;
1302 } elseif( array_key_exists( 'language', $options ) ) {
1303 $forContent = false;
1304 $langCode = wfGetLangObj( $options['language'] );
1305 $langCodeObj = $langCode;
1307 $forContent = false;
1309 $langCodeObj = null;
1312 $string = wfMsgGetKey( $key, /*DB*/true, $langCode, /*Transform*/false );
1314 if( !in_array( 'replaceafter', $options, true ) ) {
1315 $string = wfMsgReplaceArgs( $string, $args );
1318 $messageCache = MessageCache
::singleton();
1319 if( in_array( 'parse', $options, true ) ) {
1320 $string = $messageCache->parse( $string, null, true, !$forContent, $langCodeObj )->getText();
1321 } elseif ( in_array( 'parseinline', $options, true ) ) {
1322 $string = $messageCache->parse( $string, null, true, !$forContent, $langCodeObj )->getText();
1324 if( preg_match( '/^<p>(.*)\n?<\/p>\n?$/sU', $string, $m ) ) {
1327 } elseif ( in_array( 'parsemag', $options, true ) ) {
1328 $string = $messageCache->transform( $string,
1329 !$forContent, $langCodeObj );
1332 if ( in_array( 'escape', $options, true ) ) {
1333 $string = htmlspecialchars ( $string );
1334 } elseif ( in_array( 'escapenoentities', $options, true ) ) {
1335 $string = Sanitizer
::escapeHtmlAllowEntities( $string );
1338 if( in_array( 'replaceafter', $options, true ) ) {
1339 $string = wfMsgReplaceArgs( $string, $args );
1346 * Since wfMsg() and co suck, they don't return false if the message key they
1347 * looked up didn't exist but a XHTML string, this function checks for the
1348 * nonexistance of messages by checking the MessageCache::get() result directly.
1350 * @param $key String: the message key looked up
1351 * @return Boolean True if the message *doesn't* exist.
1353 function wfEmptyMsg( $key ) {
1354 return MessageCache
::singleton()->get( $key, /*useDB*/true, /*content*/false ) === false;
1358 * Throw a debugging exception. This function previously once exited the process,
1359 * but now throws an exception instead, with similar results.
1361 * @param $msg String: message shown when dieing.
1363 function wfDebugDieBacktrace( $msg = '' ) {
1364 throw new MWException( $msg );
1368 * Fetch server name for use in error reporting etc.
1369 * Use real server name if available, so we know which machine
1370 * in a server farm generated the current page.
1374 function wfHostname() {
1376 if ( is_null( $host ) ) {
1377 if ( function_exists( 'posix_uname' ) ) {
1378 // This function not present on Windows
1379 $uname = posix_uname();
1383 if( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1384 $host = $uname['nodename'];
1385 } elseif ( getenv( 'COMPUTERNAME' ) ) {
1386 # Windows computer name
1387 $host = getenv( 'COMPUTERNAME' );
1389 # This may be a virtual server.
1390 $host = $_SERVER['SERVER_NAME'];
1397 * Returns a HTML comment with the elapsed time since request.
1398 * This method has no side effects.
1402 function wfReportTime() {
1403 global $wgRequestTime, $wgShowHostnames;
1406 $elapsed = $now - $wgRequestTime;
1408 return $wgShowHostnames
1409 ?
sprintf( '<!-- Served by %s in %01.3f secs. -->', wfHostname(), $elapsed )
1410 : sprintf( '<!-- Served in %01.3f secs. -->', $elapsed );
1414 * Safety wrapper for debug_backtrace().
1416 * With Zend Optimizer 3.2.0 loaded, this causes segfaults under somewhat
1417 * murky circumstances, which may be triggered in part by stub objects
1418 * or other fancy talkin'.
1420 * Will return an empty array if Zend Optimizer is detected or if
1421 * debug_backtrace is disabled, otherwise the output from
1422 * debug_backtrace() (trimmed).
1424 * @param $limit int This parameter can be used to limit the number of stack frames returned
1426 * @return array of backtrace information
1428 function wfDebugBacktrace( $limit = 0 ) {
1429 static $disabled = null;
1431 if( extension_loaded( 'Zend Optimizer' ) ) {
1432 wfDebug( "Zend Optimizer detected; skipping debug_backtrace for safety.\n" );
1436 if ( is_null( $disabled ) ) {
1438 $functions = explode( ',', ini_get( 'disable_functions' ) );
1439 $functions = array_map( 'trim', $functions );
1440 $functions = array_map( 'strtolower', $functions );
1441 if ( in_array( 'debug_backtrace', $functions ) ) {
1442 wfDebug( "debug_backtrace is in disabled_functions\n" );
1450 if ( $limit && version_compare( PHP_VERSION
, '5.4.0', '>=' ) ) {
1451 return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT
, $limit ), 1 );
1453 return array_slice( debug_backtrace(), 1 );
1458 * Get a debug backtrace as a string
1462 function wfBacktrace() {
1463 global $wgCommandLineMode;
1465 if ( $wgCommandLineMode ) {
1470 $backtrace = wfDebugBacktrace();
1471 foreach( $backtrace as $call ) {
1472 if( isset( $call['file'] ) ) {
1473 $f = explode( DIRECTORY_SEPARATOR
, $call['file'] );
1474 $file = $f[count( $f ) - 1];
1478 if( isset( $call['line'] ) ) {
1479 $line = $call['line'];
1483 if ( $wgCommandLineMode ) {
1484 $msg .= "$file line $line calls ";
1486 $msg .= '<li>' . $file . ' line ' . $line . ' calls ';
1488 if( !empty( $call['class'] ) ) {
1489 $msg .= $call['class'] . $call['type'];
1491 $msg .= $call['function'] . '()';
1493 if ( $wgCommandLineMode ) {
1499 if ( $wgCommandLineMode ) {
1509 * Get the name of the function which called this function
1512 * @return Bool|string
1514 function wfGetCaller( $level = 2 ) {
1515 $backtrace = wfDebugBacktrace( $level );
1516 if ( isset( $backtrace[$level] ) ) {
1517 return wfFormatStackFrame( $backtrace[$level] );
1519 $caller = 'unknown';
1525 * Return a string consisting of callers in the stack. Useful sometimes
1526 * for profiling specific points.
1528 * @param $limit The maximum depth of the stack frame to return, or false for
1532 function wfGetAllCallers( $limit = 3 ) {
1533 $trace = array_reverse( wfDebugBacktrace() );
1534 if ( !$limit ||
$limit > count( $trace ) - 1 ) {
1535 $limit = count( $trace ) - 1;
1537 $trace = array_slice( $trace, -$limit - 1, $limit );
1538 return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1542 * Return a string representation of frame
1544 * @param $frame Array
1547 function wfFormatStackFrame( $frame ) {
1548 return isset( $frame['class'] ) ?
1549 $frame['class'] . '::' . $frame['function'] :
1554 /* Some generic result counters, pulled out of SearchEngine */
1560 * @param $offset Int
1564 function wfShowingResults( $offset, $limit ) {
1568 array( 'parseinline' ),
1569 $wgLang->formatNum( $limit ),
1570 $wgLang->formatNum( $offset +
1 )
1575 * Generate (prev x| next x) (20|50|100...) type links for paging
1577 * @param $offset String
1578 * @param $limit Integer
1579 * @param $link String
1580 * @param $query String: optional URL query parameter string
1581 * @param $atend Bool: optional param for specified if this is the last page
1584 function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) {
1586 $fmtLimit = $wgLang->formatNum( $limit );
1587 // @todo FIXME: Why on earth this needs one message for the text and another one for tooltip?
1588 # Get prev/next link display text
1589 $prev = wfMsgExt( 'prevn', array( 'parsemag', 'escape' ), $fmtLimit );
1590 $next = wfMsgExt( 'nextn', array( 'parsemag', 'escape' ), $fmtLimit );
1591 # Get prev/next link title text
1592 $pTitle = wfMsgExt( 'prevn-title', array( 'parsemag', 'escape' ), $fmtLimit );
1593 $nTitle = wfMsgExt( 'nextn-title', array( 'parsemag', 'escape' ), $fmtLimit );
1594 # Fetch the title object
1595 if( is_object( $link ) ) {
1598 $title = Title
::newFromText( $link );
1599 if( is_null( $title ) ) {
1603 # Make 'previous' link
1604 if( 0 != $offset ) {
1605 $po = $offset - $limit;
1606 $po = max( $po, 0 );
1607 $q = "limit={$limit}&offset={$po}";
1608 if( $query != '' ) {
1611 $plink = '<a href="' . $title->escapeLocalURL( $q ) . "\" title=\"{$pTitle}\" class=\"mw-prevlink\">{$prev}</a>";
1616 $no = $offset +
$limit;
1617 $q = "limit={$limit}&offset={$no}";
1618 if( $query != '' ) {
1624 $nlink = '<a href="' . $title->escapeLocalURL( $q ) . "\" title=\"{$nTitle}\" class=\"mw-nextlink\">{$next}</a>";
1626 # Make links to set number of items per page
1627 $nums = $wgLang->pipeList( array(
1628 wfNumLink( $offset, 20, $title, $query ),
1629 wfNumLink( $offset, 50, $title, $query ),
1630 wfNumLink( $offset, 100, $title, $query ),
1631 wfNumLink( $offset, 250, $title, $query ),
1632 wfNumLink( $offset, 500, $title, $query )
1634 return wfMsgHtml( 'viewprevnext', $plink, $nlink, $nums );
1638 * Generate links for (20|50|100...) items-per-page links
1640 * @param $offset String
1641 * @param $limit Integer
1642 * @param $title Title
1643 * @param $query String: optional URL query parameter string
1645 function wfNumLink( $offset, $limit, $title, $query = '' ) {
1647 if( $query == '' ) {
1652 $q .= "limit={$limit}&offset={$offset}";
1653 $fmtLimit = $wgLang->formatNum( $limit );
1654 $lTitle = wfMsgExt( 'shown-title', array( 'parsemag', 'escape' ), $limit );
1655 $s = '<a href="' . $title->escapeLocalURL( $q ) . "\" title=\"{$lTitle}\" class=\"mw-numlink\">{$fmtLimit}</a>";
1661 * @todo FIXME: We may want to blacklist some broken browsers
1663 * @param $force Bool
1664 * @return bool Whereas client accept gzip compression
1666 function wfClientAcceptsGzip( $force = false ) {
1667 static $result = null;
1668 if ( $result === null ||
$force ) {
1670 if( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
1671 # @todo FIXME: We may want to blacklist some broken browsers
1674 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
1675 $_SERVER['HTTP_ACCEPT_ENCODING'],
1679 if( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
1683 wfDebug( " accepts gzip\n" );
1692 * Obtain the offset and limit values from the request string;
1693 * used in special pages
1695 * @param $deflimit Int default limit if none supplied
1696 * @param $optionname String Name of a user preference to check against
1700 function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
1702 return $wgRequest->getLimitOffset( $deflimit, $optionname );
1706 * Escapes the given text so that it may be output using addWikiText()
1707 * without any linking, formatting, etc. making its way through. This
1708 * is achieved by substituting certain characters with HTML entities.
1709 * As required by the callers, <nowiki> is not used.
1711 * @param $text String: text to be escaped
1714 function wfEscapeWikiText( $text ) {
1715 $text = strtr( "\n$text", array(
1716 '"' => '"', '&' => '&', "'" => ''', '<' => '<',
1717 '=' => '=', '>' => '>', '[' => '[', ']' => ']',
1718 '{' => '{', '|' => '|', '}' => '}',
1719 "\n#" => "\n#", "\n*" => "\n*",
1720 "\n:" => "\n:", "\n;" => "\n;",
1721 '://' => '://', 'ISBN ' => 'ISBN ', 'RFC ' => 'RFC ',
1723 return substr( $text, 1 );
1727 * Get the current unix timetstamp with microseconds. Useful for profiling
1731 return microtime( true );
1735 * Sets dest to source and returns the original value of dest
1736 * If source is NULL, it just returns the value, it doesn't set the variable
1737 * If force is true, it will set the value even if source is NULL
1739 * @param $dest Mixed
1740 * @param $source Mixed
1741 * @param $force Bool
1744 function wfSetVar( &$dest, $source, $force = false ) {
1746 if ( !is_null( $source ) ||
$force ) {
1753 * As for wfSetVar except setting a bit
1757 * @param $state Bool
1759 function wfSetBit( &$dest, $bit, $state = true ) {
1760 $temp = (bool)( $dest & $bit );
1761 if ( !is_null( $state ) ) {
1772 * Windows-compatible version of escapeshellarg()
1773 * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
1774 * function puts single quotes in regardless of OS.
1776 * Also fixes the locale problems on Linux in PHP 5.2.6+ (bug backported to
1777 * earlier distro releases of PHP)
1782 function wfEscapeShellArg( ) {
1783 wfInitShellLocale();
1785 $args = func_get_args();
1788 foreach ( $args as $arg ) {
1795 if ( wfIsWindows() ) {
1796 // Escaping for an MSVC-style command line parser and CMD.EXE
1798 // * http://web.archive.org/web/20020708081031/http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
1799 // * http://technet.microsoft.com/en-us/library/cc723564.aspx
1802 // Double the backslashes before any double quotes. Escape the double quotes.
1803 $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE
);
1806 foreach ( $tokens as $token ) {
1807 if ( $iteration %
2 == 1 ) {
1808 // Delimiter, a double quote preceded by zero or more slashes
1809 $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
1810 } elseif ( $iteration %
4 == 2 ) {
1811 // ^ in $token will be outside quotes, need to be escaped
1812 $arg .= str_replace( '^', '^^', $token );
1813 } else { // $iteration % 4 == 0
1814 // ^ in $token will appear inside double quotes, so leave as is
1819 // Double the backslashes before the end of the string, because
1820 // we will soon add a quote
1822 if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
1823 $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
1826 // Add surrounding quotes
1827 $retVal .= '"' . $arg . '"';
1829 $retVal .= escapeshellarg( $arg );
1836 * wfMerge attempts to merge differences between three texts.
1837 * Returns true for a clean merge and false for failure or a conflict.
1839 * @param $old String
1840 * @param $mine String
1841 * @param $yours String
1842 * @param $result String
1845 function wfMerge( $old, $mine, $yours, &$result ) {
1848 # This check may also protect against code injection in
1849 # case of broken installations.
1850 wfSuppressWarnings();
1851 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
1852 wfRestoreWarnings();
1855 wfDebug( "diff3 not found\n" );
1859 # Make temporary files
1861 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
1862 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
1863 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
1865 fwrite( $oldtextFile, $old );
1866 fclose( $oldtextFile );
1867 fwrite( $mytextFile, $mine );
1868 fclose( $mytextFile );
1869 fwrite( $yourtextFile, $yours );
1870 fclose( $yourtextFile );
1872 # Check for a conflict
1873 $cmd = $wgDiff3 . ' -a --overlap-only ' .
1874 wfEscapeShellArg( $mytextName ) . ' ' .
1875 wfEscapeShellArg( $oldtextName ) . ' ' .
1876 wfEscapeShellArg( $yourtextName );
1877 $handle = popen( $cmd, 'r' );
1879 if( fgets( $handle, 1024 ) ) {
1887 $cmd = $wgDiff3 . ' -a -e --merge ' .
1888 wfEscapeShellArg( $mytextName, $oldtextName, $yourtextName );
1889 $handle = popen( $cmd, 'r' );
1892 $data = fread( $handle, 8192 );
1893 if ( strlen( $data ) == 0 ) {
1899 unlink( $mytextName );
1900 unlink( $oldtextName );
1901 unlink( $yourtextName );
1903 if ( $result === '' && $old !== '' && !$conflict ) {
1904 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
1911 * Returns unified plain-text diff of two texts.
1912 * Useful for machine processing of diffs.
1914 * @param $before String: the text before the changes.
1915 * @param $after String: the text after the changes.
1916 * @param $params String: command-line options for the diff command.
1917 * @return String: unified diff of $before and $after
1919 function wfDiff( $before, $after, $params = '-u' ) {
1920 if ( $before == $after ) {
1925 wfSuppressWarnings();
1926 $haveDiff = $wgDiff && file_exists( $wgDiff );
1927 wfRestoreWarnings();
1929 # This check may also protect against code injection in
1930 # case of broken installations.
1932 wfDebug( "diff executable not found\n" );
1933 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
1934 $format = new UnifiedDiffFormatter();
1935 return $format->format( $diffs );
1938 # Make temporary files
1940 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
1941 $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
1943 fwrite( $oldtextFile, $before );
1944 fclose( $oldtextFile );
1945 fwrite( $newtextFile, $after );
1946 fclose( $newtextFile );
1948 // Get the diff of the two files
1949 $cmd = "$wgDiff " . $params . ' ' . wfEscapeShellArg( $oldtextName, $newtextName );
1951 $h = popen( $cmd, 'r' );
1956 $data = fread( $h, 8192 );
1957 if ( strlen( $data ) == 0 ) {
1965 unlink( $oldtextName );
1966 unlink( $newtextName );
1968 // Kill the --- and +++ lines. They're not useful.
1969 $diff_lines = explode( "\n", $diff );
1970 if ( strpos( $diff_lines[0], '---' ) === 0 ) {
1971 unset( $diff_lines[0] );
1973 if ( strpos( $diff_lines[1], '+++' ) === 0 ) {
1974 unset( $diff_lines[1] );
1977 $diff = implode( "\n", $diff_lines );
1983 * A wrapper around the PHP function var_export().
1984 * Either print it or add it to the regular output ($wgOut).
1986 * @param $var A PHP variable to dump.
1988 function wfVarDump( $var ) {
1990 $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
1991 if ( headers_sent() ||
!isset( $wgOut ) ||
!is_object( $wgOut ) ) {
1994 $wgOut->addHTML( $s );
1999 * Provide a simple HTTP error.
2001 * @param $code Int|String
2002 * @param $label String
2003 * @param $desc String
2005 function wfHttpError( $code, $label, $desc ) {
2008 header( "HTTP/1.0 $code $label" );
2009 header( "Status: $code $label" );
2010 $wgOut->sendCacheControl();
2012 header( 'Content-type: text/html; charset=utf-8' );
2013 print "<!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML 2.0//EN\">".
2014 '<html><head><title>' .
2015 htmlspecialchars( $label ) .
2016 '</title></head><body><h1>' .
2017 htmlspecialchars( $label ) .
2019 nl2br( htmlspecialchars( $desc ) ) .
2020 "</p></body></html>\n";
2024 * Clear away any user-level output buffers, discarding contents.
2026 * Suitable for 'starting afresh', for instance when streaming
2027 * relatively large amounts of data without buffering, or wanting to
2028 * output image files without ob_gzhandler's compression.
2030 * The optional $resetGzipEncoding parameter controls suppression of
2031 * the Content-Encoding header sent by ob_gzhandler; by default it
2032 * is left. See comments for wfClearOutputBuffers() for why it would
2035 * Note that some PHP configuration options may add output buffer
2036 * layers which cannot be removed; these are left in place.
2038 * @param $resetGzipEncoding Bool
2040 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
2041 if( $resetGzipEncoding ) {
2042 // Suppress Content-Encoding and Content-Length
2043 // headers from 1.10+s wfOutputHandler
2044 global $wgDisableOutputCompression;
2045 $wgDisableOutputCompression = true;
2047 while( $status = ob_get_status() ) {
2048 if( $status['type'] == 0 /* PHP_OUTPUT_HANDLER_INTERNAL */ ) {
2049 // Probably from zlib.output_compression or other
2050 // PHP-internal setting which can't be removed.
2052 // Give up, and hope the result doesn't break
2056 if( !ob_end_clean() ) {
2057 // Could not remove output buffer handler; abort now
2058 // to avoid getting in some kind of infinite loop.
2061 if( $resetGzipEncoding ) {
2062 if( $status['name'] == 'ob_gzhandler' ) {
2063 // Reset the 'Content-Encoding' field set by this handler
2064 // so we can start fresh.
2065 if ( function_exists( 'header_remove' ) ) {
2066 // Available since PHP 5.3.0
2067 header_remove( 'Content-Encoding' );
2069 // We need to provide a valid content-coding. See bug 28069
2070 header( 'Content-Encoding: identity' );
2079 * More legible than passing a 'false' parameter to wfResetOutputBuffers():
2081 * Clear away output buffers, but keep the Content-Encoding header
2082 * produced by ob_gzhandler, if any.
2084 * This should be used for HTTP 304 responses, where you need to
2085 * preserve the Content-Encoding header of the real result, but
2086 * also need to suppress the output of ob_gzhandler to keep to spec
2087 * and avoid breaking Firefox in rare cases where the headers and
2088 * body are broken over two packets.
2090 function wfClearOutputBuffers() {
2091 wfResetOutputBuffers( false );
2095 * Converts an Accept-* header into an array mapping string values to quality
2098 * @param $accept String
2099 * @param $def String default
2102 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
2103 # No arg means accept anything (per HTTP spec)
2105 return array( $def => 1.0 );
2110 $parts = explode( ',', $accept );
2112 foreach( $parts as $part ) {
2113 # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
2114 $values = explode( ';', trim( $part ) );
2116 if ( count( $values ) == 1 ) {
2117 $prefs[$values[0]] = 1.0;
2118 } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
2119 $prefs[$values[0]] = floatval( $match[1] );
2127 * Checks if a given MIME type matches any of the keys in the given
2128 * array. Basic wildcards are accepted in the array keys.
2130 * Returns the matching MIME type (or wildcard) if a match, otherwise
2133 * @param $type String
2134 * @param $avail Array
2138 function mimeTypeMatch( $type, $avail ) {
2139 if( array_key_exists( $type, $avail ) ) {
2142 $parts = explode( '/', $type );
2143 if( array_key_exists( $parts[0] . '/*', $avail ) ) {
2144 return $parts[0] . '/*';
2145 } elseif( array_key_exists( '*/*', $avail ) ) {
2154 * Returns the 'best' match between a client's requested internet media types
2155 * and the server's list of available types. Each list should be an associative
2156 * array of type to preference (preference is a float between 0.0 and 1.0).
2157 * Wildcards in the types are acceptable.
2159 * @param $cprefs Array: client's acceptable type list
2160 * @param $sprefs Array: server's offered types
2163 * @todo FIXME: Doesn't handle params like 'text/plain; charset=UTF-8'
2164 * XXX: generalize to negotiate other stuff
2166 function wfNegotiateType( $cprefs, $sprefs ) {
2169 foreach( array_keys($sprefs) as $type ) {
2170 $parts = explode( '/', $type );
2171 if( $parts[1] != '*' ) {
2172 $ckey = mimeTypeMatch( $type, $cprefs );
2174 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
2179 foreach( array_keys( $cprefs ) as $type ) {
2180 $parts = explode( '/', $type );
2181 if( $parts[1] != '*' && !array_key_exists( $type, $sprefs ) ) {
2182 $skey = mimeTypeMatch( $type, $sprefs );
2184 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
2192 foreach( array_keys( $combine ) as $type ) {
2193 if( $combine[$type] > $bestq ) {
2195 $bestq = $combine[$type];
2203 * Reference-counted warning suppression
2207 function wfSuppressWarnings( $end = false ) {
2208 static $suppressCount = 0;
2209 static $originalLevel = false;
2212 if ( $suppressCount ) {
2214 if ( !$suppressCount ) {
2215 error_reporting( $originalLevel );
2219 if ( !$suppressCount ) {
2220 // E_DEPRECATED is undefined in PHP 5.2
2221 if( !defined( 'E_DEPRECATED' ) ){
2222 define( 'E_DEPRECATED', 8192 );
2224 $originalLevel = error_reporting( E_ALL
& ~
( E_WARNING | E_NOTICE | E_USER_WARNING | E_USER_NOTICE | E_DEPRECATED
) );
2231 * Restore error level to previous value
2233 function wfRestoreWarnings() {
2234 wfSuppressWarnings( true );
2237 # Autodetect, convert and provide timestamps of various types
2240 * Unix time - the number of seconds since 1970-01-01 00:00:00 UTC
2242 define( 'TS_UNIX', 0 );
2245 * MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
2247 define( 'TS_MW', 1 );
2250 * MySQL DATETIME (YYYY-MM-DD HH:MM:SS)
2252 define( 'TS_DB', 2 );
2255 * RFC 2822 format, for E-mail and HTTP headers
2257 define( 'TS_RFC2822', 3 );
2260 * ISO 8601 format with no timezone: 1986-02-09T20:00:00Z
2262 * This is used by Special:Export
2264 define( 'TS_ISO_8601', 4 );
2267 * An Exif timestamp (YYYY:MM:DD HH:MM:SS)
2269 * @see http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the
2270 * DateTime tag and page 36 for the DateTimeOriginal and
2271 * DateTimeDigitized tags.
2273 define( 'TS_EXIF', 5 );
2276 * Oracle format time.
2278 define( 'TS_ORACLE', 6 );
2281 * Postgres format time.
2283 define( 'TS_POSTGRES', 7 );
2288 define( 'TS_DB2', 8 );
2291 * ISO 8601 basic format with no timezone: 19860209T200000Z. This is used by ResourceLoader
2293 define( 'TS_ISO_8601_BASIC', 9 );
2296 * Get a timestamp string in one of various formats
2298 * @param $outputtype Mixed: A timestamp in one of the supported formats, the
2299 * function will autodetect which format is supplied and act
2301 * @param $ts Mixed: the timestamp to convert or 0 for the current timestamp
2302 * @return Mixed: String / false The same date in the format specified in $outputtype or false
2304 function wfTimestamp( $outputtype = TS_UNIX
, $ts = 0 ) {
2309 if ( !$ts ) { // We want to catch 0, '', null... but not date strings starting with a letter.
2312 } elseif ( preg_match( '/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)$/D', $ts, $da ) ) {
2314 } elseif ( preg_match( '/^(\d{4}):(\d\d):(\d\d) (\d\d):(\d\d):(\d\d)$/D', $ts, $da ) ) {
2316 } elseif ( preg_match( '/^(\d{4})(\d\d)(\d\d)(\d\d)(\d\d)(\d\d)$/D', $ts, $da ) ) {
2318 } elseif ( preg_match( '/^-?\d{1,13}$/D', $ts ) ) {
2321 $strtime = "@$ts"; // Undocumented?
2322 } elseif ( preg_match( '/^\d{2}-\d{2}-\d{4} \d{2}:\d{2}:\d{2}.\d{6}$/', $ts ) ) {
2323 # TS_ORACLE // session altered to DD-MM-YYYY HH24:MI:SS.FF6
2324 $strtime = preg_replace( '/(\d\d)\.(\d\d)\.(\d\d)(\.(\d+))?/', "$1:$2:$3",
2325 str_replace( '+00:00', 'UTC', $ts ) );
2326 } elseif ( preg_match( '/^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})(?:\.*\d*)?Z$/', $ts, $da ) ) {
2328 } elseif ( preg_match( '/^(\d{4})(\d{2})(\d{2})T(\d{2})(\d{2})(\d{2})(?:\.*\d*)?Z$/', $ts, $da ) ) {
2330 } elseif ( preg_match( '/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)\.*\d*[\+\- ](\d\d)$/', $ts, $da ) ) {
2332 } elseif ( preg_match( '/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)\.*\d* GMT$/', $ts, $da ) ) {
2334 } elseif (preg_match('/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)\.\d\d\d$/',$ts,$da)) {
2336 } elseif ( preg_match( '/^[ \t\r\n]*([A-Z][a-z]{2},[ \t\r\n]*)?' . # Day of week
2337 '\d\d?[ \t\r\n]*[A-Z][a-z]{2}[ \t\r\n]*\d{2}(?:\d{2})?' . # dd Mon yyyy
2338 '[ \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
2339 # TS_RFC2822, accepting a trailing comment. See http://www.squid-cache.org/mail-archive/squid-users/200307/0122.html / r77171
2340 # The regex is a superset of rfc2822 for readability
2341 $strtime = strtok( $ts, ';' );
2342 } 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 ) ) {
2345 } 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 ) ) {
2350 wfDebug("wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n");
2355 static $formats = array(
2358 TS_DB
=> 'Y-m-d H:i:s',
2359 TS_ISO_8601
=> 'Y-m-d\TH:i:s\Z',
2360 TS_ISO_8601_BASIC
=> 'Ymd\THis\Z',
2361 TS_EXIF
=> 'Y:m:d H:i:s', // This shouldn't ever be used, but is included for completeness
2362 TS_RFC2822
=> 'D, d M Y H:i:s',
2363 TS_ORACLE
=> 'd-m-Y H:i:s.000000', // Was 'd-M-y h.i.s A' . ' +00:00' before r51500
2364 TS_POSTGRES
=> 'Y-m-d H:i:s',
2365 TS_DB2
=> 'Y-m-d H:i:s',
2368 if ( !isset( $formats[$outputtype] ) ) {
2369 throw new MWException( 'wfTimestamp() called with illegal output type.' );
2372 if ( function_exists( "date_create" ) ) {
2373 if ( count( $da ) ) {
2374 $ds = sprintf("%04d-%02d-%02dT%02d:%02d:%02d.00+00:00",
2375 (int)$da[1], (int)$da[2], (int)$da[3],
2376 (int)$da[4], (int)$da[5], (int)$da[6]);
2378 $d = date_create( $ds, new DateTimeZone( 'GMT' ) );
2379 } elseif ( $strtime ) {
2380 $d = date_create( $strtime, new DateTimeZone( 'GMT' ) );
2386 wfDebug("wfTimestamp() fed bogus time value: $outputtype; $ts\n");
2390 $output = $d->format( $formats[$outputtype] );
2392 if ( count( $da ) ) {
2393 // Warning! gmmktime() acts oddly if the month or day is set to 0
2394 // We may want to handle that explicitly at some point
2395 $uts = gmmktime( (int)$da[4], (int)$da[5], (int)$da[6],
2396 (int)$da[2], (int)$da[3], (int)$da[1] );
2397 } elseif ( $strtime ) {
2398 $uts = strtotime( $strtime );
2401 if ( $uts === false ) {
2402 wfDebug("wfTimestamp() can't parse the timestamp (non 32-bit time? Update php): $outputtype; $ts\n");
2406 if ( TS_UNIX
== $outputtype ) {
2409 $output = gmdate( $formats[$outputtype], $uts );
2412 if ( ( $outputtype == TS_RFC2822
) ||
( $outputtype == TS_POSTGRES
) ) {
2420 * Return a formatted timestamp, or null if input is null.
2421 * For dealing with nullable timestamp columns in the database.
2423 * @param $outputtype Integer
2427 function wfTimestampOrNull( $outputtype = TS_UNIX
, $ts = null ) {
2428 if( is_null( $ts ) ) {
2431 return wfTimestamp( $outputtype, $ts );
2436 * Convenience function; returns MediaWiki timestamp for the present time.
2440 function wfTimestampNow() {
2442 return wfTimestamp( TS_MW
, time() );
2446 * Check if the operating system is Windows
2448 * @return Bool: true if it's Windows, False otherwise.
2450 function wfIsWindows() {
2451 static $isWindows = null;
2452 if ( $isWindows === null ) {
2453 $isWindows = substr( php_uname(), 0, 7 ) == 'Windows';
2459 * Check if we are running under HipHop
2463 function wfIsHipHop() {
2464 return function_exists( 'hphp_thread_set_warmup_enabled' );
2468 * Swap two variables
2473 function swap( &$x, &$y ) {
2480 * Tries to get the system directory for temporary files. The TMPDIR, TMP, and
2481 * TEMP environment variables are then checked in sequence, and if none are set
2482 * try sys_get_temp_dir() for PHP >= 5.2.1. All else fails, return /tmp for Unix
2483 * or C:\Windows\Temp for Windows and hope for the best.
2484 * It is common to call it with tempnam().
2486 * NOTE: When possible, use instead the tmpfile() function to create
2487 * temporary files to avoid race conditions on file creation, etc.
2491 function wfTempDir() {
2492 foreach( array( 'TMPDIR', 'TMP', 'TEMP' ) as $var ) {
2493 $tmp = getenv( $var );
2494 if( $tmp && file_exists( $tmp ) && is_dir( $tmp ) && is_writable( $tmp ) ) {
2498 if( function_exists( 'sys_get_temp_dir' ) ) {
2499 return sys_get_temp_dir();
2502 return wfIsWindows() ?
'C:\Windows\Temp' : '/tmp';
2506 * Make directory, and make all parent directories if they don't exist
2508 * @param $dir String: full path to directory to create
2509 * @param $mode Integer: chmod value to use, default is $wgDirectoryMode
2510 * @param $caller String: optional caller param for debugging.
2513 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2514 global $wgDirectoryMode;
2516 if ( !is_null( $caller ) ) {
2517 wfDebug( "$caller: called wfMkdirParents($dir)" );
2520 if( strval( $dir ) === '' ||
file_exists( $dir ) ) {
2524 $dir = str_replace( array( '\\', '/' ), DIRECTORY_SEPARATOR
, $dir );
2526 if ( is_null( $mode ) ) {
2527 $mode = $wgDirectoryMode;
2530 // Turn off the normal warning, we're doing our own below
2531 wfSuppressWarnings();
2532 $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2533 wfRestoreWarnings();
2536 // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2537 trigger_error( __FUNCTION__
. ": failed to mkdir \"$dir\" mode $mode", E_USER_WARNING
);
2543 * Increment a statistics counter
2545 * @param $key String
2548 function wfIncrStats( $key, $count = 1 ) {
2549 global $wgStatsMethod;
2551 $count = intval( $count );
2553 if( $wgStatsMethod == 'udp' ) {
2554 global $wgUDPProfilerHost, $wgUDPProfilerPort, $wgDBname, $wgAggregateStatsID;
2557 $id = $wgAggregateStatsID !== false ?
$wgAggregateStatsID : $wgDBname;
2560 $socket = socket_create( AF_INET
, SOCK_DGRAM
, SOL_UDP
);
2561 $statline = "stats/{$id} - {$count} 1 1 1 1 -total\n";
2565 strlen( $statline ),
2571 $statline = "stats/{$id} - {$count} 1 1 1 1 {$key}\n";
2572 wfSuppressWarnings();
2576 strlen( $statline ),
2581 wfRestoreWarnings();
2582 } elseif( $wgStatsMethod == 'cache' ) {
2584 $key = wfMemcKey( 'stats', $key );
2585 if ( is_null( $wgMemc->incr( $key, $count ) ) ) {
2586 $wgMemc->add( $key, $count );
2594 * @param $nr Mixed: the number to format
2595 * @param $acc Integer: the number of digits after the decimal point, default 2
2596 * @param $round Boolean: whether or not to round the value, default true
2599 function wfPercent( $nr, $acc = 2, $round = true ) {
2600 $ret = sprintf( "%.${acc}f", $nr );
2601 return $round ?
round( $ret, $acc ) . '%' : "$ret%";
2605 * Find out whether or not a mixed variable exists in a string
2607 * @param $needle String
2608 * @param $str String
2609 * @param $insensitive Boolean
2612 function in_string( $needle, $str, $insensitive = false ) {
2614 if( $insensitive ) $func = 'stripos';
2616 return $func( $str, $needle ) !== false;
2620 * Make a list item, used by various special pages
2622 * @param $page String Page link
2623 * @param $details String Text between brackets
2624 * @param $oppositedm Boolean Add the direction mark opposite to your
2625 * language, to display text properly
2628 function wfSpecialList( $page, $details, $oppositedm = true ) {
2630 $dirmark = ( $oppositedm ?
$wgLang->getDirMark( true ) : '' ) .
2631 $wgLang->getDirMark();
2632 $details = $details ?
$dirmark . " ($details)" : '';
2633 return $page . $details;
2637 * Safety wrapper around ini_get() for boolean settings.
2638 * The values returned from ini_get() are pre-normalized for settings
2639 * set via php.ini or php_flag/php_admin_flag... but *not*
2640 * for those set via php_value/php_admin_value.
2642 * It's fairly common for people to use php_value instead of php_flag,
2643 * which can leave you with an 'off' setting giving a false positive
2644 * for code that just takes the ini_get() return value as a boolean.
2646 * To make things extra interesting, setting via php_value accepts
2647 * "true" and "yes" as true, but php.ini and php_flag consider them false. :)
2648 * Unrecognized values go false... again opposite PHP's own coercion
2649 * from string to bool.
2651 * Luckily, 'properly' set settings will always come back as '0' or '1',
2652 * so we only have to worry about them and the 'improper' settings.
2654 * I frickin' hate PHP... :P
2656 * @param $setting String
2659 function wfIniGetBool( $setting ) {
2660 $val = ini_get( $setting );
2661 // 'on' and 'true' can't have whitespace around them, but '1' can.
2662 return strtolower( $val ) == 'on'
2663 ||
strtolower( $val ) == 'true'
2664 ||
strtolower( $val ) == 'yes'
2665 ||
preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2669 * Wrapper function for PHP's dl(). This doesn't work in most situations from
2670 * PHP 5.3 onward, and is usually disabled in shared environments anyway.
2672 * @param $extension String A PHP extension. The file suffix (.so or .dll)
2674 * @param $fileName String Name of the library, if not $extension.suffix
2675 * @return Bool - Whether or not the extension is loaded
2677 function wfDl( $extension, $fileName = null ) {
2678 if( extension_loaded( $extension ) ) {
2683 $sapi = php_sapi_name();
2684 if( version_compare( PHP_VERSION
, '5.3.0', '<' ) ||
2685 $sapi == 'cli' ||
$sapi == 'cgi' ||
$sapi == 'embed' )
2687 $canDl = ( function_exists( 'dl' ) && is_callable( 'dl' )
2688 && wfIniGetBool( 'enable_dl' ) && !wfIniGetBool( 'safe_mode' ) );
2692 $fileName = $fileName ?
$fileName : $extension;
2693 if( wfIsWindows() ) {
2694 $fileName = 'php_' . $fileName;
2696 wfSuppressWarnings();
2697 dl( $fileName . '.' . PHP_SHLIB_SUFFIX
);
2698 wfRestoreWarnings();
2700 return extension_loaded( $extension );
2704 * Execute a shell command, with time and memory limits mirrored from the PHP
2705 * configuration if supported.
2706 * @param $cmd String Command line, properly escaped for shell.
2707 * @param &$retval optional, will receive the program's exit code.
2708 * (non-zero is usually failure)
2709 * @param $environ Array optional environment variables which should be
2710 * added to the executed command environment.
2711 * @return collected stdout as a string (trailing newlines stripped)
2713 function wfShellExec( $cmd, &$retval = null, $environ = array() ) {
2714 global $IP, $wgMaxShellMemory, $wgMaxShellFileSize, $wgMaxShellTime;
2717 if ( is_null( $disabled ) ) {
2719 if( wfIniGetBool( 'safe_mode' ) ) {
2720 wfDebug( "wfShellExec can't run in safe_mode, PHP's exec functions are too broken.\n" );
2721 $disabled = 'safemode';
2723 $functions = explode( ',', ini_get( 'disable_functions' ) );
2724 $functions = array_map( 'trim', $functions );
2725 $functions = array_map( 'strtolower', $functions );
2726 if ( in_array( 'passthru', $functions ) ) {
2727 wfDebug( "passthru is in disabled_functions\n" );
2728 $disabled = 'passthru';
2734 return $disabled == 'safemode' ?
2735 'Unable to run external programs in safe mode.' :
2736 'Unable to run external programs, passthru() is disabled.';
2739 wfInitShellLocale();
2742 foreach( $environ as $k => $v ) {
2743 if ( wfIsWindows() ) {
2744 /* Surrounding a set in quotes (method used by wfEscapeShellArg) makes the quotes themselves
2745 * appear in the environment variable, so we must use carat escaping as documented in
2746 * http://technet.microsoft.com/en-us/library/cc723564.aspx
2747 * Note however that the quote isn't listed there, but is needed, and the parentheses
2748 * are listed there but doesn't appear to need it.
2750 $envcmd .= "set $k=" . preg_replace( '/([&|()<>^"])/', '^\\1', $v ) . '&& ';
2752 /* Assume this is a POSIX shell, thus required to accept variable assignments before the command
2753 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_09_01
2755 $envcmd .= "$k=" . escapeshellarg( $v ) . ' ';
2758 $cmd = $envcmd . $cmd;
2760 if ( wfIsWindows() ) {
2761 if ( version_compare( PHP_VERSION
, '5.3.0', '<' ) && /* Fixed in 5.3.0 :) */
2762 ( version_compare( PHP_VERSION
, '5.2.1', '>=' ) ||
php_uname( 's' ) == 'Windows NT' ) )
2764 # Hack to work around PHP's flawed invocation of cmd.exe
2765 # http://news.php.net/php.internals/21796
2766 # Windows 9x doesn't accept any kind of quotes
2767 $cmd = '"' . $cmd . '"';
2769 } elseif ( php_uname( 's' ) == 'Linux' ) {
2770 $time = intval( $wgMaxShellTime );
2771 $mem = intval( $wgMaxShellMemory );
2772 $filesize = intval( $wgMaxShellFileSize );
2774 if ( $time > 0 && $mem > 0 ) {
2775 $script = "$IP/bin/ulimit4.sh";
2776 if ( is_executable( $script ) ) {
2777 $cmd = '/bin/bash ' . escapeshellarg( $script ) . " $time $mem $filesize " . escapeshellarg( $cmd );
2781 wfDebug( "wfShellExec: $cmd\n" );
2783 $retval = 1; // error by default?
2785 passthru( $cmd, $retval );
2786 $output = ob_get_contents();
2789 if ( $retval == 127 ) {
2790 wfDebugLog( 'exec', "Possibly missing executable file: $cmd\n" );
2796 * Workaround for http://bugs.php.net/bug.php?id=45132
2797 * escapeshellarg() destroys non-ASCII characters if LANG is not a UTF-8 locale
2799 function wfInitShellLocale() {
2800 static $done = false;
2805 global $wgShellLocale;
2806 if ( !wfIniGetBool( 'safe_mode' ) ) {
2807 putenv( "LC_CTYPE=$wgShellLocale" );
2808 setlocale( LC_CTYPE
, $wgShellLocale );
2813 * This function works like "use VERSION" in Perl, the program will die with a
2814 * backtrace if the current version of PHP is less than the version provided
2816 * This is useful for extensions which due to their nature are not kept in sync
2817 * with releases, and might depend on other versions of PHP than the main code
2819 * Note: PHP might die due to parsing errors in some cases before it ever
2820 * manages to call this function, such is life
2822 * @see perldoc -f use
2824 * @param $req_ver Mixed: the version to check, can be a string, an integer, or
2827 function wfUsePHP( $req_ver ) {
2828 $php_ver = PHP_VERSION
;
2830 if ( version_compare( $php_ver, (string)$req_ver, '<' ) ) {
2831 throw new MWException( "PHP $req_ver required--this is only $php_ver" );
2836 * This function works like "use VERSION" in Perl except it checks the version
2837 * of MediaWiki, the program will die with a backtrace if the current version
2838 * of MediaWiki is less than the version provided.
2840 * This is useful for extensions which due to their nature are not kept in sync
2843 * @see perldoc -f use
2845 * @param $req_ver Mixed: the version to check, can be a string, an integer, or
2848 function wfUseMW( $req_ver ) {
2851 if ( version_compare( $wgVersion, (string)$req_ver, '<' ) ) {
2852 throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
2857 * Return the final portion of a pathname.
2858 * Reimplemented because PHP5's basename() is buggy with multibyte text.
2859 * http://bugs.php.net/bug.php?id=33898
2861 * PHP's basename() only considers '\' a pathchar on Windows and Netware.
2862 * We'll consider it so always, as we don't want \s in our Unix paths either.
2864 * @param $path String
2865 * @param $suffix String: to remove if present
2868 function wfBaseName( $path, $suffix = '' ) {
2869 $encSuffix = ( $suffix == '' )
2871 : ( '(?:' . preg_quote( $suffix, '#' ) . ')?' );
2873 if( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
2881 * Generate a relative path name to the given file.
2882 * May explode on non-matching case-insensitive paths,
2883 * funky symlinks, etc.
2885 * @param $path String: absolute destination path including target filename
2886 * @param $from String: Absolute source path, directory only
2889 function wfRelativePath( $path, $from ) {
2890 // Normalize mixed input on Windows...
2891 $path = str_replace( '/', DIRECTORY_SEPARATOR
, $path );
2892 $from = str_replace( '/', DIRECTORY_SEPARATOR
, $from );
2894 // Trim trailing slashes -- fix for drive root
2895 $path = rtrim( $path, DIRECTORY_SEPARATOR
);
2896 $from = rtrim( $from, DIRECTORY_SEPARATOR
);
2898 $pieces = explode( DIRECTORY_SEPARATOR
, dirname( $path ) );
2899 $against = explode( DIRECTORY_SEPARATOR
, $from );
2901 if( $pieces[0] !== $against[0] ) {
2902 // Non-matching Windows drive letters?
2903 // Return a full path.
2907 // Trim off common prefix
2908 while( count( $pieces ) && count( $against )
2909 && $pieces[0] == $against[0] ) {
2910 array_shift( $pieces );
2911 array_shift( $against );
2914 // relative dots to bump us to the parent
2915 while( count( $against ) ) {
2916 array_unshift( $pieces, '..' );
2917 array_shift( $against );
2920 array_push( $pieces, wfBaseName( $path ) );
2922 return implode( DIRECTORY_SEPARATOR
, $pieces );
2926 * Do any deferred updates and clear the list
2928 * @deprecated since 1.19
2929 * @see DeferredUpdates::doUpdate()
2931 function wfDoUpdates( $commit = '' ) {
2932 DeferredUpdates
::doUpdates( $commit );
2936 * Convert an arbitrarily-long digit string from one numeric base
2937 * to another, optionally zero-padding to a minimum column width.
2939 * Supports base 2 through 36; digit values 10-36 are represented
2940 * as lowercase letters a-z. Input is case-insensitive.
2942 * @param $input String: of digits
2943 * @param $sourceBase Integer: 2-36
2944 * @param $destBase Integer: 2-36
2945 * @param $pad Integer: 1 or greater
2946 * @param $lowercase Boolean
2947 * @return String or false on invalid input
2949 function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1, $lowercase = true ) {
2950 $input = strval( $input );
2951 if( $sourceBase < 2 ||
2956 $sourceBase != intval( $sourceBase ) ||
2957 $destBase != intval( $destBase ) ||
2958 $pad != intval( $pad ) ||
2959 !is_string( $input ) ||
2963 $digitChars = ( $lowercase ) ?
'0123456789abcdefghijklmnopqrstuvwxyz' : '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ';
2964 $inDigits = array();
2967 // Decode and validate input string
2968 $input = strtolower( $input );
2969 for( $i = 0; $i < strlen( $input ); $i++
) {
2970 $n = strpos( $digitChars, $input[$i] );
2971 if( $n === false ||
$n > $sourceBase ) {
2977 // Iterate over the input, modulo-ing out an output digit
2978 // at a time until input is gone.
2979 while( count( $inDigits ) ) {
2981 $workDigits = array();
2984 foreach( $inDigits as $digit ) {
2985 $work *= $sourceBase;
2988 if( $work < $destBase ) {
2989 // Gonna need to pull another digit.
2990 if( count( $workDigits ) ) {
2991 // Avoid zero-padding; this lets us find
2992 // the end of the input very easily when
2993 // length drops to zero.
2997 // Finally! Actual division!
2998 $workDigits[] = intval( $work / $destBase );
3000 // Isn't it annoying that most programming languages
3001 // don't have a single divide-and-remainder operator,
3002 // even though the CPU implements it that way?
3003 $work = $work %
$destBase;
3007 // All that division leaves us with a remainder,
3008 // which is conveniently our next output digit.
3009 $outChars .= $digitChars[$work];
3012 $inDigits = $workDigits;
3015 while( strlen( $outChars ) < $pad ) {
3019 return strrev( $outChars );
3023 * Create an object with a given name and an array of construct parameters
3025 * @param $name String
3026 * @param $p Array: parameters
3027 * @deprecated since 1.18, warnings in 1.18, removal in 1.20
3029 function wfCreateObject( $name, $p ) {
3030 wfDeprecated( __FUNCTION__
);
3031 return MWFunction
::newObj( $name, $p );
3034 function wfHttpOnlySafe() {
3035 global $wgHttpOnlyBlacklist;
3037 if( isset( $_SERVER['HTTP_USER_AGENT'] ) ) {
3038 foreach( $wgHttpOnlyBlacklist as $regex ) {
3039 if( preg_match( $regex, $_SERVER['HTTP_USER_AGENT'] ) ) {
3049 * Initialise php session
3051 * @param $sessionId Bool
3053 function wfSetupSession( $sessionId = false ) {
3054 global $wgSessionsInMemcached, $wgCookiePath, $wgCookieDomain,
3055 $wgCookieSecure, $wgCookieHttpOnly, $wgSessionHandler;
3056 if( $wgSessionsInMemcached ) {
3057 if ( !defined( 'MW_COMPILED' ) ) {
3059 require_once( "$IP/includes/cache/MemcachedSessions.php" );
3061 session_set_save_handler( 'memsess_open', 'memsess_close', 'memsess_read',
3062 'memsess_write', 'memsess_destroy', 'memsess_gc' );
3064 // It's necessary to register a shutdown function to call session_write_close(),
3065 // because by the time the request shutdown function for the session module is
3066 // called, $wgMemc has already been destroyed. Shutdown functions registered
3067 // this way are called before object destruction.
3068 register_shutdown_function( 'memsess_write_close' );
3069 } elseif( $wgSessionHandler && $wgSessionHandler != ini_get( 'session.save_handler' ) ) {
3070 # Only set this if $wgSessionHandler isn't null and session.save_handler
3071 # hasn't already been set to the desired value (that causes errors)
3072 ini_set( 'session.save_handler', $wgSessionHandler );
3074 $httpOnlySafe = wfHttpOnlySafe() && $wgCookieHttpOnly;
3075 wfDebugLog( 'cookie',
3076 'session_set_cookie_params: "' . implode( '", "',
3082 $httpOnlySafe ) ) . '"' );
3083 session_set_cookie_params( 0, $wgCookiePath, $wgCookieDomain, $wgCookieSecure, $httpOnlySafe );
3084 session_cache_limiter( 'private, must-revalidate' );
3086 session_id( $sessionId );
3088 wfSuppressWarnings();
3090 wfRestoreWarnings();
3094 * Get an object from the precompiled serialized directory
3096 * @param $name String
3097 * @return Mixed: the variable on success, false on failure
3099 function wfGetPrecompiledData( $name ) {
3102 $file = "$IP/serialized/$name";
3103 if ( file_exists( $file ) ) {
3104 $blob = file_get_contents( $file );
3106 return unserialize( $blob );
3118 function wfMemcKey( /*... */ ) {
3119 $args = func_get_args();
3120 $key = wfWikiID() . ':' . implode( ':', $args );
3121 $key = str_replace( ' ', '_', $key );
3126 * Get a cache key for a foreign DB
3129 * @param $prefix String
3130 * @param varargs String
3133 function wfForeignMemcKey( $db, $prefix /*, ... */ ) {
3134 $args = array_slice( func_get_args(), 2 );
3136 $key = "$db-$prefix:" . implode( ':', $args );
3138 $key = $db . ':' . implode( ':', $args );
3144 * Get an ASCII string identifying this wiki
3145 * This is used as a prefix in memcached keys
3149 function wfWikiID() {
3150 global $wgDBprefix, $wgDBname;
3151 if ( $wgDBprefix ) {
3152 return "$wgDBname-$wgDBprefix";
3159 * Split a wiki ID into DB name and table prefix
3161 * @param $wiki String
3162 * @param $bits String
3166 function wfSplitWikiID( $wiki ) {
3167 $bits = explode( '-', $wiki, 2 );
3168 if ( count( $bits ) < 2 ) {
3175 * Get a Database object.
3177 * @param $db Integer: index of the connection to get. May be DB_MASTER for the
3178 * master (for write queries), DB_SLAVE for potentially lagged read
3179 * queries, or an integer >= 0 for a particular server.
3181 * @param $groups Mixed: query groups. An array of group names that this query
3182 * belongs to. May contain a single string if the query is only
3185 * @param $wiki String: the wiki ID, or false for the current wiki
3187 * Note: multiple calls to wfGetDB(DB_SLAVE) during the course of one request
3188 * will always return the same object, unless the underlying connection or load
3189 * balancer is manually destroyed.
3191 * Note 2: use $this->getDB() in maintenance scripts that may be invoked by
3192 * updater to ensure that a proper database is being updated.
3194 * @return DatabaseBase
3196 function &wfGetDB( $db, $groups = array(), $wiki = false ) {
3197 return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
3201 * Get a load balancer object.
3203 * @param $wiki String: wiki ID, or false for the current wiki
3204 * @return LoadBalancer
3206 function wfGetLB( $wiki = false ) {
3207 return wfGetLBFactory()->getMainLB( $wiki );
3211 * Get the load balancer factory object
3215 function &wfGetLBFactory() {
3216 return LBFactory
::singleton();
3221 * Shortcut for RepoGroup::singleton()->findFile()
3223 * @param $title String or Title object
3224 * @param $options Associative array of options:
3225 * time: requested time for an archived image, or false for the
3226 * current version. An image object will be returned which was
3227 * created at the specified time.
3229 * ignoreRedirect: If true, do not follow file redirects
3231 * private: If true, return restricted (deleted) files if the current
3232 * user is allowed to view them. Otherwise, such files will not
3235 * bypassCache: If true, do not use the process-local cache of File objects
3237 * @return File, or false if the file does not exist
3239 function wfFindFile( $title, $options = array() ) {
3240 return RepoGroup
::singleton()->findFile( $title, $options );
3244 * Get an object referring to a locally registered file.
3245 * Returns a valid placeholder object if the file does not exist.
3247 * @param $title Title or String
3248 * @return File, or null if passed an invalid Title
3250 function wfLocalFile( $title ) {
3251 return RepoGroup
::singleton()->getLocalRepo()->newFile( $title );
3255 * Stream a file to the browser. Back-compat alias for StreamFile::stream()
3256 * @deprecated since 1.19
3258 function wfStreamFile( $fname, $headers = array() ) {
3259 StreamFile
::stream( $fname, $headers );
3263 * Should low-performance queries be disabled?
3266 * @codeCoverageIgnore
3268 function wfQueriesMustScale() {
3269 global $wgMiserMode;
3271 ||
( SiteStats
::pages() > 100000
3272 && SiteStats
::edits() > 1000000
3273 && SiteStats
::users() > 10000 );
3277 * Get the path to a specified script file, respecting file
3278 * extensions; this is a wrapper around $wgScriptExtension etc.
3280 * @param $script String: script filename, sans extension
3283 function wfScript( $script = 'index' ) {
3284 global $wgScriptPath, $wgScriptExtension;
3285 return "{$wgScriptPath}/{$script}{$wgScriptExtension}";
3289 * Get the script URL.
3291 * @return script URL
3293 function wfGetScriptUrl() {
3294 if( isset( $_SERVER['SCRIPT_NAME'] ) ) {
3296 # as it was called, minus the query string.
3298 # Some sites use Apache rewrite rules to handle subdomains,
3299 # and have PHP set up in a weird way that causes PHP_SELF
3300 # to contain the rewritten URL instead of the one that the
3301 # outside world sees.
3303 # If in this mode, use SCRIPT_URL instead, which mod_rewrite
3304 # provides containing the "before" URL.
3305 return $_SERVER['SCRIPT_NAME'];
3307 return $_SERVER['URL'];
3312 * Convenience function converts boolean values into "true"
3313 * or "false" (string) values
3315 * @param $value Boolean
3318 function wfBoolToStr( $value ) {
3319 return $value ?
'true' : 'false';
3323 * Load an extension messages file
3325 * @deprecated since 1.16, warnings in 1.18, remove in 1.20
3326 * @codeCoverageIgnore
3328 function wfLoadExtensionMessages() {
3329 wfDeprecated( __FUNCTION__
);
3333 * Get a platform-independent path to the null file, e.g. /dev/null
3337 function wfGetNull() {
3338 return wfIsWindows()
3344 * Throws a warning that $function is deprecated
3346 * @param $function String
3347 * @param $version String
3350 function wfDeprecated( $function, $version=false ) {
3351 static $functionsWarned = array();
3352 if ( !isset( $functionsWarned[$function] ) ) {
3353 $functionsWarned[$function] = true;
3355 global $wgDeprecationReleaseLimit;
3356 if ( $wgDeprecationReleaseLimit ) {
3357 # Strip -* off the end of $version so that branches can use the
3358 # format #.##-branchname to avoid issues if the branch is merged into
3359 # a version of MediaWiki later than what it was branched from
3360 $comparableVersion = preg_replace( '/-.*$/', '', $version );
3361 # If the comparableVersion is larger than our release limit then
3362 # skip the warning message for the deprecation
3363 if ( version_compare( $wgDeprecationReleaseLimit, $comparableVersion, '<' ) ) {
3367 wfWarn( "Use of $function was deprecated in $version.", 2 );
3369 wfWarn( "Use of $function is deprecated.", 2 );
3375 * Send a warning either to the debug log or in a PHP error depending on
3376 * $wgDevelopmentWarnings
3378 * @param $msg String: message to send
3379 * @param $callerOffset Integer: number of items to go back in the backtrace to
3380 * find the correct caller (1 = function calling wfWarn, ...)
3381 * @param $level Integer: PHP error level; only used when $wgDevelopmentWarnings
3384 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE
) {
3385 global $wgDevelopmentWarnings;
3387 $callers = wfDebugBacktrace();
3388 if ( isset( $callers[$callerOffset +
1] ) ) {
3389 $callerfunc = $callers[$callerOffset +
1];
3390 $callerfile = $callers[$callerOffset];
3391 if ( isset( $callerfile['file'] ) && isset( $callerfile['line'] ) ) {
3392 $file = $callerfile['file'] . ' at line ' . $callerfile['line'];
3394 $file = '(internal function)';
3397 if ( isset( $callerfunc['class'] ) ) {
3398 $func .= $callerfunc['class'] . '::';
3400 if ( isset( $callerfunc['function'] ) ) {
3401 $func .= $callerfunc['function'];
3403 $msg .= " [Called from $func in $file]";
3406 if ( $wgDevelopmentWarnings ) {
3407 trigger_error( $msg, $level );
3409 wfDebug( "$msg\n" );
3414 * Modern version of wfWaitForSlaves(). Instead of looking at replication lag
3415 * and waiting for it to go down, this waits for the slaves to catch up to the
3416 * master position. Use this when updating very large numbers of rows, as
3417 * in maintenance scripts, to avoid causing too much lag. Of course, this is
3418 * a no-op if there are no slaves.
3420 * @param $maxLag Integer (deprecated)
3421 * @param $wiki mixed Wiki identifier accepted by wfGetLB
3424 function wfWaitForSlaves( $maxLag = false, $wiki = false ) {
3425 $lb = wfGetLB( $wiki );
3426 // bug 27975 - Don't try to wait for slaves if there are none
3427 // Prevents permission error when getting master position
3428 if ( $lb->getServerCount() > 1 ) {
3429 $dbw = $lb->getConnection( DB_MASTER
);
3430 $pos = $dbw->getMasterPos();
3431 $lb->waitForAll( $pos );
3436 * Used to be used for outputting text in the installer/updater
3437 * @deprecated since 1.18, warnings in 1.18, remove in 1.20
3439 function wfOut( $s ) {
3440 wfDeprecated( __METHOD__
);
3441 global $wgCommandLineMode;
3442 if ( $wgCommandLineMode ) {
3445 echo htmlspecialchars( $s );
3451 * Count down from $n to zero on the terminal, with a one-second pause
3452 * between showing each number. For use in command-line scripts.
3453 * @codeCoverageIgnore
3455 function wfCountDown( $n ) {
3456 for ( $i = $n; $i >= 0; $i-- ) {
3458 echo str_repeat( "\x08", strlen( $i +
1 ) );
3470 * Generate a random 32-character hexadecimal token.
3471 * @param $salt Mixed: some sort of salt, if necessary, to add to random
3472 * characters before hashing.
3474 * @codeCoverageIgnore
3476 function wfGenerateToken( $salt = '' ) {
3477 $salt = serialize( $salt );
3478 return md5( mt_rand( 0, 0x7fffffff ) . $salt );
3482 * Replace all invalid characters with -
3484 * @param $name Mixed: filename to process
3487 function wfStripIllegalFilenameChars( $name ) {
3488 global $wgIllegalFileChars;
3489 $name = wfBaseName( $name );
3490 $name = preg_replace(
3491 "/[^" . Title
::legalChars() . "]" .
3492 ( $wgIllegalFileChars ?
"|[" . $wgIllegalFileChars . "]" : '' ) .
3501 * Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit;
3503 * @return Integer value memory was set to.
3505 function wfMemoryLimit() {
3506 global $wgMemoryLimit;
3507 $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
3508 if( $memlimit != -1 ) {
3509 $conflimit = wfShorthandToInteger( $wgMemoryLimit );
3510 if( $conflimit == -1 ) {
3511 wfDebug( "Removing PHP's memory limit\n" );
3512 wfSuppressWarnings();
3513 ini_set( 'memory_limit', $conflimit );
3514 wfRestoreWarnings();
3516 } elseif ( $conflimit > $memlimit ) {
3517 wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
3518 wfSuppressWarnings();
3519 ini_set( 'memory_limit', $conflimit );
3520 wfRestoreWarnings();
3528 * Converts shorthand byte notation to integer form
3530 * @param $string String
3533 function wfShorthandToInteger( $string = '' ) {
3534 $string = trim( $string );
3535 if( $string === '' ) {
3538 $last = $string[strlen( $string ) - 1];
3539 $val = intval( $string );
3544 // break intentionally missing
3548 // break intentionally missing
3558 * Get the normalised IETF language tag
3559 * See unit test for examples.
3561 * @param $code String: The language code.
3562 * @return $langCode String: The language code which complying with BCP 47 standards.
3564 function wfBCP47( $code ) {
3565 $codeSegment = explode( '-', $code );
3567 foreach ( $codeSegment as $segNo => $seg ) {
3568 if ( count( $codeSegment ) > 0 ) {
3569 // when previous segment is x, it is a private segment and should be lc
3570 if( $segNo > 0 && strtolower( $codeSegment[($segNo - 1)] ) == 'x') {
3571 $codeBCP[$segNo] = strtolower( $seg );
3572 // ISO 3166 country code
3573 } elseif ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) {
3574 $codeBCP[$segNo] = strtoupper( $seg );
3575 // ISO 15924 script code
3576 } elseif ( ( strlen( $seg ) == 4 ) && ( $segNo > 0 ) ) {
3577 $codeBCP[$segNo] = ucfirst( strtolower( $seg ) );
3578 // Use lowercase for other cases
3580 $codeBCP[$segNo] = strtolower( $seg );
3583 // Use lowercase for single segment
3584 $codeBCP[$segNo] = strtolower( $seg );
3587 $langCode = implode( '-', $codeBCP );
3592 * Get a cache object.
3594 * @param $inputType integer Cache type, one the the CACHE_* constants.
3597 function wfGetCache( $inputType ) {
3598 return ObjectCache
::getInstance( $inputType );
3602 * Get the main cache object
3606 function wfGetMainCache() {
3607 global $wgMainCacheType;
3608 return ObjectCache
::getInstance( $wgMainCacheType );
3612 * Get the cache object used by the message cache
3616 function wfGetMessageCacheStorage() {
3617 global $wgMessageCacheType;
3618 return ObjectCache
::getInstance( $wgMessageCacheType );
3622 * Get the cache object used by the parser cache
3626 function wfGetParserCacheStorage() {
3627 global $wgParserCacheType;
3628 return ObjectCache
::getInstance( $wgParserCacheType );
3632 * Call hook functions defined in $wgHooks
3634 * @param $event String: event name
3635 * @param $args Array: parameters passed to hook functions
3638 function wfRunHooks( $event, $args = array() ) {
3639 return Hooks
::run( $event, $args );