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( $needle ) ) {
298 $needle = array( '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F' );
299 if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) ||
( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false ) ) {
304 $s = urlencode( $s );
307 array( ';', '@', '$', '!', '*', '(', ')', ',', '/', ':' ),
315 * This function takes two arrays as input, and returns a CGI-style string, e.g.
316 * "days=7&limit=100". Options in the first array override options in the second.
317 * Options set to "" will not be output.
319 * @param $array1 Array( String|Array )
320 * @param $array2 Array( String|Array )
323 function wfArrayToCGI( $array1, $array2 = null ) {
324 if ( !is_null( $array2 ) ) {
325 $array1 = $array1 +
$array2;
329 foreach ( $array1 as $key => $value ) {
330 if ( $value !== '' ) {
334 if ( is_array( $value ) ) {
336 foreach ( $value as $v ) {
337 $cgi .= ( $firstTime ?
'' : '&') .
338 urlencode( $key . '[]' ) . '=' .
343 if ( is_object( $value ) ) {
344 $value = $value->__toString();
346 $cgi .= urlencode( $key ) . '=' .
355 * This is the logical opposite of wfArrayToCGI(): it accepts a query string as
356 * its argument and returns the same string in array form. This allows compa-
357 * tibility with legacy functions that accept raw query strings instead of nice
358 * arrays. Of course, keys and values are urldecode()d. Don't try passing in-
359 * valid query strings, or it will explode.
361 * @param $query String: query string
362 * @return array Array version of input
364 function wfCgiToArray( $query ) {
365 if( isset( $query[0] ) && $query[0] == '?' ) {
366 $query = substr( $query, 1 );
368 $bits = explode( '&', $query );
370 foreach( $bits as $bit ) {
374 list( $key, $value ) = explode( '=', $bit );
375 $key = urldecode( $key );
376 $value = urldecode( $value );
383 * Append a query string to an existing URL, which may or may not already
384 * have query string parameters already. If so, they will be combined.
387 * @param $query Mixed: string or associative array
390 function wfAppendQuery( $url, $query ) {
391 if ( is_array( $query ) ) {
392 $query = wfArrayToCGI( $query );
395 if( false === strpos( $url, '?' ) ) {
406 * Expand a potentially local URL to a fully-qualified URL. Assumes $wgServer
409 * @todo this won't work with current-path-relative URLs
410 * like "subdir/foo.html", etc.
412 * @param $url String: either fully-qualified or a local path + query
413 * @return string Fully-qualified URL
415 function wfExpandUrl( $url ) {
417 if( substr( $url, 0, 2 ) == '//' ) {
418 $bits = wfParseUrl( $wgServer );
419 $scheme = $bits ?
$bits['scheme'] : 'http';
420 return $scheme . ':' . $url;
421 } elseif( substr( $url, 0, 1 ) == '/' ) {
422 return $wgServer . $url;
429 * Returns a regular expression of url protocols
433 function wfUrlProtocols() {
434 global $wgUrlProtocols;
436 static $retval = null;
437 if ( !is_null( $retval ) ) {
441 // Support old-style $wgUrlProtocols strings, for backwards compatibility
442 // with LocalSettings files from 1.5
443 if ( is_array( $wgUrlProtocols ) ) {
444 $protocols = array();
445 foreach ( $wgUrlProtocols as $protocol ) {
446 $protocols[] = preg_quote( $protocol, '/' );
449 $retval = implode( '|', $protocols );
451 $retval = $wgUrlProtocols;
457 * parse_url() work-alike, but non-broken. Differences:
459 * 1) Does not raise warnings on bad URLs (just returns false)
460 * 2) Handles protocols that don't use :// (e.g., mailto: and news:) correctly
461 * 3) Adds a "delimiter" element to the array, either '://' or ':' (see (2))
463 * @param $url String: a URL to parse
464 * @return Array: bits of the URL in an associative array, per PHP docs
466 function wfParseUrl( $url ) {
467 global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
468 wfSuppressWarnings();
469 $bits = parse_url( $url );
475 // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
476 if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
477 $bits['delimiter'] = '://';
478 } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
479 $bits['delimiter'] = ':';
480 // parse_url detects for news: and mailto: the host part of an url as path
481 // We have to correct this wrong detection
482 if ( isset( $bits['path'] ) ) {
483 $bits['host'] = $bits['path'];
490 /* Provide an empty host for eg. file:/// urls (see bug 28627) */
491 if ( !isset( $bits['host'] ) ) {
494 /* parse_url loses the third / for file:///c:/ urls (but not on variants) */
495 if ( substr( $bits['path'], 0, 1 ) !== '/' ) {
496 $bits['path'] = '/' . $bits['path'];
503 * Make a URL index, appropriate for the el_index field of externallinks.
508 function wfMakeUrlIndex( $url ) {
509 $bits = wfParseUrl( $url );
511 // Reverse the labels in the hostname, convert to lower case
512 // For emails reverse domainpart only
513 if ( $bits['scheme'] == 'mailto' ) {
514 $mailparts = explode( '@', $bits['host'], 2 );
515 if ( count( $mailparts ) === 2 ) {
516 $domainpart = strtolower( implode( '.', array_reverse( explode( '.', $mailparts[1] ) ) ) );
518 // No domain specified, don't mangle it
521 $reversedHost = $domainpart . '@' . $mailparts[0];
523 $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) );
525 // Add an extra dot to the end
526 // Why? Is it in wrong place in mailto links?
527 if ( substr( $reversedHost, -1, 1 ) !== '.' ) {
528 $reversedHost .= '.';
530 // Reconstruct the pseudo-URL
531 $prot = $bits['scheme'];
532 $index = $prot . $bits['delimiter'] . $reversedHost;
533 // Leave out user and password. Add the port, path, query and fragment
534 if ( isset( $bits['port'] ) ) {
535 $index .= ':' . $bits['port'];
537 if ( isset( $bits['path'] ) ) {
538 $index .= $bits['path'];
542 if ( isset( $bits['query'] ) ) {
543 $index .= '?' . $bits['query'];
545 if ( isset( $bits['fragment'] ) ) {
546 $index .= '#' . $bits['fragment'];
552 * Sends a line to the debug log if enabled or, optionally, to a comment in output.
553 * In normal operation this is a NOP.
555 * Controlling globals:
556 * $wgDebugLogFile - points to the log file
557 * $wgProfileOnly - if set, normal debug messages will not be recorded.
558 * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
559 * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
561 * @param $text String
562 * @param $logonly Bool: set true to avoid appearing in HTML when $wgDebugComments is set
564 function wfDebug( $text, $logonly = false ) {
565 global $wgOut, $wgDebugLogFile, $wgDebugComments, $wgProfileOnly, $wgDebugRawPage;
566 global $wgDebugLogPrefix, $wgShowDebug;
568 static $cache = array(); // Cache of unoutputted messages
569 $text = wfDebugTimer() . $text;
571 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
575 if ( ( $wgDebugComments ||
$wgShowDebug ) && !$logonly ) {
578 if ( isset( $wgOut ) && is_object( $wgOut ) ) {
579 // add the message and any cached messages to the output
580 array_map( array( $wgOut, 'debug' ), $cache );
584 if ( wfRunHooks( 'Debug', array( $text, null /* no log group */ ) ) ) {
585 if ( $wgDebugLogFile != '' && !$wgProfileOnly ) {
586 # Strip unprintables; they can switch terminal modes when binary data
587 # gets dumped, which is pretty annoying.
588 $text = preg_replace( '![\x00-\x08\x0b\x0c\x0e-\x1f]!', ' ', $text );
589 $text = $wgDebugLogPrefix . $text;
590 wfErrorLog( $text, $wgDebugLogFile );
596 * Returns true if debug logging should be suppressed if $wgDebugRawPage = false
598 function wfIsDebugRawPage() {
600 if ( $cache !== null ) {
603 # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
604 if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
606 isset( $_SERVER['SCRIPT_NAME'] )
607 && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
618 * Get microsecond timestamps for debug logs
622 function wfDebugTimer() {
623 global $wgDebugTimestamps;
624 if ( !$wgDebugTimestamps ) {
627 static $start = null;
629 if ( $start === null ) {
630 $start = microtime( true );
631 $prefix = "\n$start";
633 $prefix = sprintf( "%6.4f", microtime( true ) - $start );
636 return $prefix . ' ';
640 * Send a line giving PHP memory usage.
642 * @param $exact Bool: print exact values instead of kilobytes (default: false)
644 function wfDebugMem( $exact = false ) {
645 $mem = memory_get_usage();
647 $mem = floor( $mem / 1024 ) . ' kilobytes';
651 wfDebug( "Memory usage: $mem\n" );
655 * Send a line to a supplementary debug log file, if configured, or main debug log if not.
656 * $wgDebugLogGroups[$logGroup] should be set to a filename to send to a separate log.
658 * @param $logGroup String
659 * @param $text String
660 * @param $public Bool: whether to log the event in the public log if no private
661 * log file is specified, (default true)
663 function wfDebugLog( $logGroup, $text, $public = true ) {
664 global $wgDebugLogGroups, $wgShowHostnames;
665 $text = trim( $text ) . "\n";
666 if( isset( $wgDebugLogGroups[$logGroup] ) ) {
667 $time = wfTimestamp( TS_DB
);
669 if ( $wgShowHostnames ) {
670 $host = wfHostname();
674 if ( wfRunHooks( 'Debug', array( $text, $logGroup ) ) ) {
675 wfErrorLog( "$time $host $wiki: $text", $wgDebugLogGroups[$logGroup] );
677 } elseif ( $public === true ) {
678 wfDebug( $text, true );
683 * Log for database errors
685 * @param $text String: database error message.
687 function wfLogDBError( $text ) {
688 global $wgDBerrorLog, $wgDBname;
689 if ( $wgDBerrorLog ) {
690 $host = trim(`hostname`
);
691 $text = date( 'D M j G:i:s T Y' ) . "\t$host\t$wgDBname\t$text";
692 wfErrorLog( $text, $wgDBerrorLog );
697 * Log to a file without getting "file size exceeded" signals.
699 * Can also log to TCP or UDP with the syntax udp://host:port/prefix. This will
700 * send lines to the specified port, prefixed by the specified prefix and a space.
702 * @param $text String
703 * @param $file String filename
705 function wfErrorLog( $text, $file ) {
706 if ( substr( $file, 0, 4 ) == 'udp:' ) {
707 # Needs the sockets extension
708 if ( preg_match( '!^(tcp|udp):(?://)?\[([0-9a-fA-F:]+)\]:(\d+)(?:/(.*))?$!', $file, $m ) ) {
709 // IPv6 bracketed host
711 $port = intval( $m[3] );
712 $prefix = isset( $m[4] ) ?
$m[4] : false;
714 } elseif ( preg_match( '!^(tcp|udp):(?://)?([a-zA-Z0-9.-]+):(\d+)(?:/(.*))?$!', $file, $m ) ) {
716 if ( !IP
::isIPv4( $host ) ) {
717 $host = gethostbyname( $host );
719 $port = intval( $m[3] );
720 $prefix = isset( $m[4] ) ?
$m[4] : false;
723 throw new MWException( __METHOD__
. ': Invalid UDP specification' );
726 // Clean it up for the multiplexer
727 if ( strval( $prefix ) !== '' ) {
728 $text = preg_replace( '/^/m', $prefix . ' ', $text );
731 if ( strlen( $text ) > 65534 ) {
732 $text = substr( $text, 0, 65534 );
735 if ( substr( $text, -1 ) != "\n" ) {
738 } elseif ( strlen( $text ) > 65535 ) {
739 $text = substr( $text, 0, 65535 );
742 $sock = socket_create( $domain, SOCK_DGRAM
, SOL_UDP
);
746 socket_sendto( $sock, $text, strlen( $text ), 0, $host, $port );
747 socket_close( $sock );
749 wfSuppressWarnings();
750 $exists = file_exists( $file );
751 $size = $exists ?
filesize( $file ) : false;
752 if ( !$exists ||
( $size !== false && $size +
strlen( $text ) < 0x7fffffff ) ) {
753 file_put_contents( $file, $text, FILE_APPEND
);
762 function wfLogProfilingData() {
763 global $wgRequestTime, $wgDebugLogFile, $wgDebugRawPage, $wgRequest;
764 global $wgProfileLimit, $wgUser;
766 $profiler = Profiler
::instance();
768 # Profiling must actually be enabled...
769 if ( $profiler->isStub() ) {
773 // Get total page request time and only show pages that longer than
774 // $wgProfileLimit time (default is 0)
776 $elapsed = $now - $wgRequestTime;
777 if ( $elapsed <= $wgProfileLimit ) {
781 $profiler->logData();
783 // Check whether this should be logged in the debug file.
784 if ( $wgDebugLogFile == '' ||
( !$wgDebugRawPage && wfIsDebugRawPage() ) ) {
789 if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
790 $forward = ' forwarded for ' . $_SERVER['HTTP_X_FORWARDED_FOR'];
792 if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
793 $forward .= ' client IP ' . $_SERVER['HTTP_CLIENT_IP'];
795 if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
796 $forward .= ' from ' . $_SERVER['HTTP_FROM'];
799 $forward = "\t(proxied via {$_SERVER['REMOTE_ADDR']}{$forward})";
801 // Don't load $wgUser at this late stage just for statistics purposes
802 // @todo FIXME: We can detect some anons even if it is not loaded. See User::getId()
803 if ( $wgUser->isItemLoaded( 'id' ) && $wgUser->isAnon() ) {
806 $log = sprintf( "%s\t%04.3f\t%s\n",
807 gmdate( 'YmdHis' ), $elapsed,
808 urldecode( $wgRequest->getRequestURL() . $forward ) );
810 wfErrorLog( $log . $profiler->getOutput(), $wgDebugLogFile );
814 * Check if the wiki read-only lock file is present. This can be used to lock
815 * off editing functions, but doesn't guarantee that the database will not be
820 function wfReadOnly() {
821 global $wgReadOnlyFile, $wgReadOnly;
823 if ( !is_null( $wgReadOnly ) ) {
824 return (bool)$wgReadOnly;
826 if ( $wgReadOnlyFile == '' ) {
829 // Set $wgReadOnly for faster access next time
830 if ( is_file( $wgReadOnlyFile ) ) {
831 $wgReadOnly = file_get_contents( $wgReadOnlyFile );
835 return (bool)$wgReadOnly;
838 function wfReadOnlyReason() {
845 * Return a Language object from $langcode
847 * @param $langcode Mixed: either:
848 * - a Language object
849 * - code of the language to get the message for, if it is
850 * a valid code create a language for that language, if
851 * it is a string but not a valid code then make a basic
853 * - a boolean: if it's false then use the current users
854 * language (as a fallback for the old parameter
855 * functionality), or if it is true then use the wikis
856 * @return Language object
858 function wfGetLangObj( $langcode = false ) {
859 # Identify which language to get or create a language object for.
860 # Using is_object here due to Stub objects.
861 if( is_object( $langcode ) ) {
862 # Great, we already have the object (hopefully)!
866 global $wgContLang, $wgLanguageCode;
867 if( $langcode === true ||
$langcode === $wgLanguageCode ) {
868 # $langcode is the language code of the wikis content language object.
869 # or it is a boolean and value is true
874 if( $langcode === false ||
$langcode === $wgLang->getCode() ) {
875 # $langcode is the language code of user language object.
876 # or it was a boolean and value is false
880 $validCodes = array_keys( Language
::getLanguageNames() );
881 if( in_array( $langcode, $validCodes ) ) {
882 # $langcode corresponds to a valid language.
883 return Language
::factory( $langcode );
886 # $langcode is a string, but not a valid language code; use content language.
887 wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
892 * Use this instead of $wgContLang, when working with user interface.
893 * User interface is currently hard coded according to wiki content language
894 * in many ways, especially regarding to text direction. There is lots stuff
895 * to fix, hence this function to keep the old behaviour unless the global
896 * $wgBetterDirectionality is enabled (or removed when everything works).
900 function wfUILang() {
901 global $wgBetterDirectionality;
902 return wfGetLangObj( !$wgBetterDirectionality );
906 * This is the new function for getting translated interface messages.
907 * See the Message class for documentation how to use them.
908 * The intention is that this function replaces all old wfMsg* functions.
909 * @param $key \string Message key.
910 * Varargs: normal message parameters.
914 function wfMessage( $key /*...*/) {
915 $params = func_get_args();
916 array_shift( $params );
917 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
918 $params = $params[0];
920 return new Message( $key, $params );
924 * This function accepts multiple message keys and returns a message instance
925 * for the first message which is non-empty. If all messages are empty then an
926 * instance of the first message key is returned.
927 * @param varargs: message keys
931 function wfMessageFallback( /*...*/ ) {
932 $args = func_get_args();
933 return MWFunction
::callArray( 'Message::newFallbackSequence', $args );
937 * Get a message from anywhere, for the current user language.
939 * Use wfMsgForContent() instead if the message should NOT
940 * change depending on the user preferences.
942 * @param $key String: lookup key for the message, usually
943 * defined in languages/Language.php
945 * Parameters to the message, which can be used to insert variable text into
946 * it, can be passed to this function in the following formats:
947 * - One per argument, starting at the second parameter
948 * - As an array in the second parameter
949 * These are not shown in the function definition.
953 function wfMsg( $key ) {
954 $args = func_get_args();
955 array_shift( $args );
956 return wfMsgReal( $key, $args, true );
960 * Same as above except doesn't transform the message
965 function wfMsgNoTrans( $key ) {
966 $args = func_get_args();
967 array_shift( $args );
968 return wfMsgReal( $key, $args, true, false, false );
972 * Get a message from anywhere, for the current global language
973 * set with $wgLanguageCode.
975 * Use this if the message should NOT change dependent on the
976 * language set in the user's preferences. This is the case for
977 * most text written into logs, as well as link targets (such as
978 * the name of the copyright policy page). Link titles, on the
979 * other hand, should be shown in the UI language.
981 * Note that MediaWiki allows users to change the user interface
982 * language in their preferences, but a single installation
983 * typically only contains content in one language.
985 * Be wary of this distinction: If you use wfMsg() where you should
986 * use wfMsgForContent(), a user of the software may have to
987 * customize potentially hundreds of messages in
988 * order to, e.g., fix a link in every possible language.
990 * @param $key String: lookup key for the message, usually
991 * defined in languages/Language.php
994 function wfMsgForContent( $key ) {
995 global $wgForceUIMsgAsContentMsg;
996 $args = func_get_args();
997 array_shift( $args );
999 if( is_array( $wgForceUIMsgAsContentMsg ) &&
1000 in_array( $key, $wgForceUIMsgAsContentMsg ) )
1002 $forcontent = false;
1004 return wfMsgReal( $key, $args, true, $forcontent );
1008 * Same as above except doesn't transform the message
1010 * @param $key String
1013 function wfMsgForContentNoTrans( $key ) {
1014 global $wgForceUIMsgAsContentMsg;
1015 $args = func_get_args();
1016 array_shift( $args );
1018 if( is_array( $wgForceUIMsgAsContentMsg ) &&
1019 in_array( $key, $wgForceUIMsgAsContentMsg ) )
1021 $forcontent = false;
1023 return wfMsgReal( $key, $args, true, $forcontent, false );
1027 * Get a message from the language file, for the UI elements
1029 * @deprecated since 1.18; use wfMessage()
1031 function wfMsgNoDB( $key ) {
1032 wfDeprecated( __FUNCTION__
);
1033 $args = func_get_args();
1034 array_shift( $args );
1035 return wfMsgReal( $key, $args, false );
1039 * Get a message from the language file, for the content
1041 * @deprecated since 1.18; use wfMessage()
1043 function wfMsgNoDBForContent( $key ) {
1044 wfDeprecated( __FUNCTION__
);
1045 global $wgForceUIMsgAsContentMsg;
1046 $args = func_get_args();
1047 array_shift( $args );
1049 if( is_array( $wgForceUIMsgAsContentMsg ) &&
1050 in_array( $key, $wgForceUIMsgAsContentMsg ) )
1052 $forcontent = false;
1054 return wfMsgReal( $key, $args, false, $forcontent );
1059 * Really get a message
1061 * @param $key String: key to get.
1063 * @param $useDB Boolean
1064 * @param $forContent Mixed: Language code, or false for user lang, true for content lang.
1065 * @param $transform Boolean: Whether or not to transform the message.
1066 * @return String: the requested message.
1068 function wfMsgReal( $key, $args, $useDB = true, $forContent = false, $transform = true ) {
1069 wfProfileIn( __METHOD__
);
1070 $message = wfMsgGetKey( $key, $useDB, $forContent, $transform );
1071 $message = wfMsgReplaceArgs( $message, $args );
1072 wfProfileOut( __METHOD__
);
1077 * This function provides the message source for messages to be edited which are *not* stored in the database.
1079 * @deprecated since 1.18; use wfMessage()
1080 * @param $key String
1082 function wfMsgWeirdKey( $key ) {
1083 wfDeprecated( __FUNCTION__
);
1084 $source = wfMsgGetKey( $key, false, true, false );
1085 if ( wfEmptyMsg( $key ) ) {
1093 * Fetch a message string value, but don't replace any keys yet.
1095 * @param $key String
1096 * @param $useDB Bool
1097 * @param $langCode String: Code of the language to get the message for, or
1098 * behaves as a content language switch if it is a boolean.
1099 * @param $transform Boolean: whether to parse magic words, etc.
1102 function wfMsgGetKey( $key, $useDB, $langCode = false, $transform = true ) {
1103 wfRunHooks( 'NormalizeMessageKey', array( &$key, &$useDB, &$langCode, &$transform ) );
1105 $cache = MessageCache
::singleton();
1106 $message = $cache->get( $key, $useDB, $langCode );
1107 if( $message === false ) {
1108 $message = '<' . htmlspecialchars( $key ) . '>';
1109 } elseif ( $transform ) {
1110 $message = $cache->transform( $message );
1116 * Replace message parameter keys on the given formatted output.
1118 * @param $message String
1119 * @param $args Array
1123 function wfMsgReplaceArgs( $message, $args ) {
1124 # Fix windows line-endings
1125 # Some messages are split with explode("\n", $msg)
1126 $message = str_replace( "\r", '', $message );
1128 // Replace arguments
1129 if ( count( $args ) ) {
1130 if ( is_array( $args[0] ) ) {
1131 $args = array_values( $args[0] );
1133 $replacementKeys = array();
1134 foreach( $args as $n => $param ) {
1135 $replacementKeys['$' . ( $n +
1 )] = $param;
1137 $message = strtr( $message, $replacementKeys );
1144 * Return an HTML-escaped version of a message.
1145 * Parameter replacements, if any, are done *after* the HTML-escaping,
1146 * so parameters may contain HTML (eg links or form controls). Be sure
1147 * to pre-escape them if you really do want plaintext, or just wrap
1148 * the whole thing in htmlspecialchars().
1150 * @param $key String
1151 * @param string ... parameters
1154 function wfMsgHtml( $key ) {
1155 $args = func_get_args();
1156 array_shift( $args );
1157 return wfMsgReplaceArgs( htmlspecialchars( wfMsgGetKey( $key, true ) ), $args );
1161 * Return an HTML version of message
1162 * Parameter replacements, if any, are done *after* parsing the wiki-text message,
1163 * so parameters may contain HTML (eg links or form controls). Be sure
1164 * to pre-escape them if you really do want plaintext, or just wrap
1165 * the whole thing in htmlspecialchars().
1167 * @param $key String
1168 * @param string ... parameters
1171 function wfMsgWikiHtml( $key ) {
1172 $args = func_get_args();
1173 array_shift( $args );
1174 return wfMsgReplaceArgs(
1175 MessageCache
::singleton()->parse( wfMsgGetKey( $key, true ), null, /* can't be set to false */ true )->getText(),
1180 * Returns message in the requested format
1181 * @param $key String: key of the message
1182 * @param $options Array: processing rules. Can take the following options:
1183 * <i>parse</i>: parses wikitext to HTML
1184 * <i>parseinline</i>: parses wikitext to HTML and removes the surrounding
1185 * p's added by parser or tidy
1186 * <i>escape</i>: filters message through htmlspecialchars
1187 * <i>escapenoentities</i>: same, but allows entity references like   through
1188 * <i>replaceafter</i>: parameters are substituted after parsing or escaping
1189 * <i>parsemag</i>: transform the message using magic phrases
1190 * <i>content</i>: fetch message for content language instead of interface
1191 * Also can accept a single associative argument, of the form 'language' => 'xx':
1192 * <i>language</i>: Language object or language code to fetch message for
1193 * (overriden by <i>content</i>).
1194 * Behavior for conflicting options (e.g., parse+parseinline) is undefined.
1198 function wfMsgExt( $key, $options ) {
1199 $args = func_get_args();
1200 array_shift( $args );
1201 array_shift( $args );
1202 $options = (array)$options;
1204 foreach( $options as $arrayKey => $option ) {
1205 if( !preg_match( '/^[0-9]+|language$/', $arrayKey ) ) {
1206 # An unknown index, neither numeric nor "language"
1207 wfWarn( "wfMsgExt called with incorrect parameter key $arrayKey", 1, E_USER_WARNING
);
1208 } elseif( preg_match( '/^[0-9]+$/', $arrayKey ) && !in_array( $option,
1209 array( 'parse', 'parseinline', 'escape', 'escapenoentities',
1210 'replaceafter', 'parsemag', 'content' ) ) ) {
1211 # A numeric index with unknown value
1212 wfWarn( "wfMsgExt called with incorrect parameter $option", 1, E_USER_WARNING
);
1216 if( in_array( 'content', $options, true ) ) {
1219 $langCodeObj = null;
1220 } elseif( array_key_exists( 'language', $options ) ) {
1221 $forContent = false;
1222 $langCode = wfGetLangObj( $options['language'] );
1223 $langCodeObj = $langCode;
1225 $forContent = false;
1227 $langCodeObj = null;
1230 $string = wfMsgGetKey( $key, /*DB*/true, $langCode, /*Transform*/false );
1232 if( !in_array( 'replaceafter', $options, true ) ) {
1233 $string = wfMsgReplaceArgs( $string, $args );
1236 $messageCache = MessageCache
::singleton();
1237 if( in_array( 'parse', $options, true ) ) {
1238 $string = $messageCache->parse( $string, null, true, !$forContent, $langCodeObj )->getText();
1239 } elseif ( in_array( 'parseinline', $options, true ) ) {
1240 $string = $messageCache->parse( $string, null, true, !$forContent, $langCodeObj )->getText();
1242 if( preg_match( '/^<p>(.*)\n?<\/p>\n?$/sU', $string, $m ) ) {
1245 } elseif ( in_array( 'parsemag', $options, true ) ) {
1246 $string = $messageCache->transform( $string,
1247 !$forContent, $langCodeObj );
1250 if ( in_array( 'escape', $options, true ) ) {
1251 $string = htmlspecialchars ( $string );
1252 } elseif ( in_array( 'escapenoentities', $options, true ) ) {
1253 $string = Sanitizer
::escapeHtmlAllowEntities( $string );
1256 if( in_array( 'replaceafter', $options, true ) ) {
1257 $string = wfMsgReplaceArgs( $string, $args );
1264 * Since wfMsg() and co suck, they don't return false if the message key they
1265 * looked up didn't exist but a XHTML string, this function checks for the
1266 * nonexistance of messages by checking the MessageCache::get() result directly.
1268 * @param $key String: the message key looked up
1269 * @return Boolean True if the message *doesn't* exist.
1271 function wfEmptyMsg( $key ) {
1272 return MessageCache
::singleton()->get( $key, /*useDB*/true, /*content*/false ) === false;
1276 * Print an error message and die, returning nonzero to the shell if any. Plain die()
1277 * fails to return nonzero to the shell if you pass a string. Entry points may customise
1278 * this function to return a prettier error message, but implementations must not assume
1279 * access to any of the usual MediaWiki infrastructure (AutoLoader, localisation, database,
1280 * etc). This should not be called directly once $wgFullyInitialised is set; instead,
1281 * throw an exception and let Exception.php handle whether or not it's possible to show
1284 * @param $msg String
1286 if( !function_exists( 'wfDie' ) ){
1287 function wfDie( $msg = '' ) {
1294 * Throw a debugging exception. This function previously once exited the process,
1295 * but now throws an exception instead, with similar results.
1297 * @param $msg String: message shown when dieing.
1299 function wfDebugDieBacktrace( $msg = '' ) {
1300 throw new MWException( $msg );
1304 * Fetch server name for use in error reporting etc.
1305 * Use real server name if available, so we know which machine
1306 * in a server farm generated the current page.
1310 function wfHostname() {
1312 if ( is_null( $host ) ) {
1313 if ( function_exists( 'posix_uname' ) ) {
1314 // This function not present on Windows
1315 $uname = posix_uname();
1319 if( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1320 $host = $uname['nodename'];
1321 } elseif ( getenv( 'COMPUTERNAME' ) ) {
1322 # Windows computer name
1323 $host = getenv( 'COMPUTERNAME' );
1325 # This may be a virtual server.
1326 $host = $_SERVER['SERVER_NAME'];
1333 * Returns a HTML comment with the elapsed time since request.
1334 * This method has no side effects.
1338 function wfReportTime() {
1339 global $wgRequestTime, $wgShowHostnames;
1342 $elapsed = $now - $wgRequestTime;
1344 return $wgShowHostnames
1345 ?
sprintf( '<!-- Served by %s in %01.3f secs. -->', wfHostname(), $elapsed )
1346 : sprintf( '<!-- Served in %01.3f secs. -->', $elapsed );
1350 * Safety wrapper for debug_backtrace().
1352 * With Zend Optimizer 3.2.0 loaded, this causes segfaults under somewhat
1353 * murky circumstances, which may be triggered in part by stub objects
1354 * or other fancy talkin'.
1356 * Will return an empty array if Zend Optimizer is detected or if
1357 * debug_backtrace is disabled, otherwise the output from
1358 * debug_backtrace() (trimmed).
1360 * @return array of backtrace information
1362 function wfDebugBacktrace() {
1363 static $disabled = null;
1365 if( extension_loaded( 'Zend Optimizer' ) ) {
1366 wfDebug( "Zend Optimizer detected; skipping debug_backtrace for safety.\n" );
1370 if ( is_null( $disabled ) ) {
1372 $functions = explode( ',', ini_get( 'disable_functions' ) );
1373 $functions = array_map( 'trim', $functions );
1374 $functions = array_map( 'strtolower', $functions );
1375 if ( in_array( 'debug_backtrace', $functions ) ) {
1376 wfDebug( "debug_backtrace is in disabled_functions\n" );
1384 return array_slice( debug_backtrace(), 1 );
1388 * Get a debug backtrace as a string
1392 function wfBacktrace() {
1393 global $wgCommandLineMode;
1395 if ( $wgCommandLineMode ) {
1400 $backtrace = wfDebugBacktrace();
1401 foreach( $backtrace as $call ) {
1402 if( isset( $call['file'] ) ) {
1403 $f = explode( DIRECTORY_SEPARATOR
, $call['file'] );
1404 $file = $f[count( $f ) - 1];
1408 if( isset( $call['line'] ) ) {
1409 $line = $call['line'];
1413 if ( $wgCommandLineMode ) {
1414 $msg .= "$file line $line calls ";
1416 $msg .= '<li>' . $file . ' line ' . $line . ' calls ';
1418 if( !empty( $call['class'] ) ) {
1419 $msg .= $call['class'] . '::';
1421 $msg .= $call['function'] . '()';
1423 if ( $wgCommandLineMode ) {
1429 if ( $wgCommandLineMode ) {
1439 * Get the name of the function which called this function
1442 * @return Bool|string
1444 function wfGetCaller( $level = 2 ) {
1445 $backtrace = wfDebugBacktrace();
1446 if ( isset( $backtrace[$level] ) ) {
1447 return wfFormatStackFrame( $backtrace[$level] );
1449 $caller = 'unknown';
1455 * Return a string consisting of callers in the stack. Useful sometimes
1456 * for profiling specific points.
1458 * @param $limit The maximum depth of the stack frame to return, or false for
1462 function wfGetAllCallers( $limit = 3 ) {
1463 $trace = array_reverse( wfDebugBacktrace() );
1464 if ( !$limit ||
$limit > count( $trace ) - 1 ) {
1465 $limit = count( $trace ) - 1;
1467 $trace = array_slice( $trace, -$limit - 1, $limit );
1468 return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1472 * Return a string representation of frame
1474 * @param $frame Array
1477 function wfFormatStackFrame( $frame ) {
1478 return isset( $frame['class'] ) ?
1479 $frame['class'] . '::' . $frame['function'] :
1484 /* Some generic result counters, pulled out of SearchEngine */
1490 * @param $offset Int
1494 function wfShowingResults( $offset, $limit ) {
1498 array( 'parseinline' ),
1499 $wgLang->formatNum( $limit ),
1500 $wgLang->formatNum( $offset +
1 )
1507 * @param $offset Int
1512 function wfShowingResultsNum( $offset, $limit, $num ) {
1515 'showingresultsnum',
1516 array( 'parseinline' ),
1517 $wgLang->formatNum( $limit ),
1518 $wgLang->formatNum( $offset +
1 ),
1519 $wgLang->formatNum( $num )
1524 * Generate (prev x| next x) (20|50|100...) type links for paging
1526 * @param $offset String
1527 * @param $limit Integer
1528 * @param $link String
1529 * @param $query String: optional URL query parameter string
1530 * @param $atend Bool: optional param for specified if this is the last page
1533 function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) {
1535 $fmtLimit = $wgLang->formatNum( $limit );
1536 // @todo FIXME: Why on earth this needs one message for the text and another one for tooltip?
1537 # Get prev/next link display text
1538 $prev = wfMsgExt( 'prevn', array( 'parsemag', 'escape' ), $fmtLimit );
1539 $next = wfMsgExt( 'nextn', array( 'parsemag', 'escape' ), $fmtLimit );
1540 # Get prev/next link title text
1541 $pTitle = wfMsgExt( 'prevn-title', array( 'parsemag', 'escape' ), $fmtLimit );
1542 $nTitle = wfMsgExt( 'nextn-title', array( 'parsemag', 'escape' ), $fmtLimit );
1543 # Fetch the title object
1544 if( is_object( $link ) ) {
1547 $title = Title
::newFromText( $link );
1548 if( is_null( $title ) ) {
1552 # Make 'previous' link
1553 if( 0 != $offset ) {
1554 $po = $offset - $limit;
1555 $po = max( $po, 0 );
1556 $q = "limit={$limit}&offset={$po}";
1557 if( $query != '' ) {
1560 $plink = '<a href="' . $title->escapeLocalURL( $q ) . "\" title=\"{$pTitle}\" class=\"mw-prevlink\">{$prev}</a>";
1565 $no = $offset +
$limit;
1566 $q = "limit={$limit}&offset={$no}";
1567 if( $query != '' ) {
1573 $nlink = '<a href="' . $title->escapeLocalURL( $q ) . "\" title=\"{$nTitle}\" class=\"mw-nextlink\">{$next}</a>";
1575 # Make links to set number of items per page
1576 $nums = $wgLang->pipeList( array(
1577 wfNumLink( $offset, 20, $title, $query ),
1578 wfNumLink( $offset, 50, $title, $query ),
1579 wfNumLink( $offset, 100, $title, $query ),
1580 wfNumLink( $offset, 250, $title, $query ),
1581 wfNumLink( $offset, 500, $title, $query )
1583 return wfMsgHtml( 'viewprevnext', $plink, $nlink, $nums );
1587 * Generate links for (20|50|100...) items-per-page links
1589 * @param $offset String
1590 * @param $limit Integer
1591 * @param $title Title
1592 * @param $query String: optional URL query parameter string
1594 function wfNumLink( $offset, $limit, $title, $query = '' ) {
1596 if( $query == '' ) {
1601 $q .= "limit={$limit}&offset={$offset}";
1602 $fmtLimit = $wgLang->formatNum( $limit );
1603 $lTitle = wfMsgExt( 'shown-title', array( 'parsemag', 'escape' ), $limit );
1604 $s = '<a href="' . $title->escapeLocalURL( $q ) . "\" title=\"{$lTitle}\" class=\"mw-numlink\">{$fmtLimit}</a>";
1610 * @todo FIXME: We may want to blacklist some broken browsers
1612 * @param $force Bool
1613 * @return bool Whereas client accept gzip compression
1615 function wfClientAcceptsGzip( $force = false ) {
1616 static $result = null;
1617 if ( $result === null ||
$force ) {
1619 if( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
1620 # @todo FIXME: We may want to blacklist some broken browsers
1623 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
1624 $_SERVER['HTTP_ACCEPT_ENCODING'],
1628 if( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
1632 wfDebug( " accepts gzip\n" );
1641 * Obtain the offset and limit values from the request string;
1642 * used in special pages
1644 * @param $deflimit Int default limit if none supplied
1645 * @param $optionname String Name of a user preference to check against
1649 function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
1651 return $wgRequest->getLimitOffset( $deflimit, $optionname );
1655 * Escapes the given text so that it may be output using addWikiText()
1656 * without any linking, formatting, etc. making its way through. This
1657 * is achieved by substituting certain characters with HTML entities.
1658 * As required by the callers, <nowiki> is not used.
1660 * @param $text String: text to be escaped
1663 function wfEscapeWikiText( $text ) {
1664 $text = strtr( "\n$text", array(
1665 '"' => '"', '&' => '&', "'" => ''', '<' => '<',
1666 '=' => '=', '>' => '>', '[' => '[', ']' => ']',
1667 '{' => '{', '|' => '|', '}' => '}',
1668 "\n#" => "\n#", "\n*" => "\n*",
1669 "\n:" => "\n:", "\n;" => "\n;",
1670 '://' => '://', 'ISBN ' => 'ISBN ', 'RFC ' => 'RFC ',
1672 return substr( $text, 1 );
1676 * Get the current unix timetstamp with microseconds. Useful for profiling
1680 return microtime( true );
1684 * Sets dest to source and returns the original value of dest
1685 * If source is NULL, it just returns the value, it doesn't set the variable
1686 * If force is true, it will set the value even if source is NULL
1688 * @param $dest Mixed
1689 * @param $source Mixed
1690 * @param $force Bool
1693 function wfSetVar( &$dest, $source, $force = false ) {
1695 if ( !is_null( $source ) ||
$force ) {
1702 * As for wfSetVar except setting a bit
1706 * @param $state Bool
1708 function wfSetBit( &$dest, $bit, $state = true ) {
1709 $temp = (bool)( $dest & $bit );
1710 if ( !is_null( $state ) ) {
1721 * Windows-compatible version of escapeshellarg()
1722 * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
1723 * function puts single quotes in regardless of OS.
1725 * Also fixes the locale problems on Linux in PHP 5.2.6+ (bug backported to
1726 * earlier distro releases of PHP)
1731 function wfEscapeShellArg( ) {
1732 wfInitShellLocale();
1734 $args = func_get_args();
1737 foreach ( $args as $arg ) {
1744 if ( wfIsWindows() ) {
1745 // Escaping for an MSVC-style command line parser and CMD.EXE
1747 // * http://web.archive.org/web/20020708081031/http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
1748 // * http://technet.microsoft.com/en-us/library/cc723564.aspx
1751 // Double the backslashes before any double quotes. Escape the double quotes.
1752 $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE
);
1755 foreach ( $tokens as $token ) {
1756 if ( $iteration %
2 == 1 ) {
1757 // Delimiter, a double quote preceded by zero or more slashes
1758 $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
1759 } elseif ( $iteration %
4 == 2 ) {
1760 // ^ in $token will be outside quotes, need to be escaped
1761 $arg .= str_replace( '^', '^^', $token );
1762 } else { // $iteration % 4 == 0
1763 // ^ in $token will appear inside double quotes, so leave as is
1768 // Double the backslashes before the end of the string, because
1769 // we will soon add a quote
1771 if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
1772 $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
1775 // Add surrounding quotes
1776 $retVal .= '"' . $arg . '"';
1778 $retVal .= escapeshellarg( $arg );
1785 * wfMerge attempts to merge differences between three texts.
1786 * Returns true for a clean merge and false for failure or a conflict.
1788 * @param $old String
1789 * @param $mine String
1790 * @param $yours String
1791 * @param $result String
1794 function wfMerge( $old, $mine, $yours, &$result ) {
1797 # This check may also protect against code injection in
1798 # case of broken installations.
1799 wfSuppressWarnings();
1800 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
1801 wfRestoreWarnings();
1804 wfDebug( "diff3 not found\n" );
1808 # Make temporary files
1810 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
1811 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
1812 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
1814 fwrite( $oldtextFile, $old );
1815 fclose( $oldtextFile );
1816 fwrite( $mytextFile, $mine );
1817 fclose( $mytextFile );
1818 fwrite( $yourtextFile, $yours );
1819 fclose( $yourtextFile );
1821 # Check for a conflict
1822 $cmd = $wgDiff3 . ' -a --overlap-only ' .
1823 wfEscapeShellArg( $mytextName ) . ' ' .
1824 wfEscapeShellArg( $oldtextName ) . ' ' .
1825 wfEscapeShellArg( $yourtextName );
1826 $handle = popen( $cmd, 'r' );
1828 if( fgets( $handle, 1024 ) ) {
1836 $cmd = $wgDiff3 . ' -a -e --merge ' .
1837 wfEscapeShellArg( $mytextName, $oldtextName, $yourtextName );
1838 $handle = popen( $cmd, 'r' );
1841 $data = fread( $handle, 8192 );
1842 if ( strlen( $data ) == 0 ) {
1848 unlink( $mytextName );
1849 unlink( $oldtextName );
1850 unlink( $yourtextName );
1852 if ( $result === '' && $old !== '' && !$conflict ) {
1853 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
1860 * Returns unified plain-text diff of two texts.
1861 * Useful for machine processing of diffs.
1863 * @param $before String: the text before the changes.
1864 * @param $after String: the text after the changes.
1865 * @param $params String: command-line options for the diff command.
1866 * @return String: unified diff of $before and $after
1868 function wfDiff( $before, $after, $params = '-u' ) {
1869 if ( $before == $after ) {
1874 wfSuppressWarnings();
1875 $haveDiff = $wgDiff && file_exists( $wgDiff );
1876 wfRestoreWarnings();
1878 # This check may also protect against code injection in
1879 # case of broken installations.
1881 wfDebug( "diff executable not found\n" );
1882 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
1883 $format = new UnifiedDiffFormatter();
1884 return $format->format( $diffs );
1887 # Make temporary files
1889 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
1890 $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
1892 fwrite( $oldtextFile, $before );
1893 fclose( $oldtextFile );
1894 fwrite( $newtextFile, $after );
1895 fclose( $newtextFile );
1897 // Get the diff of the two files
1898 $cmd = "$wgDiff " . $params . ' ' . wfEscapeShellArg( $oldtextName, $newtextName );
1900 $h = popen( $cmd, 'r' );
1905 $data = fread( $h, 8192 );
1906 if ( strlen( $data ) == 0 ) {
1914 unlink( $oldtextName );
1915 unlink( $newtextName );
1917 // Kill the --- and +++ lines. They're not useful.
1918 $diff_lines = explode( "\n", $diff );
1919 if ( strpos( $diff_lines[0], '---' ) === 0 ) {
1920 unset( $diff_lines[0] );
1922 if ( strpos( $diff_lines[1], '+++' ) === 0 ) {
1923 unset( $diff_lines[1] );
1926 $diff = implode( "\n", $diff_lines );
1932 * A wrapper around the PHP function var_export().
1933 * Either print it or add it to the regular output ($wgOut).
1935 * @param $var A PHP variable to dump.
1937 function wfVarDump( $var ) {
1939 $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
1940 if ( headers_sent() ||
!isset( $wgOut ) ||
!is_object( $wgOut ) ) {
1943 $wgOut->addHTML( $s );
1948 * Provide a simple HTTP error.
1950 * @param $code Int|String
1951 * @param $label String
1952 * @param $desc String
1954 function wfHttpError( $code, $label, $desc ) {
1957 header( "HTTP/1.0 $code $label" );
1958 header( "Status: $code $label" );
1959 $wgOut->sendCacheControl();
1961 header( 'Content-type: text/html; charset=utf-8' );
1962 print "<!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML 2.0//EN\">".
1963 '<html><head><title>' .
1964 htmlspecialchars( $label ) .
1965 '</title></head><body><h1>' .
1966 htmlspecialchars( $label ) .
1968 nl2br( htmlspecialchars( $desc ) ) .
1969 "</p></body></html>\n";
1973 * Clear away any user-level output buffers, discarding contents.
1975 * Suitable for 'starting afresh', for instance when streaming
1976 * relatively large amounts of data without buffering, or wanting to
1977 * output image files without ob_gzhandler's compression.
1979 * The optional $resetGzipEncoding parameter controls suppression of
1980 * the Content-Encoding header sent by ob_gzhandler; by default it
1981 * is left. See comments for wfClearOutputBuffers() for why it would
1984 * Note that some PHP configuration options may add output buffer
1985 * layers which cannot be removed; these are left in place.
1987 * @param $resetGzipEncoding Bool
1989 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
1990 if( $resetGzipEncoding ) {
1991 // Suppress Content-Encoding and Content-Length
1992 // headers from 1.10+s wfOutputHandler
1993 global $wgDisableOutputCompression;
1994 $wgDisableOutputCompression = true;
1996 while( $status = ob_get_status() ) {
1997 if( $status['type'] == 0 /* PHP_OUTPUT_HANDLER_INTERNAL */ ) {
1998 // Probably from zlib.output_compression or other
1999 // PHP-internal setting which can't be removed.
2001 // Give up, and hope the result doesn't break
2005 if( !ob_end_clean() ) {
2006 // Could not remove output buffer handler; abort now
2007 // to avoid getting in some kind of infinite loop.
2010 if( $resetGzipEncoding ) {
2011 if( $status['name'] == 'ob_gzhandler' ) {
2012 // Reset the 'Content-Encoding' field set by this handler
2013 // so we can start fresh.
2014 if ( function_exists( 'header_remove' ) ) {
2015 // Available since PHP 5.3.0
2016 header_remove( 'Content-Encoding' );
2018 // We need to provide a valid content-coding. See bug 28069
2019 header( 'Content-Encoding: identity' );
2028 * More legible than passing a 'false' parameter to wfResetOutputBuffers():
2030 * Clear away output buffers, but keep the Content-Encoding header
2031 * produced by ob_gzhandler, if any.
2033 * This should be used for HTTP 304 responses, where you need to
2034 * preserve the Content-Encoding header of the real result, but
2035 * also need to suppress the output of ob_gzhandler to keep to spec
2036 * and avoid breaking Firefox in rare cases where the headers and
2037 * body are broken over two packets.
2039 function wfClearOutputBuffers() {
2040 wfResetOutputBuffers( false );
2044 * Converts an Accept-* header into an array mapping string values to quality
2047 * @param $accept String
2048 * @param $def String default
2051 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
2052 # No arg means accept anything (per HTTP spec)
2054 return array( $def => 1.0 );
2059 $parts = explode( ',', $accept );
2061 foreach( $parts as $part ) {
2062 # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
2063 $values = explode( ';', trim( $part ) );
2065 if ( count( $values ) == 1 ) {
2066 $prefs[$values[0]] = 1.0;
2067 } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
2068 $prefs[$values[0]] = floatval( $match[1] );
2076 * Checks if a given MIME type matches any of the keys in the given
2077 * array. Basic wildcards are accepted in the array keys.
2079 * Returns the matching MIME type (or wildcard) if a match, otherwise
2082 * @param $type String
2083 * @param $avail Array
2087 function mimeTypeMatch( $type, $avail ) {
2088 if( array_key_exists( $type, $avail ) ) {
2091 $parts = explode( '/', $type );
2092 if( array_key_exists( $parts[0] . '/*', $avail ) ) {
2093 return $parts[0] . '/*';
2094 } elseif( array_key_exists( '*/*', $avail ) ) {
2103 * Returns the 'best' match between a client's requested internet media types
2104 * and the server's list of available types. Each list should be an associative
2105 * array of type to preference (preference is a float between 0.0 and 1.0).
2106 * Wildcards in the types are acceptable.
2108 * @param $cprefs Array: client's acceptable type list
2109 * @param $sprefs Array: server's offered types
2112 * @todo FIXME: Doesn't handle params like 'text/plain; charset=UTF-8'
2113 * XXX: generalize to negotiate other stuff
2115 function wfNegotiateType( $cprefs, $sprefs ) {
2118 foreach( array_keys($sprefs) as $type ) {
2119 $parts = explode( '/', $type );
2120 if( $parts[1] != '*' ) {
2121 $ckey = mimeTypeMatch( $type, $cprefs );
2123 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
2128 foreach( array_keys( $cprefs ) as $type ) {
2129 $parts = explode( '/', $type );
2130 if( $parts[1] != '*' && !array_key_exists( $type, $sprefs ) ) {
2131 $skey = mimeTypeMatch( $type, $sprefs );
2133 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
2141 foreach( array_keys( $combine ) as $type ) {
2142 if( $combine[$type] > $bestq ) {
2144 $bestq = $combine[$type];
2152 * Reference-counted warning suppression
2156 function wfSuppressWarnings( $end = false ) {
2157 static $suppressCount = 0;
2158 static $originalLevel = false;
2161 if ( $suppressCount ) {
2163 if ( !$suppressCount ) {
2164 error_reporting( $originalLevel );
2168 if ( !$suppressCount ) {
2169 // E_DEPRECATED is undefined in PHP 5.2
2170 if( !defined( 'E_DEPRECATED' ) ){
2171 define( 'E_DEPRECATED', 8192 );
2173 $originalLevel = error_reporting( E_ALL
& ~
( E_WARNING | E_NOTICE | E_USER_WARNING | E_USER_NOTICE | E_DEPRECATED
) );
2180 * Restore error level to previous value
2182 function wfRestoreWarnings() {
2183 wfSuppressWarnings( true );
2186 # Autodetect, convert and provide timestamps of various types
2189 * Unix time - the number of seconds since 1970-01-01 00:00:00 UTC
2191 define( 'TS_UNIX', 0 );
2194 * MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
2196 define( 'TS_MW', 1 );
2199 * MySQL DATETIME (YYYY-MM-DD HH:MM:SS)
2201 define( 'TS_DB', 2 );
2204 * RFC 2822 format, for E-mail and HTTP headers
2206 define( 'TS_RFC2822', 3 );
2209 * ISO 8601 format with no timezone: 1986-02-09T20:00:00Z
2211 * This is used by Special:Export
2213 define( 'TS_ISO_8601', 4 );
2216 * An Exif timestamp (YYYY:MM:DD HH:MM:SS)
2218 * @see http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the
2219 * DateTime tag and page 36 for the DateTimeOriginal and
2220 * DateTimeDigitized tags.
2222 define( 'TS_EXIF', 5 );
2225 * Oracle format time.
2227 define( 'TS_ORACLE', 6 );
2230 * Postgres format time.
2232 define( 'TS_POSTGRES', 7 );
2237 define( 'TS_DB2', 8 );
2240 * ISO 8601 basic format with no timezone: 19860209T200000Z. This is used by ResourceLoader
2242 define( 'TS_ISO_8601_BASIC', 9 );
2245 * Get a timestamp string in one of various formats
2247 * @param $outputtype Mixed: A timestamp in one of the supported formats, the
2248 * function will autodetect which format is supplied and act
2250 * @param $ts Mixed: the timestamp to convert or 0 for the current timestamp
2251 * @return Mixed: String / false The same date in the format specified in $outputtype or false
2253 function wfTimestamp( $outputtype = TS_UNIX
, $ts = 0 ) {
2258 if ( !$ts ) { // We want to catch 0, '', null... but not date strings starting with a letter.
2261 } elseif ( preg_match( '/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)$/D', $ts, $da ) ) {
2263 } elseif ( preg_match( '/^(\d{4}):(\d\d):(\d\d) (\d\d):(\d\d):(\d\d)$/D', $ts, $da ) ) {
2265 } elseif ( preg_match( '/^(\d{4})(\d\d)(\d\d)(\d\d)(\d\d)(\d\d)$/D', $ts, $da ) ) {
2267 } elseif ( preg_match( '/^-?\d{1,13}$/D', $ts ) ) {
2270 $strtime = "@$ts"; // Undocumented?
2271 } elseif ( preg_match( '/^\d{2}-\d{2}-\d{4} \d{2}:\d{2}:\d{2}.\d{6}$/', $ts ) ) {
2272 # TS_ORACLE // session altered to DD-MM-YYYY HH24:MI:SS.FF6
2273 $strtime = preg_replace( '/(\d\d)\.(\d\d)\.(\d\d)(\.(\d+))?/', "$1:$2:$3",
2274 str_replace( '+00:00', 'UTC', $ts ) );
2275 } elseif ( preg_match( '/^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})(?:\.*\d*)?Z$/', $ts, $da ) ) {
2277 } elseif ( preg_match( '/^(\d{4})(\d{2})(\d{2})T(\d{2})(\d{2})(\d{2})(?:\.*\d*)?Z$/', $ts, $da ) ) {
2279 } elseif ( preg_match( '/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)\.*\d*[\+\- ](\d\d)$/', $ts, $da ) ) {
2281 } elseif ( preg_match( '/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)\.*\d* GMT$/', $ts, $da ) ) {
2283 } elseif (preg_match('/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)\.\d\d\d$/',$ts,$da)) {
2285 } elseif ( preg_match( '/^[ \t\r\n]*([A-Z][a-z]{2},[ \t\r\n]*)?' . # Day of week
2286 '\d\d?[ \t\r\n]*[A-Z][a-z]{2}[ \t\r\n]*\d{2}(?:\d{2})?' . # dd Mon yyyy
2287 '[ \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
2288 # TS_RFC2822, accepting a trailing comment. See http://www.squid-cache.org/mail-archive/squid-users/200307/0122.html / r77171
2289 # The regex is a superset of rfc2822 for readability
2290 $strtime = strtok( $ts, ';' );
2291 } 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 ) ) {
2294 } 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 ) ) {
2299 wfDebug("wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n");
2304 static $formats = array(
2307 TS_DB
=> 'Y-m-d H:i:s',
2308 TS_ISO_8601
=> 'Y-m-d\TH:i:s\Z',
2309 TS_ISO_8601_BASIC
=> 'Ymd\THis\Z',
2310 TS_EXIF
=> 'Y:m:d H:i:s', // This shouldn't ever be used, but is included for completeness
2311 TS_RFC2822
=> 'D, d M Y H:i:s',
2312 TS_ORACLE
=> 'd-m-Y H:i:s.000000', // Was 'd-M-y h.i.s A' . ' +00:00' before r51500
2313 TS_POSTGRES
=> 'Y-m-d H:i:s',
2314 TS_DB2
=> 'Y-m-d H:i:s',
2317 if ( !isset( $formats[$outputtype] ) ) {
2318 throw new MWException( 'wfTimestamp() called with illegal output type.' );
2321 if ( function_exists( "date_create" ) ) {
2322 if ( count( $da ) ) {
2323 $ds = sprintf("%04d-%02d-%02dT%02d:%02d:%02d.00+00:00",
2324 (int)$da[1], (int)$da[2], (int)$da[3],
2325 (int)$da[4], (int)$da[5], (int)$da[6]);
2327 $d = date_create( $ds, new DateTimeZone( 'GMT' ) );
2328 } elseif ( $strtime ) {
2329 $d = date_create( $strtime, new DateTimeZone( 'GMT' ) );
2335 wfDebug("wfTimestamp() fed bogus time value: $outputtype; $ts\n");
2339 $output = $d->format( $formats[$outputtype] );
2341 if ( count( $da ) ) {
2342 // Warning! gmmktime() acts oddly if the month or day is set to 0
2343 // We may want to handle that explicitly at some point
2344 $uts = gmmktime( (int)$da[4], (int)$da[5], (int)$da[6],
2345 (int)$da[2], (int)$da[3], (int)$da[1] );
2346 } elseif ( $strtime ) {
2347 $uts = strtotime( $strtime );
2350 if ( $uts === false ) {
2351 wfDebug("wfTimestamp() can't parse the timestamp (non 32-bit time? Update php): $outputtype; $ts\n");
2355 if ( TS_UNIX
== $outputtype ) {
2358 $output = gmdate( $formats[$outputtype], $uts );
2361 if ( ( $outputtype == TS_RFC2822
) ||
( $outputtype == TS_POSTGRES
) ) {
2369 * Return a formatted timestamp, or null if input is null.
2370 * For dealing with nullable timestamp columns in the database.
2372 * @param $outputtype Integer
2376 function wfTimestampOrNull( $outputtype = TS_UNIX
, $ts = null ) {
2377 if( is_null( $ts ) ) {
2380 return wfTimestamp( $outputtype, $ts );
2385 * Convenience function; returns MediaWiki timestamp for the present time.
2389 function wfTimestampNow() {
2391 return wfTimestamp( TS_MW
, time() );
2395 * Check if the operating system is Windows
2397 * @return Bool: true if it's Windows, False otherwise.
2399 function wfIsWindows() {
2400 static $isWindows = null;
2401 if ( $isWindows === null ) {
2402 $isWindows = substr( php_uname(), 0, 7 ) == 'Windows';
2408 * Check if we are running under HipHop
2412 function wfIsHipHop() {
2413 return function_exists( 'hphp_thread_set_warmup_enabled' );
2417 * Swap two variables
2422 function swap( &$x, &$y ) {
2429 * Tries to get the system directory for temporary files. The TMPDIR, TMP, and
2430 * TEMP environment variables are then checked in sequence, and if none are set
2431 * try sys_get_temp_dir() for PHP >= 5.2.1. All else fails, return /tmp for Unix
2432 * or C:\Windows\Temp for Windows and hope for the best.
2433 * It is common to call it with tempnam().
2435 * NOTE: When possible, use instead the tmpfile() function to create
2436 * temporary files to avoid race conditions on file creation, etc.
2440 function wfTempDir() {
2441 foreach( array( 'TMPDIR', 'TMP', 'TEMP' ) as $var ) {
2442 $tmp = getenv( $var );
2443 if( $tmp && file_exists( $tmp ) && is_dir( $tmp ) && is_writable( $tmp ) ) {
2447 if( function_exists( 'sys_get_temp_dir' ) ) {
2448 return sys_get_temp_dir();
2451 return wfIsWindows() ?
'C:\Windows\Temp' : '/tmp';
2455 * Make directory, and make all parent directories if they don't exist
2457 * @param $dir String: full path to directory to create
2458 * @param $mode Integer: chmod value to use, default is $wgDirectoryMode
2459 * @param $caller String: optional caller param for debugging.
2462 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2463 global $wgDirectoryMode;
2465 if ( !is_null( $caller ) ) {
2466 wfDebug( "$caller: called wfMkdirParents($dir)" );
2469 if( strval( $dir ) === '' ||
file_exists( $dir ) ) {
2473 $dir = str_replace( array( '\\', '/' ), DIRECTORY_SEPARATOR
, $dir );
2475 if ( is_null( $mode ) ) {
2476 $mode = $wgDirectoryMode;
2479 // Turn off the normal warning, we're doing our own below
2480 wfSuppressWarnings();
2481 $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2482 wfRestoreWarnings();
2485 // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2486 trigger_error( __FUNCTION__
. ": failed to mkdir \"$dir\" mode $mode", E_USER_WARNING
);
2492 * Increment a statistics counter
2494 * @param $key String
2497 function wfIncrStats( $key, $count = 1 ) {
2498 global $wgStatsMethod;
2500 $count = intval( $count );
2502 if( $wgStatsMethod == 'udp' ) {
2503 global $wgUDPProfilerHost, $wgUDPProfilerPort, $wgDBname, $wgAggregateStatsID;
2506 $id = $wgAggregateStatsID !== false ?
$wgAggregateStatsID : $wgDBname;
2509 $socket = socket_create( AF_INET
, SOCK_DGRAM
, SOL_UDP
);
2510 $statline = "stats/{$id} - {$count} 1 1 1 1 -total\n";
2514 strlen( $statline ),
2520 $statline = "stats/{$id} - {$count} 1 1 1 1 {$key}\n";
2521 wfSuppressWarnings();
2525 strlen( $statline ),
2530 wfRestoreWarnings();
2531 } elseif( $wgStatsMethod == 'cache' ) {
2533 $key = wfMemcKey( 'stats', $key );
2534 if ( is_null( $wgMemc->incr( $key, $count ) ) ) {
2535 $wgMemc->add( $key, $count );
2543 * @param $nr Mixed: the number to format
2544 * @param $acc Integer: the number of digits after the decimal point, default 2
2545 * @param $round Boolean: whether or not to round the value, default true
2548 function wfPercent( $nr, $acc = 2, $round = true ) {
2549 $ret = sprintf( "%.${acc}f", $nr );
2550 return $round ?
round( $ret, $acc ) . '%' : "$ret%";
2554 * Find out whether or not a mixed variable exists in a string
2556 * @param $needle String
2557 * @param $str String
2558 * @param $insensitive Boolean
2561 function in_string( $needle, $str, $insensitive = false ) {
2563 if( $insensitive ) $func = 'stripos';
2565 return $func( $str, $needle ) !== false;
2568 function wfSpecialList( $page, $details ) {
2570 $details = $details ?
' ' . $wgContLang->getDirMark() . "($details)" : '';
2571 return $page . $details;
2575 * Safety wrapper around ini_get() for boolean settings.
2576 * The values returned from ini_get() are pre-normalized for settings
2577 * set via php.ini or php_flag/php_admin_flag... but *not*
2578 * for those set via php_value/php_admin_value.
2580 * It's fairly common for people to use php_value instead of php_flag,
2581 * which can leave you with an 'off' setting giving a false positive
2582 * for code that just takes the ini_get() return value as a boolean.
2584 * To make things extra interesting, setting via php_value accepts
2585 * "true" and "yes" as true, but php.ini and php_flag consider them false. :)
2586 * Unrecognized values go false... again opposite PHP's own coercion
2587 * from string to bool.
2589 * Luckily, 'properly' set settings will always come back as '0' or '1',
2590 * so we only have to worry about them and the 'improper' settings.
2592 * I frickin' hate PHP... :P
2594 * @param $setting String
2597 function wfIniGetBool( $setting ) {
2598 $val = ini_get( $setting );
2599 // 'on' and 'true' can't have whitespace around them, but '1' can.
2600 return strtolower( $val ) == 'on'
2601 ||
strtolower( $val ) == 'true'
2602 ||
strtolower( $val ) == 'yes'
2603 ||
preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2607 * Wrapper function for PHP's dl(). This doesn't work in most situations from
2608 * PHP 5.3 onward, and is usually disabled in shared environments anyway.
2610 * @param $extension String A PHP extension. The file suffix (.so or .dll)
2612 * @param $fileName String Name of the library, if not $extension.suffix
2613 * @return Bool - Whether or not the extension is loaded
2615 function wfDl( $extension, $fileName = null ) {
2616 if( extension_loaded( $extension ) ) {
2621 $sapi = php_sapi_name();
2622 if( version_compare( PHP_VERSION
, '5.3.0', '<' ) ||
2623 $sapi == 'cli' ||
$sapi == 'cgi' ||
$sapi == 'embed' )
2625 $canDl = ( function_exists( 'dl' ) && is_callable( 'dl' )
2626 && wfIniGetBool( 'enable_dl' ) && !wfIniGetBool( 'safe_mode' ) );
2630 $fileName = $fileName ?
$fileName : $extension;
2631 if( wfIsWindows() ) {
2632 $fileName = 'php_' . $fileName;
2634 wfSuppressWarnings();
2635 dl( $fileName . '.' . PHP_SHLIB_SUFFIX
);
2636 wfRestoreWarnings();
2638 return extension_loaded( $extension );
2642 * Execute a shell command, with time and memory limits mirrored from the PHP
2643 * configuration if supported.
2644 * @param $cmd String Command line, properly escaped for shell.
2645 * @param &$retval optional, will receive the program's exit code.
2646 * (non-zero is usually failure)
2647 * @param $environ Array optional environment variables which should be
2648 * added to the executed command environment.
2649 * @return collected stdout as a string (trailing newlines stripped)
2651 function wfShellExec( $cmd, &$retval = null, $environ = array() ) {
2652 global $IP, $wgMaxShellMemory, $wgMaxShellFileSize, $wgMaxShellTime;
2655 if ( is_null( $disabled ) ) {
2657 if( wfIniGetBool( 'safe_mode' ) ) {
2658 wfDebug( "wfShellExec can't run in safe_mode, PHP's exec functions are too broken.\n" );
2659 $disabled = 'safemode';
2661 $functions = explode( ',', ini_get( 'disable_functions' ) );
2662 $functions = array_map( 'trim', $functions );
2663 $functions = array_map( 'strtolower', $functions );
2664 if ( in_array( 'passthru', $functions ) ) {
2665 wfDebug( "passthru is in disabled_functions\n" );
2666 $disabled = 'passthru';
2672 return $disabled == 'safemode' ?
2673 'Unable to run external programs in safe mode.' :
2674 'Unable to run external programs, passthru() is disabled.';
2677 wfInitShellLocale();
2680 foreach( $environ as $k => $v ) {
2681 if ( wfIsWindows() ) {
2682 /* Surrounding a set in quotes (method used by wfEscapeShellArg) makes the quotes themselves
2683 * appear in the environment variable, so we must use carat escaping as documented in
2684 * http://technet.microsoft.com/en-us/library/cc723564.aspx
2685 * Note however that the quote isn't listed there, but is needed, and the parentheses
2686 * are listed there but doesn't appear to need it.
2688 $envcmd .= "set $k=" . preg_replace( '/([&|()<>^"])/', '^\\1', $v ) . '&& ';
2690 /* Assume this is a POSIX shell, thus required to accept variable assignments before the command
2691 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_09_01
2693 $envcmd .= "$k=" . escapeshellarg( $v ) . ' ';
2696 $cmd = $envcmd . $cmd;
2698 if ( wfIsWindows() ) {
2699 if ( version_compare( PHP_VERSION
, '5.3.0', '<' ) && /* Fixed in 5.3.0 :) */
2700 ( version_compare( PHP_VERSION
, '5.2.1', '>=' ) ||
php_uname( 's' ) == 'Windows NT' ) )
2702 # Hack to work around PHP's flawed invocation of cmd.exe
2703 # http://news.php.net/php.internals/21796
2704 # Windows 9x doesn't accept any kind of quotes
2705 $cmd = '"' . $cmd . '"';
2707 } elseif ( php_uname( 's' ) == 'Linux' ) {
2708 $time = intval( $wgMaxShellTime );
2709 $mem = intval( $wgMaxShellMemory );
2710 $filesize = intval( $wgMaxShellFileSize );
2712 if ( $time > 0 && $mem > 0 ) {
2713 $script = "$IP/bin/ulimit4.sh";
2714 if ( is_executable( $script ) ) {
2715 $cmd = '/bin/bash ' . escapeshellarg( $script ) . " $time $mem $filesize " . escapeshellarg( $cmd );
2719 wfDebug( "wfShellExec: $cmd\n" );
2721 $retval = 1; // error by default?
2723 passthru( $cmd, $retval );
2724 $output = ob_get_contents();
2727 if ( $retval == 127 ) {
2728 wfDebugLog( 'exec', "Possibly missing executable file: $cmd\n" );
2734 * Workaround for http://bugs.php.net/bug.php?id=45132
2735 * escapeshellarg() destroys non-ASCII characters if LANG is not a UTF-8 locale
2737 function wfInitShellLocale() {
2738 static $done = false;
2743 global $wgShellLocale;
2744 if ( !wfIniGetBool( 'safe_mode' ) ) {
2745 putenv( "LC_CTYPE=$wgShellLocale" );
2746 setlocale( LC_CTYPE
, $wgShellLocale );
2751 * This function works like "use VERSION" in Perl, the program will die with a
2752 * backtrace if the current version of PHP is less than the version provided
2754 * This is useful for extensions which due to their nature are not kept in sync
2755 * with releases, and might depend on other versions of PHP than the main code
2757 * Note: PHP might die due to parsing errors in some cases before it ever
2758 * manages to call this function, such is life
2760 * @see perldoc -f use
2762 * @param $req_ver Mixed: the version to check, can be a string, an integer, or
2765 function wfUsePHP( $req_ver ) {
2766 $php_ver = PHP_VERSION
;
2768 if ( version_compare( $php_ver, (string)$req_ver, '<' ) ) {
2769 throw new MWException( "PHP $req_ver required--this is only $php_ver" );
2774 * This function works like "use VERSION" in Perl except it checks the version
2775 * of MediaWiki, the program will die with a backtrace if the current version
2776 * of MediaWiki is less than the version provided.
2778 * This is useful for extensions which due to their nature are not kept in sync
2781 * @see perldoc -f use
2783 * @param $req_ver Mixed: the version to check, can be a string, an integer, or
2786 function wfUseMW( $req_ver ) {
2789 if ( version_compare( $wgVersion, (string)$req_ver, '<' ) ) {
2790 throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
2795 * Return the final portion of a pathname.
2796 * Reimplemented because PHP5's basename() is buggy with multibyte text.
2797 * http://bugs.php.net/bug.php?id=33898
2799 * PHP's basename() only considers '\' a pathchar on Windows and Netware.
2800 * We'll consider it so always, as we don't want \s in our Unix paths either.
2802 * @param $path String
2803 * @param $suffix String: to remove if present
2806 function wfBaseName( $path, $suffix = '' ) {
2807 $encSuffix = ( $suffix == '' )
2809 : ( '(?:' . preg_quote( $suffix, '#' ) . ')?' );
2811 if( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
2819 * Generate a relative path name to the given file.
2820 * May explode on non-matching case-insensitive paths,
2821 * funky symlinks, etc.
2823 * @param $path String: absolute destination path including target filename
2824 * @param $from String: Absolute source path, directory only
2827 function wfRelativePath( $path, $from ) {
2828 // Normalize mixed input on Windows...
2829 $path = str_replace( '/', DIRECTORY_SEPARATOR
, $path );
2830 $from = str_replace( '/', DIRECTORY_SEPARATOR
, $from );
2832 // Trim trailing slashes -- fix for drive root
2833 $path = rtrim( $path, DIRECTORY_SEPARATOR
);
2834 $from = rtrim( $from, DIRECTORY_SEPARATOR
);
2836 $pieces = explode( DIRECTORY_SEPARATOR
, dirname( $path ) );
2837 $against = explode( DIRECTORY_SEPARATOR
, $from );
2839 if( $pieces[0] !== $against[0] ) {
2840 // Non-matching Windows drive letters?
2841 // Return a full path.
2845 // Trim off common prefix
2846 while( count( $pieces ) && count( $against )
2847 && $pieces[0] == $against[0] ) {
2848 array_shift( $pieces );
2849 array_shift( $against );
2852 // relative dots to bump us to the parent
2853 while( count( $against ) ) {
2854 array_unshift( $pieces, '..' );
2855 array_shift( $against );
2858 array_push( $pieces, wfBaseName( $path ) );
2860 return implode( DIRECTORY_SEPARATOR
, $pieces );
2864 * Do any deferred updates and clear the list
2866 * @param $commit String: set to 'commit' to commit after every update to
2867 * prevent lock contention
2869 function wfDoUpdates( $commit = '' ) {
2870 global $wgDeferredUpdateList;
2872 wfProfileIn( __METHOD__
);
2874 // No need to get master connections in case of empty updates array
2875 if ( !count( $wgDeferredUpdateList ) ) {
2876 wfProfileOut( __METHOD__
);
2880 $doCommit = $commit == 'commit';
2882 $dbw = wfGetDB( DB_MASTER
);
2885 foreach ( $wgDeferredUpdateList as $update ) {
2886 $update->doUpdate();
2888 if ( $doCommit && $dbw->trxLevel() ) {
2893 $wgDeferredUpdateList = array();
2894 wfProfileOut( __METHOD__
);
2898 * Convert an arbitrarily-long digit string from one numeric base
2899 * to another, optionally zero-padding to a minimum column width.
2901 * Supports base 2 through 36; digit values 10-36 are represented
2902 * as lowercase letters a-z. Input is case-insensitive.
2904 * @param $input String: of digits
2905 * @param $sourceBase Integer: 2-36
2906 * @param $destBase Integer: 2-36
2907 * @param $pad Integer: 1 or greater
2908 * @param $lowercase Boolean
2909 * @return String or false on invalid input
2911 function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1, $lowercase = true ) {
2912 $input = strval( $input );
2913 if( $sourceBase < 2 ||
2918 $sourceBase != intval( $sourceBase ) ||
2919 $destBase != intval( $destBase ) ||
2920 $pad != intval( $pad ) ||
2921 !is_string( $input ) ||
2925 $digitChars = ( $lowercase ) ?
'0123456789abcdefghijklmnopqrstuvwxyz' : '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ';
2926 $inDigits = array();
2929 // Decode and validate input string
2930 $input = strtolower( $input );
2931 for( $i = 0; $i < strlen( $input ); $i++
) {
2932 $n = strpos( $digitChars, $input[$i] );
2933 if( $n === false ||
$n > $sourceBase ) {
2939 // Iterate over the input, modulo-ing out an output digit
2940 // at a time until input is gone.
2941 while( count( $inDigits ) ) {
2943 $workDigits = array();
2946 foreach( $inDigits as $digit ) {
2947 $work *= $sourceBase;
2950 if( $work < $destBase ) {
2951 // Gonna need to pull another digit.
2952 if( count( $workDigits ) ) {
2953 // Avoid zero-padding; this lets us find
2954 // the end of the input very easily when
2955 // length drops to zero.
2959 // Finally! Actual division!
2960 $workDigits[] = intval( $work / $destBase );
2962 // Isn't it annoying that most programming languages
2963 // don't have a single divide-and-remainder operator,
2964 // even though the CPU implements it that way?
2965 $work = $work %
$destBase;
2969 // All that division leaves us with a remainder,
2970 // which is conveniently our next output digit.
2971 $outChars .= $digitChars[$work];
2974 $inDigits = $workDigits;
2977 while( strlen( $outChars ) < $pad ) {
2981 return strrev( $outChars );
2985 * Create an object with a given name and an array of construct parameters
2987 * @param $name String
2988 * @param $p Array: parameters
2989 * @deprecated since 1.18, warnings in 1.19, removal in 1.20
2991 function wfCreateObject( $name, $p ) {
2992 wfDeprecated( __FUNCTION__
);
2993 return MWFunction
::newObj( $name, $p );
2996 function wfHttpOnlySafe() {
2997 global $wgHttpOnlyBlacklist;
2999 if( isset( $_SERVER['HTTP_USER_AGENT'] ) ) {
3000 foreach( $wgHttpOnlyBlacklist as $regex ) {
3001 if( preg_match( $regex, $_SERVER['HTTP_USER_AGENT'] ) ) {
3011 * Initialise php session
3013 * @param $sessionId Bool
3015 function wfSetupSession( $sessionId = false ) {
3016 global $wgSessionsInMemcached, $wgCookiePath, $wgCookieDomain,
3017 $wgCookieSecure, $wgCookieHttpOnly, $wgSessionHandler;
3018 if( $wgSessionsInMemcached ) {
3019 if ( !defined( 'MW_COMPILED' ) ) {
3021 require_once( "$IP/includes/cache/MemcachedSessions.php" );
3023 session_set_save_handler( 'memsess_open', 'memsess_close', 'memsess_read',
3024 'memsess_write', 'memsess_destroy', 'memsess_gc' );
3026 // It's necessary to register a shutdown function to call session_write_close(),
3027 // because by the time the request shutdown function for the session module is
3028 // called, $wgMemc has already been destroyed. Shutdown functions registered
3029 // this way are called before object destruction.
3030 register_shutdown_function( 'memsess_write_close' );
3031 } elseif( $wgSessionHandler && $wgSessionHandler != ini_get( 'session.save_handler' ) ) {
3032 # Only set this if $wgSessionHandler isn't null and session.save_handler
3033 # hasn't already been set to the desired value (that causes errors)
3034 ini_set( 'session.save_handler', $wgSessionHandler );
3036 $httpOnlySafe = wfHttpOnlySafe() && $wgCookieHttpOnly;
3037 wfDebugLog( 'cookie',
3038 'session_set_cookie_params: "' . implode( '", "',
3044 $httpOnlySafe ) ) . '"' );
3045 session_set_cookie_params( 0, $wgCookiePath, $wgCookieDomain, $wgCookieSecure, $httpOnlySafe );
3046 session_cache_limiter( 'private, must-revalidate' );
3048 session_id( $sessionId );
3050 wfSuppressWarnings();
3052 wfRestoreWarnings();
3056 * Get an object from the precompiled serialized directory
3058 * @param $name String
3059 * @return Mixed: the variable on success, false on failure
3061 function wfGetPrecompiledData( $name ) {
3064 $file = "$IP/serialized/$name";
3065 if ( file_exists( $file ) ) {
3066 $blob = file_get_contents( $file );
3068 return unserialize( $blob );
3080 function wfMemcKey( /*... */ ) {
3081 $args = func_get_args();
3082 $key = wfWikiID() . ':' . implode( ':', $args );
3083 $key = str_replace( ' ', '_', $key );
3088 * Get a cache key for a foreign DB
3091 * @param $prefix String
3092 * @param varargs String
3095 function wfForeignMemcKey( $db, $prefix /*, ... */ ) {
3096 $args = array_slice( func_get_args(), 2 );
3098 $key = "$db-$prefix:" . implode( ':', $args );
3100 $key = $db . ':' . implode( ':', $args );
3106 * Get an ASCII string identifying this wiki
3107 * This is used as a prefix in memcached keys
3111 function wfWikiID() {
3112 global $wgDBprefix, $wgDBname;
3113 if ( $wgDBprefix ) {
3114 return "$wgDBname-$wgDBprefix";
3121 * Split a wiki ID into DB name and table prefix
3123 * @param $wiki String
3124 * @param $bits String
3126 function wfSplitWikiID( $wiki ) {
3127 $bits = explode( '-', $wiki, 2 );
3128 if ( count( $bits ) < 2 ) {
3135 * Get a Database object.
3137 * @param $db Integer: index of the connection to get. May be DB_MASTER for the
3138 * master (for write queries), DB_SLAVE for potentially lagged read
3139 * queries, or an integer >= 0 for a particular server.
3141 * @param $groups Mixed: query groups. An array of group names that this query
3142 * belongs to. May contain a single string if the query is only
3145 * @param $wiki String: the wiki ID, or false for the current wiki
3147 * Note: multiple calls to wfGetDB(DB_SLAVE) during the course of one request
3148 * will always return the same object, unless the underlying connection or load
3149 * balancer is manually destroyed.
3151 * Note 2: use $this->getDB() in maintenance scripts that may be invoked by
3152 * updater to ensure that a proper database is being updated.
3154 * @return DatabaseBase
3156 function &wfGetDB( $db, $groups = array(), $wiki = false ) {
3157 return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
3161 * Get a load balancer object.
3163 * @param $wiki String: wiki ID, or false for the current wiki
3164 * @return LoadBalancer
3166 function wfGetLB( $wiki = false ) {
3167 return wfGetLBFactory()->getMainLB( $wiki );
3171 * Get the load balancer factory object
3175 function &wfGetLBFactory() {
3176 return LBFactory
::singleton();
3181 * Shortcut for RepoGroup::singleton()->findFile()
3183 * @param $title String or Title object
3184 * @param $options Associative array of options:
3185 * time: requested time for an archived image, or false for the
3186 * current version. An image object will be returned which was
3187 * created at the specified time.
3189 * ignoreRedirect: If true, do not follow file redirects
3191 * private: If true, return restricted (deleted) files if the current
3192 * user is allowed to view them. Otherwise, such files will not
3195 * bypassCache: If true, do not use the process-local cache of File objects
3197 * @return File, or false if the file does not exist
3199 function wfFindFile( $title, $options = array() ) {
3200 return RepoGroup
::singleton()->findFile( $title, $options );
3204 * Get an object referring to a locally registered file.
3205 * Returns a valid placeholder object if the file does not exist.
3207 * @param $title Title or String
3208 * @return File, or null if passed an invalid Title
3210 function wfLocalFile( $title ) {
3211 return RepoGroup
::singleton()->getLocalRepo()->newFile( $title );
3215 * Should low-performance queries be disabled?
3218 * @codeCoverageIgnore
3220 function wfQueriesMustScale() {
3221 global $wgMiserMode;
3223 ||
( SiteStats
::pages() > 100000
3224 && SiteStats
::edits() > 1000000
3225 && SiteStats
::users() > 10000 );
3229 * Get the path to a specified script file, respecting file
3230 * extensions; this is a wrapper around $wgScriptExtension etc.
3232 * @param $script String: script filename, sans extension
3235 function wfScript( $script = 'index' ) {
3236 global $wgScriptPath, $wgScriptExtension;
3237 return "{$wgScriptPath}/{$script}{$wgScriptExtension}";
3241 * Get the script URL.
3243 * @return script URL
3245 function wfGetScriptUrl() {
3246 if( isset( $_SERVER['SCRIPT_NAME'] ) ) {
3248 # as it was called, minus the query string.
3250 # Some sites use Apache rewrite rules to handle subdomains,
3251 # and have PHP set up in a weird way that causes PHP_SELF
3252 # to contain the rewritten URL instead of the one that the
3253 # outside world sees.
3255 # If in this mode, use SCRIPT_URL instead, which mod_rewrite
3256 # provides containing the "before" URL.
3257 return $_SERVER['SCRIPT_NAME'];
3259 return $_SERVER['URL'];
3264 * Convenience function converts boolean values into "true"
3265 * or "false" (string) values
3267 * @param $value Boolean
3270 function wfBoolToStr( $value ) {
3271 return $value ?
'true' : 'false';
3275 * Load an extension messages file
3277 * @deprecated since 1.16, warnings in 1.18, remove in 1.20
3278 * @codeCoverageIgnore
3280 function wfLoadExtensionMessages() {
3281 wfDeprecated( __FUNCTION__
);
3285 * Get a platform-independent path to the null file, e.g. /dev/null
3289 function wfGetNull() {
3290 return wfIsWindows()
3296 * Throws a warning that $function is deprecated
3298 * @param $function String
3301 function wfDeprecated( $function ) {
3302 static $functionsWarned = array();
3303 if ( !isset( $functionsWarned[$function] ) ) {
3304 $functionsWarned[$function] = true;
3305 wfWarn( "Use of $function is deprecated.", 2 );
3310 * Send a warning either to the debug log or in a PHP error depending on
3311 * $wgDevelopmentWarnings
3313 * @param $msg String: message to send
3314 * @param $callerOffset Integer: number of items to go back in the backtrace to
3315 * find the correct caller (1 = function calling wfWarn, ...)
3316 * @param $level Integer: PHP error level; only used when $wgDevelopmentWarnings
3319 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE
) {
3320 global $wgDevelopmentWarnings;
3322 $callers = wfDebugBacktrace();
3323 if ( isset( $callers[$callerOffset +
1] ) ) {
3324 $callerfunc = $callers[$callerOffset +
1];
3325 $callerfile = $callers[$callerOffset];
3326 if ( isset( $callerfile['file'] ) && isset( $callerfile['line'] ) ) {
3327 $file = $callerfile['file'] . ' at line ' . $callerfile['line'];
3329 $file = '(internal function)';
3332 if ( isset( $callerfunc['class'] ) ) {
3333 $func .= $callerfunc['class'] . '::';
3335 if ( isset( $callerfunc['function'] ) ) {
3336 $func .= $callerfunc['function'];
3338 $msg .= " [Called from $func in $file]";
3341 if ( $wgDevelopmentWarnings ) {
3342 trigger_error( $msg, $level );
3344 wfDebug( "$msg\n" );
3349 * Modern version of wfWaitForSlaves(). Instead of looking at replication lag
3350 * and waiting for it to go down, this waits for the slaves to catch up to the
3351 * master position. Use this when updating very large numbers of rows, as
3352 * in maintenance scripts, to avoid causing too much lag. Of course, this is
3353 * a no-op if there are no slaves.
3355 * @param $maxLag Integer (deprecated)
3356 * @param $wiki mixed Wiki identifier accepted by wfGetLB
3359 function wfWaitForSlaves( $maxLag = false, $wiki = false ) {
3360 $lb = wfGetLB( $wiki );
3361 // bug 27975 - Don't try to wait for slaves if there are none
3362 // Prevents permission error when getting master position
3363 if ( $lb->getServerCount() > 1 ) {
3364 $dbw = $lb->getConnection( DB_MASTER
);
3365 $pos = $dbw->getMasterPos();
3366 $lb->waitForAll( $pos );
3371 * Used to be used for outputting text in the installer/updater
3372 * @deprecated since 1.18, warnings in 1.19, remove in 1.20
3374 function wfOut( $s ) {
3375 wfDeprecated( __METHOD__
);
3376 global $wgCommandLineMode;
3377 if ( $wgCommandLineMode && !defined( 'MEDIAWIKI_INSTALL' ) ) {
3380 echo htmlspecialchars( $s );
3386 * Count down from $n to zero on the terminal, with a one-second pause
3387 * between showing each number. For use in command-line scripts.
3388 * @codeCoverageIgnore
3390 function wfCountDown( $n ) {
3391 for ( $i = $n; $i >= 0; $i-- ) {
3393 echo str_repeat( "\x08", strlen( $i +
1 ) );
3405 * Generate a random 32-character hexadecimal token.
3406 * @param $salt Mixed: some sort of salt, if necessary, to add to random
3407 * characters before hashing.
3409 * @codeCoverageIgnore
3411 function wfGenerateToken( $salt = '' ) {
3412 $salt = serialize( $salt );
3413 return md5( mt_rand( 0, 0x7fffffff ) . $salt );
3417 * Replace all invalid characters with -
3419 * @param $name Mixed: filename to process
3422 function wfStripIllegalFilenameChars( $name ) {
3423 global $wgIllegalFileChars;
3424 $name = wfBaseName( $name );
3425 $name = preg_replace(
3426 "/[^" . Title
::legalChars() . "]" .
3427 ( $wgIllegalFileChars ?
"|[" . $wgIllegalFileChars . "]" : '' ) .
3436 * Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit;
3438 * @return Integer value memory was set to.
3440 function wfMemoryLimit() {
3441 global $wgMemoryLimit;
3442 $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
3443 if( $memlimit != -1 ) {
3444 $conflimit = wfShorthandToInteger( $wgMemoryLimit );
3445 if( $conflimit == -1 ) {
3446 wfDebug( "Removing PHP's memory limit\n" );
3447 wfSuppressWarnings();
3448 ini_set( 'memory_limit', $conflimit );
3449 wfRestoreWarnings();
3451 } elseif ( $conflimit > $memlimit ) {
3452 wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
3453 wfSuppressWarnings();
3454 ini_set( 'memory_limit', $conflimit );
3455 wfRestoreWarnings();
3463 * Converts shorthand byte notation to integer form
3465 * @param $string String
3468 function wfShorthandToInteger( $string = '' ) {
3469 $string = trim( $string );
3470 if( $string === '' ) {
3473 $last = $string[strlen( $string ) - 1];
3474 $val = intval( $string );
3479 // break intentionally missing
3483 // break intentionally missing
3493 * Get the normalised IETF language tag
3494 * See unit test for examples.
3496 * @param $code String: The language code.
3497 * @return $langCode String: The language code which complying with BCP 47 standards.
3499 function wfBCP47( $code ) {
3500 $codeSegment = explode( '-', $code );
3502 foreach ( $codeSegment as $segNo => $seg ) {
3503 if ( count( $codeSegment ) > 0 ) {
3504 // when previous segment is x, it is a private segment and should be lc
3505 if( $segNo > 0 && strtolower( $codeSegment[($segNo - 1)] ) == 'x') {
3506 $codeBCP[$segNo] = strtolower( $seg );
3507 // ISO 3166 country code
3508 } elseif ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) {
3509 $codeBCP[$segNo] = strtoupper( $seg );
3510 // ISO 15924 script code
3511 } elseif ( ( strlen( $seg ) == 4 ) && ( $segNo > 0 ) ) {
3512 $codeBCP[$segNo] = ucfirst( strtolower( $seg ) );
3513 // Use lowercase for other cases
3515 $codeBCP[$segNo] = strtolower( $seg );
3518 // Use lowercase for single segment
3519 $codeBCP[$segNo] = strtolower( $seg );
3522 $langCode = implode( '-', $codeBCP );
3527 * Get a cache object.
3529 * @param $inputType integer Cache type, one the the CACHE_* constants.
3532 function wfGetCache( $inputType ) {
3533 return ObjectCache
::getInstance( $inputType );
3537 * Get the main cache object
3541 function wfGetMainCache() {
3542 global $wgMainCacheType;
3543 return ObjectCache
::getInstance( $wgMainCacheType );
3547 * Get the cache object used by the message cache
3551 function wfGetMessageCacheStorage() {
3552 global $wgMessageCacheType;
3553 return ObjectCache
::getInstance( $wgMessageCacheType );
3557 * Get the cache object used by the parser cache
3561 function wfGetParserCacheStorage() {
3562 global $wgParserCacheType;
3563 return ObjectCache
::getInstance( $wgParserCacheType );
3567 * Call hook functions defined in $wgHooks
3569 * @param $event String: event name
3570 * @param $args Array: parameters passed to hook functions
3573 function wfRunHooks( $event, $args = array() ) {
3574 return Hooks
::run( $event, $args );