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 if ( !defined( 'MW_COMPILED' ) ) {
12 require_once( dirname( __FILE__
) . '/normal/UtfNormalUtil.php' );
15 // Hide compatibility functions from Doxygen
19 * Compatibility functions
21 * We support PHP 5.2.3 and up.
22 * Re-implementations of newer functions or functions in non-standard
23 * PHP extensions may be included here.
26 if( !function_exists( 'iconv' ) ) {
27 /** @codeCoverageIgnore */
28 function iconv( $from, $to, $string ) {
29 return Fallback
::iconv( $from, $to, $string );
33 if ( !function_exists( 'mb_substr' ) ) {
34 /** @codeCoverageIgnore */
35 function mb_substr( $str, $start, $count='end' ) {
36 return Fallback
::mb_substr( $str, $start, $count );
39 /** @codeCoverageIgnore */
40 function mb_substr_split_unicode( $str, $splitPos ) {
41 return Fallback
::mb_substr_split_unicode( $str, $splitPos );
45 if ( !function_exists( 'mb_strlen' ) ) {
46 /** @codeCoverageIgnore */
47 function mb_strlen( $str, $enc = '' ) {
48 return Fallback
::mb_strlen( $str, $enc );
52 if( !function_exists( 'mb_strpos' ) ) {
53 /** @codeCoverageIgnore */
54 function mb_strpos( $haystack, $needle, $offset = 0, $encoding = '' ) {
55 return Fallback
::mb_strpos( $haystack, $needle, $offset, $encoding );
60 if( !function_exists( 'mb_strrpos' ) ) {
61 /** @codeCoverageIgnore */
62 function mb_strrpos( $haystack, $needle, $offset = 0, $encoding = '' ) {
63 return Fallback
::mb_strrpos( $haystack, $needle, $offset, $encoding );
68 // Support for Wietse Venema's taint feature
69 if ( !function_exists( 'istainted' ) ) {
70 /** @codeCoverageIgnore */
71 function istainted( $var ) {
74 /** @codeCoverageIgnore */
75 function taint( $var, $level = 0 ) {}
76 /** @codeCoverageIgnore */
77 function untaint( $var, $level = 0 ) {}
78 define( 'TC_HTML', 1 );
79 define( 'TC_SHELL', 1 );
80 define( 'TC_MYSQL', 1 );
81 define( 'TC_PCRE', 1 );
82 define( 'TC_SELF', 1 );
87 * Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
89 function wfArrayDiff2( $a, $b ) {
90 return array_udiff( $a, $b, 'wfArrayDiff2_cmp' );
92 function wfArrayDiff2_cmp( $a, $b ) {
93 if ( !is_array( $a ) ) {
94 return strcmp( $a, $b );
95 } elseif ( count( $a ) !== count( $b ) ) {
96 return count( $a ) < count( $b ) ?
-1 : 1;
100 while( ( list( , $valueA ) = each( $a ) ) && ( list( , $valueB ) = each( $b ) ) ) {
101 $cmp = strcmp( $valueA, $valueB );
111 * Get a random decimal value between 0 and 1, in a way
112 * not likely to give duplicate values for any realistic
113 * number of articles.
117 function wfRandom() {
118 # The maximum random value is "only" 2^31-1, so get two random
119 # values to reduce the chance of dupes
120 $max = mt_getrandmax() +
1;
121 $rand = number_format( ( mt_rand() * $max +
mt_rand() )
122 / $max / $max, 12, '.', '' );
127 * We want some things to be included as literal characters in our title URLs
128 * for prettiness, which urlencode encodes by default. According to RFC 1738,
129 * all of the following should be safe:
133 * But + is not safe because it's used to indicate a space; &= are only safe in
134 * paths and not in queries (and we don't distinguish here); ' seems kind of
135 * scary; and urlencode() doesn't touch -_. to begin with. Plus, although /
136 * is reserved, we don't care. So the list we unescape is:
140 * However, IIS7 redirects fail when the url contains a colon (Bug 22709),
141 * so no fancy : for IIS7.
143 * %2F in the page titles seems to fatally break for some reason.
148 function wfUrlencode( $s ) {
150 if ( is_null( $needle ) ) {
151 $needle = array( '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F' );
152 if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) ||
( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false ) ) {
157 $s = urlencode( $s );
160 array( ';', '@', '$', '!', '*', '(', ')', ',', '/', ':' ),
168 * Sends a line to the debug log if enabled or, optionally, to a comment in output.
169 * In normal operation this is a NOP.
171 * Controlling globals:
172 * $wgDebugLogFile - points to the log file
173 * $wgProfileOnly - if set, normal debug messages will not be recorded.
174 * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
175 * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
177 * @param $text String
178 * @param $logonly Bool: set true to avoid appearing in HTML when $wgDebugComments is set
180 function wfDebug( $text, $logonly = false ) {
181 global $wgOut, $wgDebugLogFile, $wgDebugComments, $wgProfileOnly, $wgDebugRawPage;
182 global $wgDebugLogPrefix, $wgShowDebug;
184 static $cache = array(); // Cache of unoutputted messages
185 $text = wfDebugTimer() . $text;
187 # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
188 if ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' && !$wgDebugRawPage ) {
192 if ( ( $wgDebugComments ||
$wgShowDebug ) && !$logonly ) {
195 if ( isset( $wgOut ) && StubObject
::isRealObject( $wgOut ) ) {
196 // add the message and any cached messages to the output
197 array_map( array( $wgOut, 'debug' ), $cache );
201 if ( $wgDebugLogFile != '' && !$wgProfileOnly ) {
202 # Strip unprintables; they can switch terminal modes when binary data
203 # gets dumped, which is pretty annoying.
204 $text = preg_replace( '![\x00-\x08\x0b\x0c\x0e-\x1f]!', ' ', $text );
205 $text = $wgDebugLogPrefix . $text;
206 wfErrorLog( $text, $wgDebugLogFile );
210 function wfDebugTimer() {
211 global $wgDebugTimestamps;
212 if ( !$wgDebugTimestamps ) {
215 static $start = null;
217 if ( $start === null ) {
218 $start = microtime( true );
219 $prefix = "\n$start";
221 $prefix = sprintf( "%6.4f", microtime( true ) - $start );
224 return $prefix . ' ';
228 * Send a line giving PHP memory usage.
229 * @param $exact Bool: print exact values instead of kilobytes (default: false)
231 function wfDebugMem( $exact = false ) {
232 $mem = memory_get_usage();
234 $mem = floor( $mem / 1024 ) . ' kilobytes';
238 wfDebug( "Memory usage: $mem\n" );
242 * Send a line to a supplementary debug log file, if configured, or main debug log if not.
243 * $wgDebugLogGroups[$logGroup] should be set to a filename to send to a separate log.
245 * @param $logGroup String
246 * @param $text String
247 * @param $public Bool: whether to log the event in the public log if no private
248 * log file is specified, (default true)
250 function wfDebugLog( $logGroup, $text, $public = true ) {
251 global $wgDebugLogGroups, $wgShowHostnames;
252 $text = trim( $text ) . "\n";
253 if( isset( $wgDebugLogGroups[$logGroup] ) ) {
254 $time = wfTimestamp( TS_DB
);
256 if ( $wgShowHostnames ) {
257 $host = wfHostname();
261 wfErrorLog( "$time $host $wiki: $text", $wgDebugLogGroups[$logGroup] );
262 } elseif ( $public === true ) {
263 wfDebug( $text, true );
268 * Log for database errors
269 * @param $text String: database error message.
271 function wfLogDBError( $text ) {
272 global $wgDBerrorLog, $wgDBname;
273 if ( $wgDBerrorLog ) {
274 $host = trim(`hostname`
);
275 $text = date( 'D M j G:i:s T Y' ) . "\t$host\t$wgDBname\t$text";
276 wfErrorLog( $text, $wgDBerrorLog );
281 * Log to a file without getting "file size exceeded" signals.
283 * Can also log to TCP or UDP with the syntax udp://host:port/prefix. This will
284 * send lines to the specified port, prefixed by the specified prefix and a space.
286 function wfErrorLog( $text, $file ) {
287 if ( substr( $file, 0, 4 ) == 'udp:' ) {
288 # Needs the sockets extension
289 if ( preg_match( '!^(tcp|udp):(?://)?\[([0-9a-fA-F:]+)\]:(\d+)(?:/(.*))?$!', $file, $m ) ) {
290 // IPv6 bracketed host
292 $port = intval( $m[3] );
293 $prefix = isset( $m[4] ) ?
$m[4] : false;
295 } elseif ( preg_match( '!^(tcp|udp):(?://)?([a-zA-Z0-9.-]+):(\d+)(?:/(.*))?$!', $file, $m ) ) {
297 if ( !IP
::isIPv4( $host ) ) {
298 $host = gethostbyname( $host );
300 $port = intval( $m[3] );
301 $prefix = isset( $m[4] ) ?
$m[4] : false;
304 throw new MWException( __METHOD__
. ': Invalid UDP specification' );
307 // Clean it up for the multiplexer
308 if ( strval( $prefix ) !== '' ) {
309 $text = preg_replace( '/^/m', $prefix . ' ', $text );
312 if ( strlen( $text ) > 65534 ) {
313 $text = substr( $text, 0, 65534 );
316 if ( substr( $text, -1 ) != "\n" ) {
319 } elseif ( strlen( $text ) > 65535 ) {
320 $text = substr( $text, 0, 65535 );
323 $sock = socket_create( $domain, SOCK_DGRAM
, SOL_UDP
);
327 socket_sendto( $sock, $text, strlen( $text ), 0, $host, $port );
328 socket_close( $sock );
330 wfSuppressWarnings();
331 $exists = file_exists( $file );
332 $size = $exists ?
filesize( $file ) : false;
333 if ( !$exists ||
( $size !== false && $size +
strlen( $text ) < 0x7fffffff ) ) {
334 file_put_contents( $file, $text, FILE_APPEND
);
343 function wfLogProfilingData() {
344 global $wgRequestTime, $wgDebugLogFile, $wgDebugRawPage, $wgRequest;
345 global $wgProfiler, $wgProfileLimit, $wgUser;
346 # Profiling must actually be enabled...
347 if( is_null( $wgProfiler ) ) {
350 # Get total page request time
352 $elapsed = $now - $wgRequestTime;
353 # Only show pages that longer than $wgProfileLimit time (default is 0)
354 if( $elapsed <= $wgProfileLimit ) {
357 $prof = wfGetProfilingOutput( $wgRequestTime, $elapsed );
359 if( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
360 $forward = ' forwarded for ' . $_SERVER['HTTP_X_FORWARDED_FOR'];
362 if( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
363 $forward .= ' client IP ' . $_SERVER['HTTP_CLIENT_IP'];
365 if( !empty( $_SERVER['HTTP_FROM'] ) ) {
366 $forward .= ' from ' . $_SERVER['HTTP_FROM'];
369 $forward = "\t(proxied via {$_SERVER['REMOTE_ADDR']}{$forward})";
371 // Don't unstub $wgUser at this late stage just for statistics purposes
372 // FIXME: We can detect some anons even if it is not loaded. See User::getId()
373 if( $wgUser->mDataLoaded
&& $wgUser->isAnon() ) {
376 $log = sprintf( "%s\t%04.3f\t%s\n",
377 gmdate( 'YmdHis' ), $elapsed,
378 urldecode( $wgRequest->getRequestURL() . $forward ) );
379 if ( $wgDebugLogFile != '' && ( $wgRequest->getVal( 'action' ) != 'raw' ||
$wgDebugRawPage ) ) {
380 wfErrorLog( $log . $prof, $wgDebugLogFile );
385 * Check if the wiki read-only lock file is present. This can be used to lock
386 * off editing functions, but doesn't guarantee that the database will not be
390 function wfReadOnly() {
391 global $wgReadOnlyFile, $wgReadOnly;
393 if ( !is_null( $wgReadOnly ) ) {
394 return (bool)$wgReadOnly;
396 if ( $wgReadOnlyFile == '' ) {
399 // Set $wgReadOnly for faster access next time
400 if ( is_file( $wgReadOnlyFile ) ) {
401 $wgReadOnly = file_get_contents( $wgReadOnlyFile );
405 return (bool)$wgReadOnly;
408 function wfReadOnlyReason() {
415 * Return a Language object from $langcode
416 * @param $langcode Mixed: either:
417 * - a Language object
418 * - code of the language to get the message for, if it is
419 * a valid code create a language for that language, if
420 * it is a string but not a valid code then make a basic
422 * - a boolean: if it's false then use the current users
423 * language (as a fallback for the old parameter
424 * functionality), or if it is true then use the wikis
425 * @return Language object
427 function wfGetLangObj( $langcode = false ) {
428 # Identify which language to get or create a language object for.
429 # Using is_object here due to Stub objects.
430 if( is_object( $langcode ) ) {
431 # Great, we already have the object (hopefully)!
435 global $wgContLang, $wgLanguageCode;
436 if( $langcode === true ||
$langcode === $wgLanguageCode ) {
437 # $langcode is the language code of the wikis content language object.
438 # or it is a boolean and value is true
443 if( $langcode === false ||
$langcode === $wgLang->getCode() ) {
444 # $langcode is the language code of user language object.
445 # or it was a boolean and value is false
449 $validCodes = array_keys( Language
::getLanguageNames() );
450 if( in_array( $langcode, $validCodes ) ) {
451 # $langcode corresponds to a valid language.
452 return Language
::factory( $langcode );
455 # $langcode is a string, but not a valid language code; use content language.
456 wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
461 * Use this instead of $wgContLang, when working with user interface.
462 * User interface is currently hard coded according to wiki content language
463 * in many ways, especially regarding to text direction. There is lots stuff
464 * to fix, hence this function to keep the old behaviour unless the global
465 * $wgBetterDirectionality is enabled (or removed when everything works).
467 function wfUILang() {
468 global $wgBetterDirectionality;
469 return wfGetLangObj( !$wgBetterDirectionality );
473 * This is the new function for getting translated interface messages.
474 * See the Message class for documentation how to use them.
475 * The intention is that this function replaces all old wfMsg* functions.
476 * @param $key \string Message key.
477 * Varargs: normal message parameters.
481 function wfMessage( $key /*...*/) {
482 $params = func_get_args();
483 array_shift( $params );
484 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
485 $params = $params[0];
487 return new Message( $key, $params );
491 * This function accepts multiple message keys and returns a message instance
492 * for the first message which is non-empty. If all messages are empty then an
493 * instance of the first message key is returned.
494 * Varargs: message keys
498 function wfMessageFallback( /*...*/ ) {
499 $args = func_get_args();
500 return MWFunction
::callArray( 'Message::newFallbackSequence', $args );
504 * Get a message from anywhere, for the current user language.
506 * Use wfMsgForContent() instead if the message should NOT
507 * change depending on the user preferences.
509 * @param $key String: lookup key for the message, usually
510 * defined in languages/Language.php
512 * This function also takes extra optional parameters (not
513 * shown in the function definition), which can be used to
514 * insert variable text into the predefined message.
516 function wfMsg( $key ) {
517 $args = func_get_args();
518 array_shift( $args );
519 return wfMsgReal( $key, $args, true );
523 * Same as above except doesn't transform the message
525 function wfMsgNoTrans( $key ) {
526 $args = func_get_args();
527 array_shift( $args );
528 return wfMsgReal( $key, $args, true, false, false );
532 * Get a message from anywhere, for the current global language
533 * set with $wgLanguageCode.
535 * Use this if the message should NOT change dependent on the
536 * language set in the user's preferences. This is the case for
537 * most text written into logs, as well as link targets (such as
538 * the name of the copyright policy page). Link titles, on the
539 * other hand, should be shown in the UI language.
541 * Note that MediaWiki allows users to change the user interface
542 * language in their preferences, but a single installation
543 * typically only contains content in one language.
545 * Be wary of this distinction: If you use wfMsg() where you should
546 * use wfMsgForContent(), a user of the software may have to
547 * customize potentially hundreds of messages in
548 * order to, e.g., fix a link in every possible language.
550 * @param $key String: lookup key for the message, usually
551 * defined in languages/Language.php
553 function wfMsgForContent( $key ) {
554 global $wgForceUIMsgAsContentMsg;
555 $args = func_get_args();
556 array_shift( $args );
558 if( is_array( $wgForceUIMsgAsContentMsg ) &&
559 in_array( $key, $wgForceUIMsgAsContentMsg ) )
563 return wfMsgReal( $key, $args, true, $forcontent );
567 * Same as above except doesn't transform the message
569 function wfMsgForContentNoTrans( $key ) {
570 global $wgForceUIMsgAsContentMsg;
571 $args = func_get_args();
572 array_shift( $args );
574 if( is_array( $wgForceUIMsgAsContentMsg ) &&
575 in_array( $key, $wgForceUIMsgAsContentMsg ) )
579 return wfMsgReal( $key, $args, true, $forcontent, false );
583 * Get a message from the language file, for the UI elements
585 function wfMsgNoDB( $key ) {
586 $args = func_get_args();
587 array_shift( $args );
588 return wfMsgReal( $key, $args, false );
592 * Get a message from the language file, for the content
594 * @deprecated in 1.18; use wfMessage()
596 function wfMsgNoDBForContent( $key ) {
597 wfDeprecated( __FUNCTION__
);
598 global $wgForceUIMsgAsContentMsg;
599 $args = func_get_args();
600 array_shift( $args );
602 if( is_array( $wgForceUIMsgAsContentMsg ) &&
603 in_array( $key, $wgForceUIMsgAsContentMsg ) )
607 return wfMsgReal( $key, $args, false, $forcontent );
612 * Really get a message
613 * @param $key String: key to get.
615 * @param $useDB Boolean
616 * @param $forContent Mixed: Language code, or false for user lang, true for content lang.
617 * @param $transform Boolean: Whether or not to transform the message.
618 * @return String: the requested message.
620 function wfMsgReal( $key, $args, $useDB = true, $forContent = false, $transform = true ) {
621 wfProfileIn( __METHOD__
);
622 $message = wfMsgGetKey( $key, $useDB, $forContent, $transform );
623 $message = wfMsgReplaceArgs( $message, $args );
624 wfProfileOut( __METHOD__
);
629 * This function provides the message source for messages to be edited which are *not* stored in the database.
631 * @deprecated in 1.18; use wfMessage()
634 function wfMsgWeirdKey( $key ) {
635 wfDeprecated( __FUNCTION__
);
636 $source = wfMsgGetKey( $key, false, true, false );
637 if ( wfEmptyMsg( $key ) ) {
645 * Fetch a message string value, but don't replace any keys yet.
648 * @param $langCode String: Code of the language to get the message for, or
649 * behaves as a content language switch if it is a boolean.
650 * @param $transform Boolean: whether to parse magic words, etc.
653 function wfMsgGetKey( $key, $useDB, $langCode = false, $transform = true ) {
654 wfRunHooks( 'NormalizeMessageKey', array( &$key, &$useDB, &$langCode, &$transform ) );
656 $cache = MessageCache
::singleton();
657 $message = $cache->get( $key, $useDB, $langCode );
658 if( $message === false ) {
659 $message = '<' . htmlspecialchars( $key ) . '>';
660 } elseif ( $transform ) {
661 $message = $cache->transform( $message );
667 * Replace message parameter keys on the given formatted output.
669 * @param $message String
674 function wfMsgReplaceArgs( $message, $args ) {
675 # Fix windows line-endings
676 # Some messages are split with explode("\n", $msg)
677 $message = str_replace( "\r", '', $message );
680 if ( count( $args ) ) {
681 if ( is_array( $args[0] ) ) {
682 $args = array_values( $args[0] );
684 $replacementKeys = array();
685 foreach( $args as $n => $param ) {
686 $replacementKeys['$' . ( $n +
1 )] = $param;
688 $message = strtr( $message, $replacementKeys );
695 * Return an HTML-escaped version of a message.
696 * Parameter replacements, if any, are done *after* the HTML-escaping,
697 * so parameters may contain HTML (eg links or form controls). Be sure
698 * to pre-escape them if you really do want plaintext, or just wrap
699 * the whole thing in htmlspecialchars().
702 * @param string ... parameters
705 function wfMsgHtml( $key ) {
706 $args = func_get_args();
707 array_shift( $args );
708 return wfMsgReplaceArgs( htmlspecialchars( wfMsgGetKey( $key, true ) ), $args );
712 * Return an HTML version of message
713 * Parameter replacements, if any, are done *after* parsing the wiki-text message,
714 * so parameters may contain HTML (eg links or form controls). Be sure
715 * to pre-escape them if you really do want plaintext, or just wrap
716 * the whole thing in htmlspecialchars().
719 * @param string ... parameters
722 function wfMsgWikiHtml( $key ) {
723 $args = func_get_args();
724 array_shift( $args );
725 return wfMsgReplaceArgs(
726 MessageCache
::singleton()->parse( wfMsgGetKey( $key, true ), $key, /* can't be set to false */ true )->getText(),
731 * Returns message in the requested format
732 * @param $key String: key of the message
733 * @param $options Array: processing rules. Can take the following options:
734 * <i>parse</i>: parses wikitext to HTML
735 * <i>parseinline</i>: parses wikitext to HTML and removes the surrounding
736 * p's added by parser or tidy
737 * <i>escape</i>: filters message through htmlspecialchars
738 * <i>escapenoentities</i>: same, but allows entity references like   through
739 * <i>replaceafter</i>: parameters are substituted after parsing or escaping
740 * <i>parsemag</i>: transform the message using magic phrases
741 * <i>content</i>: fetch message for content language instead of interface
742 * Also can accept a single associative argument, of the form 'language' => 'xx':
743 * <i>language</i>: Language object or language code to fetch message for
744 * (overriden by <i>content</i>), its behaviour with parse, parseinline
745 * and parsemag is undefined.
746 * Behavior for conflicting options (e.g., parse+parseinline) is undefined.
748 function wfMsgExt( $key, $options ) {
749 $args = func_get_args();
750 array_shift( $args );
751 array_shift( $args );
752 $options = (array)$options;
754 foreach( $options as $arrayKey => $option ) {
755 if( !preg_match( '/^[0-9]+|language$/', $arrayKey ) ) {
756 # An unknown index, neither numeric nor "language"
757 wfWarn( "wfMsgExt called with incorrect parameter key $arrayKey", 1, E_USER_WARNING
);
758 } elseif( preg_match( '/^[0-9]+$/', $arrayKey ) && !in_array( $option,
759 array( 'parse', 'parseinline', 'escape', 'escapenoentities',
760 'replaceafter', 'parsemag', 'content' ) ) ) {
761 # A numeric index with unknown value
762 wfWarn( "wfMsgExt called with incorrect parameter $option", 1, E_USER_WARNING
);
766 if( in_array( 'content', $options, true ) ) {
770 } elseif( array_key_exists( 'language', $options ) ) {
772 $langCode = wfGetLangObj( $options['language'] );
773 $langCodeObj = $langCode;
780 $string = wfMsgGetKey( $key, /*DB*/true, $langCode, /*Transform*/false );
782 if( !in_array( 'replaceafter', $options, true ) ) {
783 $string = wfMsgReplaceArgs( $string, $args );
786 $messageCache = MessageCache
::singleton();
787 if( in_array( 'parse', $options, true ) ) {
788 $string = $messageCache->parse( $string, $key, true, !$forContent, $langCodeObj )->getText();
789 } elseif ( in_array( 'parseinline', $options, true ) ) {
790 $string = $messageCache->parse( $string, $key, true, !$forContent, $langCodeObj )->getText();
792 if( preg_match( '/^<p>(.*)\n?<\/p>\n?$/sU', $string, $m ) ) {
795 } elseif ( in_array( 'parsemag', $options, true ) ) {
796 $string = $messageCache->transform( $string,
797 !$forContent, $langCodeObj );
800 if ( in_array( 'escape', $options, true ) ) {
801 $string = htmlspecialchars ( $string );
802 } elseif ( in_array( 'escapenoentities', $options, true ) ) {
803 $string = Sanitizer
::escapeHtmlAllowEntities( $string );
806 if( in_array( 'replaceafter', $options, true ) ) {
807 $string = wfMsgReplaceArgs( $string, $args );
815 * Just like exit() but makes a note of it.
816 * Commits open transactions except if the error parameter is set
818 * @deprecated Please return control to the caller or throw an exception. Will
819 * be removed in 1.19.
821 function wfAbruptExit( $error = false ) {
822 static $called = false;
828 wfDeprecated( __FUNCTION__
);
829 $bt = wfDebugBacktrace();
831 for( $i = 0; $i < count( $bt ); $i++
) {
832 $file = isset( $bt[$i]['file'] ) ?
$bt[$i]['file'] : 'unknown';
833 $line = isset( $bt[$i]['line'] ) ?
$bt[$i]['line'] : 'unknown';
834 wfDebug( "WARNING: Abrupt exit in $file at line $line\n");
837 wfDebug( "WARNING: Abrupt exit\n" );
840 wfLogProfilingData();
843 wfGetLB()->closeAll();
849 * @deprecated Please return control the caller or throw an exception. Will
850 * be removed in 1.19.
852 function wfErrorExit() {
853 wfDeprecated( __FUNCTION__
);
854 wfAbruptExit( true );
858 * Print an error message and die, returning nonzero to the shell if any. Plain die()
859 * fails to return nonzero to the shell if you pass a string. Entry points may customise
860 * this function to return a prettier error message, but implementations must not assume
861 * access to any of the usual MediaWiki infrastructure (AutoLoader, localisation, database,
862 * etc). This should not be called directly once $wgFullyInitialised is set; instead,
863 * throw an exception and let Exception.php handle whether or not it's possible to show
867 if( !function_exists( 'wfDie' ) ){
868 function wfDie( $msg = '' ) {
875 * Throw a debugging exception. This function previously once exited the process,
876 * but now throws an exception instead, with similar results.
878 * @param $msg String: message shown when dieing.
880 function wfDebugDieBacktrace( $msg = '' ) {
881 throw new MWException( $msg );
885 * Fetch server name for use in error reporting etc.
886 * Use real server name if available, so we know which machine
887 * in a server farm generated the current page.
890 function wfHostname() {
892 if ( is_null( $host ) ) {
893 if ( function_exists( 'posix_uname' ) ) {
894 // This function not present on Windows
895 $uname = @posix_uname
();
899 if( is_array( $uname ) && isset( $uname['nodename'] ) ) {
900 $host = $uname['nodename'];
901 } elseif ( getenv( 'COMPUTERNAME' ) ) {
902 # Windows computer name
903 $host = getenv( 'COMPUTERNAME' );
905 # This may be a virtual server.
906 $host = $_SERVER['SERVER_NAME'];
913 * Returns a HTML comment with the elapsed time since request.
914 * This method has no side effects.
917 function wfReportTime() {
918 global $wgRequestTime, $wgShowHostnames;
921 $elapsed = $now - $wgRequestTime;
923 return $wgShowHostnames
924 ?
sprintf( '<!-- Served by %s in %01.3f secs. -->', wfHostname(), $elapsed )
925 : sprintf( '<!-- Served in %01.3f secs. -->', $elapsed );
929 * Safety wrapper for debug_backtrace().
931 * With Zend Optimizer 3.2.0 loaded, this causes segfaults under somewhat
932 * murky circumstances, which may be triggered in part by stub objects
933 * or other fancy talkin'.
935 * Will return an empty array if Zend Optimizer is detected or if
936 * debug_backtrace is disabled, otherwise the output from
937 * debug_backtrace() (trimmed).
939 * @return array of backtrace information
941 function wfDebugBacktrace() {
942 static $disabled = null;
944 if( extension_loaded( 'Zend Optimizer' ) ) {
945 wfDebug( "Zend Optimizer detected; skipping debug_backtrace for safety.\n" );
949 if ( is_null( $disabled ) ) {
951 $functions = explode( ',', ini_get( 'disable_functions' ) );
952 $functions = array_map( 'trim', $functions );
953 $functions = array_map( 'strtolower', $functions );
954 if ( in_array( 'debug_backtrace', $functions ) ) {
955 wfDebug( "debug_backtrace is in disabled_functions\n" );
963 return array_slice( debug_backtrace(), 1 );
966 function wfBacktrace() {
967 global $wgCommandLineMode;
969 if ( $wgCommandLineMode ) {
974 $backtrace = wfDebugBacktrace();
975 foreach( $backtrace as $call ) {
976 if( isset( $call['file'] ) ) {
977 $f = explode( DIRECTORY_SEPARATOR
, $call['file'] );
978 $file = $f[count( $f ) - 1];
982 if( isset( $call['line'] ) ) {
983 $line = $call['line'];
987 if ( $wgCommandLineMode ) {
988 $msg .= "$file line $line calls ";
990 $msg .= '<li>' . $file . ' line ' . $line . ' calls ';
992 if( !empty( $call['class'] ) ) {
993 $msg .= $call['class'] . '::';
995 $msg .= $call['function'] . '()';
997 if ( $wgCommandLineMode ) {
1003 if ( $wgCommandLineMode ) {
1013 /* Some generic result counters, pulled out of SearchEngine */
1019 function wfShowingResults( $offset, $limit ) {
1023 array( 'parseinline' ),
1024 $wgLang->formatNum( $limit ),
1025 $wgLang->formatNum( $offset +
1 )
1032 function wfShowingResultsNum( $offset, $limit, $num ) {
1035 'showingresultsnum',
1036 array( 'parseinline' ),
1037 $wgLang->formatNum( $limit ),
1038 $wgLang->formatNum( $offset +
1 ),
1039 $wgLang->formatNum( $num )
1044 * Generate (prev x| next x) (20|50|100...) type links for paging
1045 * @param $offset String
1046 * @param $limit Integer
1047 * @param $link String
1048 * @param $query String: optional URL query parameter string
1049 * @param $atend Bool: optional param for specified if this is the last page
1051 function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) {
1053 $fmtLimit = $wgLang->formatNum( $limit );
1054 // FIXME: Why on earth this needs one message for the text and another one for tooltip??
1055 # Get prev/next link display text
1056 $prev = wfMsgExt( 'prevn', array( 'parsemag', 'escape' ), $fmtLimit );
1057 $next = wfMsgExt( 'nextn', array( 'parsemag', 'escape' ), $fmtLimit );
1058 # Get prev/next link title text
1059 $pTitle = wfMsgExt( 'prevn-title', array( 'parsemag', 'escape' ), $fmtLimit );
1060 $nTitle = wfMsgExt( 'nextn-title', array( 'parsemag', 'escape' ), $fmtLimit );
1061 # Fetch the title object
1062 if( is_object( $link ) ) {
1065 $title = Title
::newFromText( $link );
1066 if( is_null( $title ) ) {
1070 # Make 'previous' link
1071 if( 0 != $offset ) {
1072 $po = $offset - $limit;
1073 $po = max( $po, 0 );
1074 $q = "limit={$limit}&offset={$po}";
1075 if( $query != '' ) {
1078 $plink = '<a href="' . $title->escapeLocalURL( $q ) . "\" title=\"{$pTitle}\" class=\"mw-prevlink\">{$prev}</a>";
1083 $no = $offset +
$limit;
1084 $q = "limit={$limit}&offset={$no}";
1085 if( $query != '' ) {
1091 $nlink = '<a href="' . $title->escapeLocalURL( $q ) . "\" title=\"{$nTitle}\" class=\"mw-nextlink\">{$next}</a>";
1093 # Make links to set number of items per page
1094 $nums = $wgLang->pipeList( array(
1095 wfNumLink( $offset, 20, $title, $query ),
1096 wfNumLink( $offset, 50, $title, $query ),
1097 wfNumLink( $offset, 100, $title, $query ),
1098 wfNumLink( $offset, 250, $title, $query ),
1099 wfNumLink( $offset, 500, $title, $query )
1101 return wfMsgHtml( 'viewprevnext', $plink, $nlink, $nums );
1105 * Generate links for (20|50|100...) items-per-page links
1106 * @param $offset String
1107 * @param $limit Integer
1108 * @param $title Title
1109 * @param $query String: optional URL query parameter string
1111 function wfNumLink( $offset, $limit, $title, $query = '' ) {
1113 if( $query == '' ) {
1118 $q .= "limit={$limit}&offset={$offset}";
1119 $fmtLimit = $wgLang->formatNum( $limit );
1120 $lTitle = wfMsgExt( 'shown-title', array( 'parsemag', 'escape' ), $limit );
1121 $s = '<a href="' . $title->escapeLocalURL( $q ) . "\" title=\"{$lTitle}\" class=\"mw-numlink\">{$fmtLimit}</a>";
1127 * @todo FIXME: we may want to blacklist some broken browsers
1129 * @return bool Whereas client accept gzip compression
1131 function wfClientAcceptsGzip( $force = false ) {
1132 static $result = null;
1133 if ( $result === null ||
$force ) {
1135 if( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
1136 # FIXME: we may want to blacklist some broken browsers
1139 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
1140 $_SERVER['HTTP_ACCEPT_ENCODING'],
1144 if( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
1148 wfDebug( " accepts gzip\n" );
1157 * Obtain the offset and limit values from the request string;
1158 * used in special pages
1160 * @param $deflimit Default limit if none supplied
1161 * @param $optionname Name of a user preference to check against
1165 function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
1167 return $wgRequest->getLimitOffset( $deflimit, $optionname );
1171 * Escapes the given text so that it may be output using addWikiText()
1172 * without any linking, formatting, etc. making its way through. This
1173 * is achieved by substituting certain characters with HTML entities.
1174 * As required by the callers, <nowiki> is not used.
1176 * @param $text String: text to be escaped
1178 function wfEscapeWikiText( $text ) {
1179 $text = strtr( "\n$text", array(
1180 '"' => '"', '&' => '&', "'" => ''', '<' => '<',
1181 '=' => '=', '>' => '>', '[' => '[', ']' => ']',
1182 '{' => '{', '|' => '|', '}' => '}',
1183 "\n#" => "\n#", "\n*" => "\n*",
1184 "\n:" => "\n:", "\n;" => "\n;",
1185 '://' => '://', 'ISBN ' => 'ISBN ', 'RFC ' => 'RFC ',
1187 return substr( $text, 1 );
1195 return microtime( true );
1199 * Sets dest to source and returns the original value of dest
1200 * If source is NULL, it just returns the value, it doesn't set the variable
1201 * If force is true, it will set the value even if source is NULL
1203 function wfSetVar( &$dest, $source, $force = false ) {
1205 if ( !is_null( $source ) ||
$force ) {
1212 * As for wfSetVar except setting a bit
1214 function wfSetBit( &$dest, $bit, $state = true ) {
1215 $temp = (bool)( $dest & $bit );
1216 if ( !is_null( $state ) ) {
1227 * This function takes two arrays as input, and returns a CGI-style string, e.g.
1228 * "days=7&limit=100". Options in the first array override options in the second.
1229 * Options set to "" will not be output.
1231 function wfArrayToCGI( $array1, $array2 = null ) {
1232 if ( !is_null( $array2 ) ) {
1233 $array1 = $array1 +
$array2;
1237 foreach ( $array1 as $key => $value ) {
1238 if ( $value !== '' ) {
1242 if ( is_array( $value ) ) {
1244 foreach ( $value as $v ) {
1245 $cgi .= ( $firstTime ?
'' : '&') .
1246 urlencode( $key . '[]' ) . '=' .
1251 if ( is_object( $value ) ) {
1252 $value = $value->__toString();
1254 $cgi .= urlencode( $key ) . '=' .
1255 urlencode( $value );
1263 * This is the logical opposite of wfArrayToCGI(): it accepts a query string as
1264 * its argument and returns the same string in array form. This allows compa-
1265 * tibility with legacy functions that accept raw query strings instead of nice
1266 * arrays. Of course, keys and values are urldecode()d. Don't try passing in-
1267 * valid query strings, or it will explode.
1269 * @param $query String: query string
1270 * @return array Array version of input
1272 function wfCgiToArray( $query ) {
1273 if( isset( $query[0] ) && $query[0] == '?' ) {
1274 $query = substr( $query, 1 );
1276 $bits = explode( '&', $query );
1278 foreach( $bits as $bit ) {
1282 list( $key, $value ) = explode( '=', $bit );
1283 $key = urldecode( $key );
1284 $value = urldecode( $value );
1285 $ret[$key] = $value;
1291 * Append a query string to an existing URL, which may or may not already
1292 * have query string parameters already. If so, they will be combined.
1294 * @param $url String
1295 * @param $query Mixed: string or associative array
1298 function wfAppendQuery( $url, $query ) {
1299 if ( is_array( $query ) ) {
1300 $query = wfArrayToCGI( $query );
1302 if( $query != '' ) {
1303 if( false === strpos( $url, '?' ) ) {
1314 * Expand a potentially local URL to a fully-qualified URL. Assumes $wgServer
1315 * and $wgProto are correct.
1317 * @todo this won't work with current-path-relative URLs
1318 * like "subdir/foo.html", etc.
1320 * @param $url String: either fully-qualified or a local path + query
1321 * @return string Fully-qualified URL
1323 function wfExpandUrl( $url ) {
1324 if( substr( $url, 0, 2 ) == '//' ) {
1326 return $wgProto . ':' . $url;
1327 } elseif( substr( $url, 0, 1 ) == '/' ) {
1329 return $wgServer . $url;
1336 * Windows-compatible version of escapeshellarg()
1337 * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
1338 * function puts single quotes in regardless of OS.
1340 * Also fixes the locale problems on Linux in PHP 5.2.6+ (bug backported to
1341 * earlier distro releases of PHP)
1343 function wfEscapeShellArg( ) {
1344 wfInitShellLocale();
1346 $args = func_get_args();
1349 foreach ( $args as $arg ) {
1356 if ( wfIsWindows() ) {
1357 // Escaping for an MSVC-style command line parser and CMD.EXE
1359 // * http://web.archive.org/web/20020708081031/http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
1360 // * http://technet.microsoft.com/en-us/library/cc723564.aspx
1363 // Double the backslashes before any double quotes. Escape the double quotes.
1364 $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE
);
1367 foreach ( $tokens as $token ) {
1368 if ( $iteration %
2 == 1 ) {
1369 // Delimiter, a double quote preceded by zero or more slashes
1370 $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
1371 } elseif ( $iteration %
4 == 2 ) {
1372 // ^ in $token will be outside quotes, need to be escaped
1373 $arg .= str_replace( '^', '^^', $token );
1374 } else { // $iteration % 4 == 0
1375 // ^ in $token will appear inside double quotes, so leave as is
1380 // Double the backslashes before the end of the string, because
1381 // we will soon add a quote
1383 if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
1384 $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
1387 // Add surrounding quotes
1388 $retVal .= '"' . $arg . '"';
1390 $retVal .= escapeshellarg( $arg );
1397 * wfMerge attempts to merge differences between three texts.
1398 * Returns true for a clean merge and false for failure or a conflict.
1400 function wfMerge( $old, $mine, $yours, &$result ) {
1403 # This check may also protect against code injection in
1404 # case of broken installations.
1405 wfSuppressWarnings();
1406 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
1407 wfRestoreWarnings();
1410 wfDebug( "diff3 not found\n" );
1414 # Make temporary files
1416 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
1417 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
1418 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
1420 fwrite( $oldtextFile, $old );
1421 fclose( $oldtextFile );
1422 fwrite( $mytextFile, $mine );
1423 fclose( $mytextFile );
1424 fwrite( $yourtextFile, $yours );
1425 fclose( $yourtextFile );
1427 # Check for a conflict
1428 $cmd = $wgDiff3 . ' -a --overlap-only ' .
1429 wfEscapeShellArg( $mytextName ) . ' ' .
1430 wfEscapeShellArg( $oldtextName ) . ' ' .
1431 wfEscapeShellArg( $yourtextName );
1432 $handle = popen( $cmd, 'r' );
1434 if( fgets( $handle, 1024 ) ) {
1442 $cmd = $wgDiff3 . ' -a -e --merge ' .
1443 wfEscapeShellArg( $mytextName, $oldtextName, $yourtextName );
1444 $handle = popen( $cmd, 'r' );
1447 $data = fread( $handle, 8192 );
1448 if ( strlen( $data ) == 0 ) {
1454 unlink( $mytextName );
1455 unlink( $oldtextName );
1456 unlink( $yourtextName );
1458 if ( $result === '' && $old !== '' && !$conflict ) {
1459 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
1466 * Returns unified plain-text diff of two texts.
1467 * Useful for machine processing of diffs.
1468 * @param $before String: the text before the changes.
1469 * @param $after String: the text after the changes.
1470 * @param $params String: command-line options for the diff command.
1471 * @return String: unified diff of $before and $after
1473 function wfDiff( $before, $after, $params = '-u' ) {
1474 if ( $before == $after ) {
1479 wfSuppressWarnings();
1480 $haveDiff = $wgDiff && file_exists( $wgDiff );
1481 wfRestoreWarnings();
1483 # This check may also protect against code injection in
1484 # case of broken installations.
1486 wfDebug( "diff executable not found\n" );
1487 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
1488 $format = new UnifiedDiffFormatter();
1489 return $format->format( $diffs );
1492 # Make temporary files
1494 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
1495 $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
1497 fwrite( $oldtextFile, $before );
1498 fclose( $oldtextFile );
1499 fwrite( $newtextFile, $after );
1500 fclose( $newtextFile );
1502 // Get the diff of the two files
1503 $cmd = "$wgDiff " . $params . ' ' . wfEscapeShellArg( $oldtextName, $newtextName );
1505 $h = popen( $cmd, 'r' );
1510 $data = fread( $h, 8192 );
1511 if ( strlen( $data ) == 0 ) {
1519 unlink( $oldtextName );
1520 unlink( $newtextName );
1522 // Kill the --- and +++ lines. They're not useful.
1523 $diff_lines = explode( "\n", $diff );
1524 if ( strpos( $diff_lines[0], '---' ) === 0 ) {
1525 unset( $diff_lines[0] );
1527 if ( strpos( $diff_lines[1], '+++' ) === 0 ) {
1528 unset( $diff_lines[1] );
1531 $diff = implode( "\n", $diff_lines );
1537 * A wrapper around the PHP function var_export().
1538 * Either print it or add it to the regular output ($wgOut).
1540 * @param $var A PHP variable to dump.
1542 function wfVarDump( $var ) {
1544 $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
1545 if ( headers_sent() ||
!@is_object
( $wgOut ) ) {
1548 $wgOut->addHTML( $s );
1553 * Provide a simple HTTP error.
1555 function wfHttpError( $code, $label, $desc ) {
1558 header( "HTTP/1.0 $code $label" );
1559 header( "Status: $code $label" );
1560 $wgOut->sendCacheControl();
1562 header( 'Content-type: text/html; charset=utf-8' );
1563 print "<!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML 2.0//EN\">".
1564 '<html><head><title>' .
1565 htmlspecialchars( $label ) .
1566 '</title></head><body><h1>' .
1567 htmlspecialchars( $label ) .
1569 nl2br( htmlspecialchars( $desc ) ) .
1570 "</p></body></html>\n";
1574 * Clear away any user-level output buffers, discarding contents.
1576 * Suitable for 'starting afresh', for instance when streaming
1577 * relatively large amounts of data without buffering, or wanting to
1578 * output image files without ob_gzhandler's compression.
1580 * The optional $resetGzipEncoding parameter controls suppression of
1581 * the Content-Encoding header sent by ob_gzhandler; by default it
1582 * is left. See comments for wfClearOutputBuffers() for why it would
1585 * Note that some PHP configuration options may add output buffer
1586 * layers which cannot be removed; these are left in place.
1588 * @param $resetGzipEncoding Bool
1590 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
1591 if( $resetGzipEncoding ) {
1592 // Suppress Content-Encoding and Content-Length
1593 // headers from 1.10+s wfOutputHandler
1594 global $wgDisableOutputCompression;
1595 $wgDisableOutputCompression = true;
1597 while( $status = ob_get_status() ) {
1598 if( $status['type'] == 0 /* PHP_OUTPUT_HANDLER_INTERNAL */ ) {
1599 // Probably from zlib.output_compression or other
1600 // PHP-internal setting which can't be removed.
1602 // Give up, and hope the result doesn't break
1606 if( !ob_end_clean() ) {
1607 // Could not remove output buffer handler; abort now
1608 // to avoid getting in some kind of infinite loop.
1611 if( $resetGzipEncoding ) {
1612 if( $status['name'] == 'ob_gzhandler' ) {
1613 // Reset the 'Content-Encoding' field set by this handler
1614 // so we can start fresh.
1615 if ( function_exists( 'header_remove' ) ) {
1616 // Available since PHP 5.3.0
1617 header_remove( 'Content-Encoding' );
1619 // We need to provide a valid content-coding. See bug 28069
1620 header( 'Content-Encoding: identity' );
1629 * More legible than passing a 'false' parameter to wfResetOutputBuffers():
1631 * Clear away output buffers, but keep the Content-Encoding header
1632 * produced by ob_gzhandler, if any.
1634 * This should be used for HTTP 304 responses, where you need to
1635 * preserve the Content-Encoding header of the real result, but
1636 * also need to suppress the output of ob_gzhandler to keep to spec
1637 * and avoid breaking Firefox in rare cases where the headers and
1638 * body are broken over two packets.
1640 function wfClearOutputBuffers() {
1641 wfResetOutputBuffers( false );
1645 * Converts an Accept-* header into an array mapping string values to quality
1648 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
1649 # No arg means accept anything (per HTTP spec)
1651 return array( $def => 1.0 );
1656 $parts = explode( ',', $accept );
1658 foreach( $parts as $part ) {
1659 # FIXME: doesn't deal with params like 'text/html; level=1'
1660 @list
( $value, $qpart ) = explode( ';', trim( $part ) );
1662 if( !isset( $qpart ) ) {
1663 $prefs[$value] = 1.0;
1664 } elseif( preg_match( '/q\s*=\s*(\d*\.\d+)/', $qpart, $match ) ) {
1665 $prefs[$value] = floatval( $match[1] );
1673 * Checks if a given MIME type matches any of the keys in the given
1674 * array. Basic wildcards are accepted in the array keys.
1676 * Returns the matching MIME type (or wildcard) if a match, otherwise
1679 * @param $type String
1680 * @param $avail Array
1684 function mimeTypeMatch( $type, $avail ) {
1685 if( array_key_exists( $type, $avail ) ) {
1688 $parts = explode( '/', $type );
1689 if( array_key_exists( $parts[0] . '/*', $avail ) ) {
1690 return $parts[0] . '/*';
1691 } elseif( array_key_exists( '*/*', $avail ) ) {
1700 * Returns the 'best' match between a client's requested internet media types
1701 * and the server's list of available types. Each list should be an associative
1702 * array of type to preference (preference is a float between 0.0 and 1.0).
1703 * Wildcards in the types are acceptable.
1705 * @param $cprefs Array: client's acceptable type list
1706 * @param $sprefs Array: server's offered types
1709 * @todo FIXME: doesn't handle params like 'text/plain; charset=UTF-8'
1710 * XXX: generalize to negotiate other stuff
1712 function wfNegotiateType( $cprefs, $sprefs ) {
1715 foreach( array_keys($sprefs) as $type ) {
1716 $parts = explode( '/', $type );
1717 if( $parts[1] != '*' ) {
1718 $ckey = mimeTypeMatch( $type, $cprefs );
1720 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1725 foreach( array_keys( $cprefs ) as $type ) {
1726 $parts = explode( '/', $type );
1727 if( $parts[1] != '*' && !array_key_exists( $type, $sprefs ) ) {
1728 $skey = mimeTypeMatch( $type, $sprefs );
1730 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1738 foreach( array_keys( $combine ) as $type ) {
1739 if( $combine[$type] > $bestq ) {
1741 $bestq = $combine[$type];
1750 * Returns an array where the values in the first array are replaced by the
1751 * values in the second array with the corresponding keys
1755 function wfArrayLookup( $a, $b ) {
1756 return array_flip( array_intersect( array_flip( $a ), array_keys( $b ) ) );
1760 * Convenience function; returns MediaWiki timestamp for the present time.
1763 function wfTimestampNow() {
1765 return wfTimestamp( TS_MW
, time() );
1769 * Reference-counted warning suppression
1771 function wfSuppressWarnings( $end = false ) {
1772 static $suppressCount = 0;
1773 static $originalLevel = false;
1776 if ( $suppressCount ) {
1778 if ( !$suppressCount ) {
1779 error_reporting( $originalLevel );
1783 if ( !$suppressCount ) {
1784 // E_DEPRECATED is undefined in PHP 5.2
1785 if( !defined( 'E_DEPRECATED' ) ){
1786 define( 'E_DEPRECATED', 8192 );
1788 $originalLevel = error_reporting( E_ALL
& ~
( E_WARNING | E_NOTICE | E_USER_WARNING | E_USER_NOTICE | E_DEPRECATED
) );
1795 * Restore error level to previous value
1797 function wfRestoreWarnings() {
1798 wfSuppressWarnings( true );
1801 # Autodetect, convert and provide timestamps of various types
1804 * Unix time - the number of seconds since 1970-01-01 00:00:00 UTC
1806 define( 'TS_UNIX', 0 );
1809 * MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
1811 define( 'TS_MW', 1 );
1814 * MySQL DATETIME (YYYY-MM-DD HH:MM:SS)
1816 define( 'TS_DB', 2 );
1819 * RFC 2822 format, for E-mail and HTTP headers
1821 define( 'TS_RFC2822', 3 );
1824 * ISO 8601 format with no timezone: 1986-02-09T20:00:00Z
1826 * This is used by Special:Export
1828 define( 'TS_ISO_8601', 4 );
1831 * An Exif timestamp (YYYY:MM:DD HH:MM:SS)
1833 * @see http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the
1834 * DateTime tag and page 36 for the DateTimeOriginal and
1835 * DateTimeDigitized tags.
1837 define( 'TS_EXIF', 5 );
1840 * Oracle format time.
1842 define( 'TS_ORACLE', 6 );
1845 * Postgres format time.
1847 define( 'TS_POSTGRES', 7 );
1852 define( 'TS_DB2', 8 );
1855 * ISO 8601 basic format with no timezone: 19860209T200000Z
1857 * This is used by ResourceLoader
1859 define( 'TS_ISO_8601_BASIC', 9 );
1862 * @param $outputtype Mixed: A timestamp in one of the supported formats, the
1863 * function will autodetect which format is supplied and act
1865 * @param $ts Mixed: the timestamp to convert or 0 for the current timestamp
1866 * @return Mixed: String / false The same date in the format specified in $outputtype or false
1868 function wfTimestamp( $outputtype = TS_UNIX
, $ts = 0 ) {
1873 if ( !$ts ) { // We want to catch 0, '', null... but not date strings starting with a letter.
1876 } elseif ( preg_match( '/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)$/D', $ts, $da ) ) {
1878 } elseif ( preg_match( '/^(\d{4}):(\d\d):(\d\d) (\d\d):(\d\d):(\d\d)$/D', $ts, $da ) ) {
1880 } elseif ( preg_match( '/^(\d{4})(\d\d)(\d\d)(\d\d)(\d\d)(\d\d)$/D', $ts, $da ) ) {
1882 } elseif ( preg_match( '/^-?\d{1,13}$/D', $ts ) ) {
1885 $strtime = "@$ts"; // Undocumented?
1886 } elseif ( preg_match( '/^\d{2}-\d{2}-\d{4} \d{2}:\d{2}:\d{2}.\d{6}$/', $ts ) ) {
1887 # TS_ORACLE // session altered to DD-MM-YYYY HH24:MI:SS.FF6
1888 $strtime = preg_replace( '/(\d\d)\.(\d\d)\.(\d\d)(\.(\d+))?/', "$1:$2:$3",
1889 str_replace( '+00:00', 'UTC', $ts ) );
1890 } elseif ( preg_match( '/^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})(?:\.*\d*)?Z$/', $ts, $da ) ) {
1892 } elseif ( preg_match( '/^(\d{4})(\d{2})(\d{2})T(\d{2})(\d{2})(\d{2})(?:\.*\d*)?Z$/', $ts, $da ) ) {
1894 } elseif ( preg_match( '/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)\.*\d*[\+\- ](\d\d)$/', $ts, $da ) ) {
1896 } elseif ( preg_match( '/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)\.*\d* GMT$/', $ts, $da ) ) {
1898 } elseif (preg_match('/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)\.\d\d\d$/',$ts,$da)) {
1900 } elseif ( preg_match( '/^[ \t\r\n]*([A-Z][a-z]{2},[ \t\r\n]*)?' . # Day of week
1901 '\d\d?[ \t\r\n]*[A-Z][a-z]{2}[ \t\r\n]*\d{2}(?:\d{2})?' . # dd Mon yyyy
1902 '[ \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
1903 # TS_RFC2822, accepting a trailing comment. See http://www.squid-cache.org/mail-archive/squid-users/200307/0122.html / r77171
1904 # The regex is a superset of rfc2822 for readability
1905 $strtime = strtok( $ts, ';' );
1906 } 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 ) ) {
1909 } 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 ) ) {
1914 wfDebug("wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n");
1921 static $formats = array(
1924 TS_DB
=> 'Y-m-d H:i:s',
1925 TS_ISO_8601
=> 'Y-m-d\TH:i:s\Z',
1926 TS_ISO_8601_BASIC
=> 'Ymd\THis\Z',
1927 TS_EXIF
=> 'Y:m:d H:i:s', // This shouldn't ever be used, but is included for completeness
1928 TS_RFC2822
=> 'D, d M Y H:i:s',
1929 TS_ORACLE
=> 'd-m-Y H:i:s.000000', // Was 'd-M-y h.i.s A' . ' +00:00' before r51500
1930 TS_POSTGRES
=> 'Y-m-d H:i:s',
1931 TS_DB2
=> 'Y-m-d H:i:s',
1934 if ( !isset( $formats[$outputtype] ) ) {
1935 throw new MWException( 'wfTimestamp() called with illegal output type.' );
1938 if ( function_exists( "date_create" ) ) {
1939 if ( count( $da ) ) {
1940 $ds = sprintf("%04d-%02d-%02dT%02d:%02d:%02d.00+00:00",
1941 (int)$da[1], (int)$da[2], (int)$da[3],
1942 (int)$da[4], (int)$da[5], (int)$da[6]);
1944 $d = date_create( $ds, new DateTimeZone( 'GMT' ) );
1945 } elseif ( $strtime ) {
1946 $d = date_create( $strtime, new DateTimeZone( 'GMT' ) );
1952 wfDebug("wfTimestamp() fed bogus time value: $outputtype; $ts\n");
1956 $output = $d->format( $formats[$outputtype] );
1958 if ( count( $da ) ) {
1959 // Warning! gmmktime() acts oddly if the month or day is set to 0
1960 // We may want to handle that explicitly at some point
1961 $uts = gmmktime( (int)$da[4], (int)$da[5], (int)$da[6],
1962 (int)$da[2], (int)$da[3], (int)$da[1] );
1963 } elseif ( $strtime ) {
1964 $uts = strtotime( $strtime );
1967 if ( $uts === false ) {
1968 wfDebug("wfTimestamp() can't parse the timestamp (non 32-bit time? Update php): $outputtype; $ts\n");
1972 if ( TS_UNIX
== $outputtype ) {
1975 $output = gmdate( $formats[$outputtype], $uts );
1978 if ( ( $outputtype == TS_RFC2822
) ||
( $outputtype == TS_POSTGRES
) ) {
1986 * Return a formatted timestamp, or null if input is null.
1987 * For dealing with nullable timestamp columns in the database.
1988 * @param $outputtype Integer
1992 function wfTimestampOrNull( $outputtype = TS_UNIX
, $ts = null ) {
1993 if( is_null( $ts ) ) {
1996 return wfTimestamp( $outputtype, $ts );
2001 * Check if the operating system is Windows
2003 * @return Bool: true if it's Windows, False otherwise.
2005 function wfIsWindows() {
2006 static $isWindows = null;
2007 if ( $isWindows === null ) {
2008 $isWindows = substr( php_uname(), 0, 7 ) == 'Windows';
2014 * Check if we are running under HipHop
2016 function wfIsHipHop() {
2017 return function_exists( 'hphp_thread_set_warmup_enabled' );
2021 * Swap two variables
2023 function swap( &$x, &$y ) {
2030 * BC wrapper for MimeMagic::singleton()
2031 * @deprecated No longer needed as of 1.17 (r68836). Remove in 1.19.
2033 function &wfGetMimeMagic() {
2034 wfDeprecated( __FUNCTION__
);
2035 return MimeMagic
::singleton();
2039 * Tries to get the system directory for temporary files. The TMPDIR, TMP, and
2040 * TEMP environment variables are then checked in sequence, and if none are set
2041 * try sys_get_temp_dir() for PHP >= 5.2.1. All else fails, return /tmp for Unix
2042 * or C:\Windows\Temp for Windows and hope for the best.
2043 * It is common to call it with tempnam().
2045 * NOTE: When possible, use instead the tmpfile() function to create
2046 * temporary files to avoid race conditions on file creation, etc.
2050 function wfTempDir() {
2051 foreach( array( 'TMPDIR', 'TMP', 'TEMP' ) as $var ) {
2052 $tmp = getenv( $var );
2053 if( $tmp && file_exists( $tmp ) && is_dir( $tmp ) && is_writable( $tmp ) ) {
2057 if( function_exists( 'sys_get_temp_dir' ) ) {
2058 return sys_get_temp_dir();
2061 return wfIsWindows() ?
'C:\Windows\Temp' : '/tmp';
2065 * Make directory, and make all parent directories if they don't exist
2067 * @param $dir String: full path to directory to create
2068 * @param $mode Integer: chmod value to use, default is $wgDirectoryMode
2069 * @param $caller String: optional caller param for debugging.
2072 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2073 global $wgDirectoryMode;
2075 if ( !is_null( $caller ) ) {
2076 wfDebug( "$caller: called wfMkdirParents($dir)" );
2079 if( strval( $dir ) === '' ||
file_exists( $dir ) ) {
2083 $dir = str_replace( array( '\\', '/' ), DIRECTORY_SEPARATOR
, $dir );
2085 if ( is_null( $mode ) ) {
2086 $mode = $wgDirectoryMode;
2089 // Turn off the normal warning, we're doing our own below
2090 wfSuppressWarnings();
2091 $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2092 wfRestoreWarnings();
2095 // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2096 trigger_error( __FUNCTION__
. ": failed to mkdir \"$dir\" mode $mode", E_USER_WARNING
);
2102 * Increment a statistics counter
2104 function wfIncrStats( $key, $count = 1 ) {
2105 global $wgStatsMethod;
2107 $count = intval( $count );
2109 if( $wgStatsMethod == 'udp' ) {
2110 global $wgUDPProfilerHost, $wgUDPProfilerPort, $wgDBname, $wgAggregateStatsID;
2113 $id = $wgAggregateStatsID !== false ?
$wgAggregateStatsID : $wgDBname;
2116 $socket = socket_create( AF_INET
, SOCK_DGRAM
, SOL_UDP
);
2117 $statline = "stats/{$id} - {$count} 1 1 1 1 -total\n";
2121 strlen( $statline ),
2127 $statline = "stats/{$id} - {$count} 1 1 1 1 {$key}\n";
2128 wfSuppressWarnings();
2132 strlen( $statline ),
2137 wfRestoreWarnings();
2138 } elseif( $wgStatsMethod == 'cache' ) {
2140 $key = wfMemcKey( 'stats', $key );
2141 if ( is_null( $wgMemc->incr( $key, $count ) ) ) {
2142 $wgMemc->add( $key, $count );
2150 * @param $nr Mixed: the number to format
2151 * @param $acc Integer: the number of digits after the decimal point, default 2
2152 * @param $round Boolean: whether or not to round the value, default true
2155 function wfPercent( $nr, $acc = 2, $round = true ) {
2156 $ret = sprintf( "%.${acc}f", $nr );
2157 return $round ?
round( $ret, $acc ) . '%' : "$ret%";
2161 * Encrypt a username/password.
2163 * @param $userid Integer: ID of the user
2164 * @param $password String: password of the user
2165 * @return String: hashed password
2166 * @deprecated Use User::crypt() or User::oldCrypt() instead
2168 function wfEncryptPassword( $userid, $password ) {
2169 wfDeprecated(__FUNCTION__
);
2170 # Just wrap around User::oldCrypt()
2171 return User
::oldCrypt( $password, $userid );
2175 * Appends to second array if $value differs from that in $default
2177 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
2178 if ( is_null( $changed ) ) {
2179 throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' );
2181 if ( $default[$key] !== $value ) {
2182 $changed[$key] = $value;
2187 * Since wfMsg() and co suck, they don't return false if the message key they
2188 * looked up didn't exist but a XHTML string, this function checks for the
2189 * nonexistance of messages by looking at wfMsg() output
2191 * @param $key String: the message key looked up
2192 * @return Boolean True if the message *doesn't* exist.
2194 function wfEmptyMsg( $key ) {
2195 return MessageCache
::singleton()->get( $key, /*useDB*/true, /*content*/false ) === false;
2199 * Find out whether or not a mixed variable exists in a string
2201 * @param $needle String
2202 * @param $str String
2203 * @param $insensitive Boolean
2206 function in_string( $needle, $str, $insensitive = false ) {
2208 if( $insensitive ) $func = 'stripos';
2210 return $func( $str, $needle ) !== false;
2213 function wfSpecialList( $page, $details ) {
2215 $details = $details ?
' ' . $wgContLang->getDirMark() . "($details)" : '';
2216 return $page . $details;
2220 * Returns a regular expression of url protocols
2224 function wfUrlProtocols() {
2225 global $wgUrlProtocols;
2227 static $retval = null;
2228 if ( !is_null( $retval ) ) {
2232 // Support old-style $wgUrlProtocols strings, for backwards compatibility
2233 // with LocalSettings files from 1.5
2234 if ( is_array( $wgUrlProtocols ) ) {
2235 $protocols = array();
2236 foreach ( $wgUrlProtocols as $protocol ) {
2237 $protocols[] = preg_quote( $protocol, '/' );
2240 $retval = implode( '|', $protocols );
2242 $retval = $wgUrlProtocols;
2248 * Safety wrapper around ini_get() for boolean settings.
2249 * The values returned from ini_get() are pre-normalized for settings
2250 * set via php.ini or php_flag/php_admin_flag... but *not*
2251 * for those set via php_value/php_admin_value.
2253 * It's fairly common for people to use php_value instead of php_flag,
2254 * which can leave you with an 'off' setting giving a false positive
2255 * for code that just takes the ini_get() return value as a boolean.
2257 * To make things extra interesting, setting via php_value accepts
2258 * "true" and "yes" as true, but php.ini and php_flag consider them false. :)
2259 * Unrecognized values go false... again opposite PHP's own coercion
2260 * from string to bool.
2262 * Luckily, 'properly' set settings will always come back as '0' or '1',
2263 * so we only have to worry about them and the 'improper' settings.
2265 * I frickin' hate PHP... :P
2267 * @param $setting String
2270 function wfIniGetBool( $setting ) {
2271 $val = ini_get( $setting );
2272 // 'on' and 'true' can't have whitespace around them, but '1' can.
2273 return strtolower( $val ) == 'on'
2274 ||
strtolower( $val ) == 'true'
2275 ||
strtolower( $val ) == 'yes'
2276 ||
preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2280 * Wrapper function for PHP's dl(). This doesn't work in most situations from
2281 * PHP 5.3 onward, and is usually disabled in shared environments anyway.
2283 * @param $extension String A PHP extension. The file suffix (.so or .dll)
2285 * @return Bool - Whether or not the extension is loaded
2287 function wfDl( $extension ) {
2288 if( extension_loaded( $extension ) ) {
2292 $canDl = ( function_exists( 'dl' ) && is_callable( 'dl' )
2293 && wfIniGetBool( 'enable_dl' ) && !wfIniGetBool( 'safe_mode' ) );
2296 wfSuppressWarnings();
2297 dl( $extension . '.' . PHP_SHLIB_SUFFIX
);
2298 wfRestoreWarnings();
2300 return extension_loaded( $extension );
2304 * Execute a shell command, with time and memory limits mirrored from the PHP
2305 * configuration if supported.
2306 * @param $cmd String Command line, properly escaped for shell.
2307 * @param &$retval optional, will receive the program's exit code.
2308 * (non-zero is usually failure)
2309 * @param $environ Array optional environment variables which should be
2310 * added to the executed command environment.
2311 * @return collected stdout as a string (trailing newlines stripped)
2313 function wfShellExec( $cmd, &$retval = null, $environ = array() ) {
2314 global $IP, $wgMaxShellMemory, $wgMaxShellFileSize, $wgMaxShellTime;
2317 if ( is_null( $disabled ) ) {
2319 if( wfIniGetBool( 'safe_mode' ) ) {
2320 wfDebug( "wfShellExec can't run in safe_mode, PHP's exec functions are too broken.\n" );
2321 $disabled = 'safemode';
2323 $functions = explode( ',', ini_get( 'disable_functions' ) );
2324 $functions = array_map( 'trim', $functions );
2325 $functions = array_map( 'strtolower', $functions );
2326 if ( in_array( 'passthru', $functions ) ) {
2327 wfDebug( "passthru is in disabled_functions\n" );
2328 $disabled = 'passthru';
2334 return $disabled == 'safemode' ?
2335 'Unable to run external programs in safe mode.' :
2336 'Unable to run external programs, passthru() is disabled.';
2339 wfInitShellLocale();
2342 foreach( $environ as $k => $v ) {
2343 if ( wfIsWindows() ) {
2344 /* Surrounding a set in quotes (method used by wfEscapeShellArg) makes the quotes themselves
2345 * appear in the environment variable, so we must use carat escaping as documented in
2346 * http://technet.microsoft.com/en-us/library/cc723564.aspx
2347 * Note however that the quote isn't listed there, but is needed, and the parentheses
2348 * are listed there but doesn't appear to need it.
2350 $envcmd .= "set $k=" . preg_replace( '/([&|()<>^"])/', '^\\1', $v ) . '&& ';
2352 /* Assume this is a POSIX shell, thus required to accept variable assignments before the command
2353 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_09_01
2355 $envcmd .= "$k=" . escapeshellarg( $v ) . ' ';
2358 $cmd = $envcmd . $cmd;
2360 if ( wfIsWindows() ) {
2361 if ( version_compare( PHP_VERSION
, '5.3.0', '<' ) && /* Fixed in 5.3.0 :) */
2362 ( version_compare( PHP_VERSION
, '5.2.1', '>=' ) ||
php_uname( 's' ) == 'Windows NT' ) )
2364 # Hack to work around PHP's flawed invocation of cmd.exe
2365 # http://news.php.net/php.internals/21796
2366 # Windows 9x doesn't accept any kind of quotes
2367 $cmd = '"' . $cmd . '"';
2369 } elseif ( php_uname( 's' ) == 'Linux' ) {
2370 $time = intval( $wgMaxShellTime );
2371 $mem = intval( $wgMaxShellMemory );
2372 $filesize = intval( $wgMaxShellFileSize );
2374 if ( $time > 0 && $mem > 0 ) {
2375 $script = "$IP/bin/ulimit4.sh";
2376 if ( is_executable( $script ) ) {
2377 $cmd = '/bin/bash ' . escapeshellarg( $script ) . " $time $mem $filesize " . escapeshellarg( $cmd );
2381 wfDebug( "wfShellExec: $cmd\n" );
2383 $retval = 1; // error by default?
2385 passthru( $cmd, $retval );
2386 $output = ob_get_contents();
2389 if ( $retval == 127 ) {
2390 wfDebugLog( 'exec', "Possibly missing executable file: $cmd\n" );
2396 * Workaround for http://bugs.php.net/bug.php?id=45132
2397 * escapeshellarg() destroys non-ASCII characters if LANG is not a UTF-8 locale
2399 function wfInitShellLocale() {
2400 static $done = false;
2405 global $wgShellLocale;
2406 if ( !wfIniGetBool( 'safe_mode' ) ) {
2407 putenv( "LC_CTYPE=$wgShellLocale" );
2408 setlocale( LC_CTYPE
, $wgShellLocale );
2413 * This function works like "use VERSION" in Perl, the program will die with a
2414 * backtrace if the current version of PHP is less than the version provided
2416 * This is useful for extensions which due to their nature are not kept in sync
2417 * with releases, and might depend on other versions of PHP than the main code
2419 * Note: PHP might die due to parsing errors in some cases before it ever
2420 * manages to call this function, such is life
2422 * @see perldoc -f use
2424 * @param $req_ver Mixed: the version to check, can be a string, an integer, or
2427 function wfUsePHP( $req_ver ) {
2428 $php_ver = PHP_VERSION
;
2430 if ( version_compare( $php_ver, (string)$req_ver, '<' ) ) {
2431 throw new MWException( "PHP $req_ver required--this is only $php_ver" );
2436 * This function works like "use VERSION" in Perl except it checks the version
2437 * of MediaWiki, the program will die with a backtrace if the current version
2438 * of MediaWiki is less than the version provided.
2440 * This is useful for extensions which due to their nature are not kept in sync
2443 * @see perldoc -f use
2445 * @param $req_ver Mixed: the version to check, can be a string, an integer, or
2448 function wfUseMW( $req_ver ) {
2451 if ( version_compare( $wgVersion, (string)$req_ver, '<' ) ) {
2452 throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
2457 * Return the final portion of a pathname.
2458 * Reimplemented because PHP5's basename() is buggy with multibyte text.
2459 * http://bugs.php.net/bug.php?id=33898
2461 * PHP's basename() only considers '\' a pathchar on Windows and Netware.
2462 * We'll consider it so always, as we don't want \s in our Unix paths either.
2464 * @param $path String
2465 * @param $suffix String: to remove if present
2468 function wfBaseName( $path, $suffix = '' ) {
2469 $encSuffix = ( $suffix == '' )
2471 : ( '(?:' . preg_quote( $suffix, '#' ) . ')?' );
2473 if( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
2481 * Generate a relative path name to the given file.
2482 * May explode on non-matching case-insensitive paths,
2483 * funky symlinks, etc.
2485 * @param $path String: absolute destination path including target filename
2486 * @param $from String: Absolute source path, directory only
2489 function wfRelativePath( $path, $from ) {
2490 // Normalize mixed input on Windows...
2491 $path = str_replace( '/', DIRECTORY_SEPARATOR
, $path );
2492 $from = str_replace( '/', DIRECTORY_SEPARATOR
, $from );
2494 // Trim trailing slashes -- fix for drive root
2495 $path = rtrim( $path, DIRECTORY_SEPARATOR
);
2496 $from = rtrim( $from, DIRECTORY_SEPARATOR
);
2498 $pieces = explode( DIRECTORY_SEPARATOR
, dirname( $path ) );
2499 $against = explode( DIRECTORY_SEPARATOR
, $from );
2501 if( $pieces[0] !== $against[0] ) {
2502 // Non-matching Windows drive letters?
2503 // Return a full path.
2507 // Trim off common prefix
2508 while( count( $pieces ) && count( $against )
2509 && $pieces[0] == $against[0] ) {
2510 array_shift( $pieces );
2511 array_shift( $against );
2514 // relative dots to bump us to the parent
2515 while( count( $against ) ) {
2516 array_unshift( $pieces, '..' );
2517 array_shift( $against );
2520 array_push( $pieces, wfBaseName( $path ) );
2522 return implode( DIRECTORY_SEPARATOR
, $pieces );
2526 * Backwards array plus for people who haven't bothered to read the PHP manual
2527 * XXX: will not darn your socks for you.
2529 * @param $array1 Array
2530 * @param [$array2, [...]] Arrays
2533 function wfArrayMerge( $array1/* ... */ ) {
2534 $args = func_get_args();
2535 $args = array_reverse( $args, true );
2537 foreach ( $args as $arg ) {
2544 * Merge arrays in the style of getUserPermissionsErrors, with duplicate removal
2546 * wfMergeErrorArrays(
2547 * array( array( 'x' ) ),
2548 * array( array( 'x', '2' ) ),
2549 * array( array( 'x' ) ),
2550 * array( array( 'y') )
2554 * array( 'x', '2' ),
2559 function wfMergeErrorArrays( /*...*/ ) {
2560 $args = func_get_args();
2562 foreach ( $args as $errors ) {
2563 foreach ( $errors as $params ) {
2564 # FIXME: sometimes get nested arrays for $params,
2565 # which leads to E_NOTICEs
2566 $spec = implode( "\t", $params );
2567 $out[$spec] = $params;
2570 return array_values( $out );
2574 * parse_url() work-alike, but non-broken. Differences:
2576 * 1) Does not raise warnings on bad URLs (just returns false)
2577 * 2) Handles protocols that don't use :// (e.g., mailto: and news:) correctly
2578 * 3) Adds a "delimiter" element to the array, either '://' or ':' (see (2))
2580 * @param $url String: a URL to parse
2581 * @return Array: bits of the URL in an associative array, per PHP docs
2583 function wfParseUrl( $url ) {
2584 global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
2585 wfSuppressWarnings();
2586 $bits = parse_url( $url );
2587 wfRestoreWarnings();
2592 // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
2593 if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
2594 $bits['delimiter'] = '://';
2595 } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
2596 $bits['delimiter'] = ':';
2597 // parse_url detects for news: and mailto: the host part of an url as path
2598 // We have to correct this wrong detection
2599 if ( isset( $bits['path'] ) ) {
2600 $bits['host'] = $bits['path'];
2611 * Make a URL index, appropriate for the el_index field of externallinks.
2613 function wfMakeUrlIndex( $url ) {
2614 $bits = wfParseUrl( $url );
2616 // Reverse the labels in the hostname, convert to lower case
2617 // For emails reverse domainpart only
2618 if ( $bits['scheme'] == 'mailto' ) {
2619 $mailparts = explode( '@', $bits['host'], 2 );
2620 if ( count( $mailparts ) === 2 ) {
2621 $domainpart = strtolower( implode( '.', array_reverse( explode( '.', $mailparts[1] ) ) ) );
2623 // No domain specified, don't mangle it
2626 $reversedHost = $domainpart . '@' . $mailparts[0];
2628 $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) );
2630 // Add an extra dot to the end
2631 // Why? Is it in wrong place in mailto links?
2632 if ( substr( $reversedHost, -1, 1 ) !== '.' ) {
2633 $reversedHost .= '.';
2635 // Reconstruct the pseudo-URL
2636 $prot = $bits['scheme'];
2637 $index = $prot . $bits['delimiter'] . $reversedHost;
2638 // Leave out user and password. Add the port, path, query and fragment
2639 if ( isset( $bits['port'] ) ) {
2640 $index .= ':' . $bits['port'];
2642 if ( isset( $bits['path'] ) ) {
2643 $index .= $bits['path'];
2647 if ( isset( $bits['query'] ) ) {
2648 $index .= '?' . $bits['query'];
2650 if ( isset( $bits['fragment'] ) ) {
2651 $index .= '#' . $bits['fragment'];
2657 * Do any deferred updates and clear the list
2659 * @param $commit String: set to 'commit' to commit after every update to
2660 * prevent lock contention
2662 function wfDoUpdates( $commit = '' ) {
2663 global $wgDeferredUpdateList;
2665 wfProfileIn( __METHOD__
);
2667 // No need to get master connections in case of empty updates array
2668 if ( !count( $wgDeferredUpdateList ) ) {
2669 wfProfileOut( __METHOD__
);
2673 $doCommit = $commit == 'commit';
2675 $dbw = wfGetDB( DB_MASTER
);
2678 foreach ( $wgDeferredUpdateList as $update ) {
2679 $update->doUpdate();
2681 if ( $doCommit && $dbw->trxLevel() ) {
2686 $wgDeferredUpdateList = array();
2687 wfProfileOut( __METHOD__
);
2691 * Convert an arbitrarily-long digit string from one numeric base
2692 * to another, optionally zero-padding to a minimum column width.
2694 * Supports base 2 through 36; digit values 10-36 are represented
2695 * as lowercase letters a-z. Input is case-insensitive.
2697 * @param $input String: of digits
2698 * @param $sourceBase Integer: 2-36
2699 * @param $destBase Integer: 2-36
2700 * @param $pad Integer: 1 or greater
2701 * @param $lowercase Boolean
2702 * @return String or false on invalid input
2704 function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1, $lowercase = true ) {
2705 $input = strval( $input );
2706 if( $sourceBase < 2 ||
2711 $sourceBase != intval( $sourceBase ) ||
2712 $destBase != intval( $destBase ) ||
2713 $pad != intval( $pad ) ||
2714 !is_string( $input ) ||
2718 $digitChars = ( $lowercase ) ?
'0123456789abcdefghijklmnopqrstuvwxyz' : '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ';
2719 $inDigits = array();
2722 // Decode and validate input string
2723 $input = strtolower( $input );
2724 for( $i = 0; $i < strlen( $input ); $i++
) {
2725 $n = strpos( $digitChars, $input[$i] );
2726 if( $n === false ||
$n > $sourceBase ) {
2732 // Iterate over the input, modulo-ing out an output digit
2733 // at a time until input is gone.
2734 while( count( $inDigits ) ) {
2736 $workDigits = array();
2739 foreach( $inDigits as $digit ) {
2740 $work *= $sourceBase;
2743 if( $work < $destBase ) {
2744 // Gonna need to pull another digit.
2745 if( count( $workDigits ) ) {
2746 // Avoid zero-padding; this lets us find
2747 // the end of the input very easily when
2748 // length drops to zero.
2752 // Finally! Actual division!
2753 $workDigits[] = intval( $work / $destBase );
2755 // Isn't it annoying that most programming languages
2756 // don't have a single divide-and-remainder operator,
2757 // even though the CPU implements it that way?
2758 $work = $work %
$destBase;
2762 // All that division leaves us with a remainder,
2763 // which is conveniently our next output digit.
2764 $outChars .= $digitChars[$work];
2767 $inDigits = $workDigits;
2770 while( strlen( $outChars ) < $pad ) {
2774 return strrev( $outChars );
2778 * Create an object with a given name and an array of construct parameters
2779 * @param $name String
2780 * @param $p Array: parameters
2783 function wfCreateObject( $name, $p ) {
2784 return MWFunction
::newObj( $name, $p );
2787 function wfHttpOnlySafe() {
2788 global $wgHttpOnlyBlacklist;
2790 if( isset( $_SERVER['HTTP_USER_AGENT'] ) ) {
2791 foreach( $wgHttpOnlyBlacklist as $regex ) {
2792 if( preg_match( $regex, $_SERVER['HTTP_USER_AGENT'] ) ) {
2802 * Initialise php session
2804 function wfSetupSession( $sessionId = false ) {
2805 global $wgSessionsInMemcached, $wgCookiePath, $wgCookieDomain,
2806 $wgCookieSecure, $wgCookieHttpOnly, $wgSessionHandler;
2807 if( $wgSessionsInMemcached ) {
2808 if ( !defined( 'MW_COMPILED' ) ) {
2809 require_once( 'MemcachedSessions.php' );
2811 session_set_save_handler( 'memsess_open', 'memsess_close', 'memsess_read',
2812 'memsess_write', 'memsess_destroy', 'memsess_gc' );
2814 // It's necessary to register a shutdown function to call session_write_close(),
2815 // because by the time the request shutdown function for the session module is
2816 // called, $wgMemc has already been destroyed. Shutdown functions registered
2817 // this way are called before object destruction.
2818 register_shutdown_function( 'memsess_write_close' );
2819 } elseif( $wgSessionHandler && $wgSessionHandler != ini_get( 'session.save_handler' ) ) {
2820 # Only set this if $wgSessionHandler isn't null and session.save_handler
2821 # hasn't already been set to the desired value (that causes errors)
2822 ini_set( 'session.save_handler', $wgSessionHandler );
2824 $httpOnlySafe = wfHttpOnlySafe() && $wgCookieHttpOnly;
2825 wfDebugLog( 'cookie',
2826 'session_set_cookie_params: "' . implode( '", "',
2832 $httpOnlySafe ) ) . '"' );
2833 session_set_cookie_params( 0, $wgCookiePath, $wgCookieDomain, $wgCookieSecure, $httpOnlySafe );
2834 session_cache_limiter( 'private, must-revalidate' );
2836 session_id( $sessionId );
2838 wfSuppressWarnings();
2840 wfRestoreWarnings();
2844 * Get an object from the precompiled serialized directory
2846 * @return Mixed: the variable on success, false on failure
2848 function wfGetPrecompiledData( $name ) {
2851 $file = "$IP/serialized/$name";
2852 if ( file_exists( $file ) ) {
2853 $blob = file_get_contents( $file );
2855 return unserialize( $blob );
2861 function wfGetCaller( $level = 2 ) {
2862 $backtrace = wfDebugBacktrace();
2863 if ( isset( $backtrace[$level] ) ) {
2864 return wfFormatStackFrame( $backtrace[$level] );
2866 $caller = 'unknown';
2872 * Return a string consisting of callers in the stack. Useful sometimes
2873 * for profiling specific points.
2875 * @param $limit The maximum depth of the stack frame to return, or false for
2878 function wfGetAllCallers( $limit = 3 ) {
2879 $trace = array_reverse( wfDebugBacktrace() );
2880 if ( !$limit ||
$limit > count( $trace ) - 1 ) {
2881 $limit = count( $trace ) - 1;
2883 $trace = array_slice( $trace, -$limit - 1, $limit );
2884 return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
2888 * Return a string representation of frame
2890 function wfFormatStackFrame( $frame ) {
2891 return isset( $frame['class'] ) ?
2892 $frame['class'] . '::' . $frame['function'] :
2899 function wfMemcKey( /*... */ ) {
2900 $args = func_get_args();
2901 $key = wfWikiID() . ':' . implode( ':', $args );
2902 $key = str_replace( ' ', '_', $key );
2907 * Get a cache key for a foreign DB
2909 function wfForeignMemcKey( $db, $prefix /*, ... */ ) {
2910 $args = array_slice( func_get_args(), 2 );
2912 $key = "$db-$prefix:" . implode( ':', $args );
2914 $key = $db . ':' . implode( ':', $args );
2920 * Get an ASCII string identifying this wiki
2921 * This is used as a prefix in memcached keys
2923 function wfWikiID() {
2924 global $wgDBprefix, $wgDBname;
2925 if ( $wgDBprefix ) {
2926 return "$wgDBname-$wgDBprefix";
2933 * Split a wiki ID into DB name and table prefix
2935 function wfSplitWikiID( $wiki ) {
2936 $bits = explode( '-', $wiki, 2 );
2937 if ( count( $bits ) < 2 ) {
2944 * Get a Database object.
2945 * @param $db Integer: index of the connection to get. May be DB_MASTER for the
2946 * master (for write queries), DB_SLAVE for potentially lagged read
2947 * queries, or an integer >= 0 for a particular server.
2949 * @param $groups Mixed: query groups. An array of group names that this query
2950 * belongs to. May contain a single string if the query is only
2953 * @param $wiki String: the wiki ID, or false for the current wiki
2955 * Note: multiple calls to wfGetDB(DB_SLAVE) during the course of one request
2956 * will always return the same object, unless the underlying connection or load
2957 * balancer is manually destroyed.
2959 * @return DatabaseBase
2961 function &wfGetDB( $db, $groups = array(), $wiki = false ) {
2962 return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
2966 * Get a load balancer object.
2968 * @param $wiki String: wiki ID, or false for the current wiki
2969 * @return LoadBalancer
2971 function wfGetLB( $wiki = false ) {
2972 return wfGetLBFactory()->getMainLB( $wiki );
2976 * Get the load balancer factory object
2979 function &wfGetLBFactory() {
2980 return LBFactory
::singleton();
2985 * Shortcut for RepoGroup::singleton()->findFile()
2986 * @param $title String or Title object
2987 * @param $options Associative array of options:
2988 * time: requested time for an archived image, or false for the
2989 * current version. An image object will be returned which was
2990 * created at the specified time.
2992 * ignoreRedirect: If true, do not follow file redirects
2994 * private: If true, return restricted (deleted) files if the current
2995 * user is allowed to view them. Otherwise, such files will not
2998 * bypassCache: If true, do not use the process-local cache of File objects
3000 * @return File, or false if the file does not exist
3002 function wfFindFile( $title, $options = array() ) {
3003 return RepoGroup
::singleton()->findFile( $title, $options );
3007 * Get an object referring to a locally registered file.
3008 * Returns a valid placeholder object if the file does not exist.
3009 * @param $title Title or String
3010 * @return File, or null if passed an invalid Title
3012 function wfLocalFile( $title ) {
3013 return RepoGroup
::singleton()->getLocalRepo()->newFile( $title );
3017 * Should low-performance queries be disabled?
3020 * @codeCoverageIgnore
3022 function wfQueriesMustScale() {
3023 global $wgMiserMode;
3025 ||
( SiteStats
::pages() > 100000
3026 && SiteStats
::edits() > 1000000
3027 && SiteStats
::users() > 10000 );
3031 * Get the path to a specified script file, respecting file
3032 * extensions; this is a wrapper around $wgScriptExtension etc.
3034 * @param $script String: script filename, sans extension
3037 function wfScript( $script = 'index' ) {
3038 global $wgScriptPath, $wgScriptExtension;
3039 return "{$wgScriptPath}/{$script}{$wgScriptExtension}";
3043 * Get the script URL.
3045 * @return script URL
3047 function wfGetScriptUrl() {
3048 if( isset( $_SERVER['SCRIPT_NAME'] ) ) {
3050 # as it was called, minus the query string.
3052 # Some sites use Apache rewrite rules to handle subdomains,
3053 # and have PHP set up in a weird way that causes PHP_SELF
3054 # to contain the rewritten URL instead of the one that the
3055 # outside world sees.
3057 # If in this mode, use SCRIPT_URL instead, which mod_rewrite
3058 # provides containing the "before" URL.
3059 return $_SERVER['SCRIPT_NAME'];
3061 return $_SERVER['URL'];
3066 * Convenience function converts boolean values into "true"
3067 * or "false" (string) values
3069 * @param $value Boolean
3072 function wfBoolToStr( $value ) {
3073 return $value ?
'true' : 'false';
3077 * Load an extension messages file
3078 * @deprecated in 1.16, warnings in 1.18, remove in 1.20
3079 * @codeCoverageIgnore
3081 function wfLoadExtensionMessages( $extensionName, $langcode = false ) {
3082 wfDeprecated( __FUNCTION__
);
3086 * Get a platform-independent path to the null file, e.g.
3091 function wfGetNull() {
3092 return wfIsWindows()
3098 * Throws a warning that $function is deprecated
3099 * @param $function String
3102 function wfDeprecated( $function ) {
3103 static $functionsWarned = array();
3104 if ( !isset( $functionsWarned[$function] ) ) {
3105 $functionsWarned[$function] = true;
3106 wfWarn( "Use of $function is deprecated.", 2 );
3111 * Send a warning either to the debug log or in a PHP error depending on
3112 * $wgDevelopmentWarnings
3114 * @param $msg String: message to send
3115 * @param $callerOffset Integer: number of itmes to go back in the backtrace to
3116 * find the correct caller (1 = function calling wfWarn, ...)
3117 * @param $level Integer: PHP error level; only used when $wgDevelopmentWarnings
3120 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE
) {
3121 $callers = wfDebugBacktrace();
3122 if( isset( $callers[$callerOffset +
1] ) ){
3123 $callerfunc = $callers[$callerOffset +
1];
3124 $callerfile = $callers[$callerOffset];
3125 if( isset( $callerfile['file'] ) && isset( $callerfile['line'] ) ) {
3126 $file = $callerfile['file'] . ' at line ' . $callerfile['line'];
3128 $file = '(internal function)';
3131 if( isset( $callerfunc['class'] ) ) {
3132 $func .= $callerfunc['class'] . '::';
3134 if( isset( $callerfunc['function'] ) ) {
3135 $func .= $callerfunc['function'];
3137 $msg .= " [Called from $func in $file]";
3140 global $wgDevelopmentWarnings;
3141 if ( $wgDevelopmentWarnings ) {
3142 trigger_error( $msg, $level );
3144 wfDebug( "$msg\n" );
3149 * Sleep until the worst slave's replication lag is less than or equal to
3150 * $maxLag, in seconds. Use this when updating very large numbers of rows, as
3151 * in maintenance scripts, to avoid causing too much lag. Of course, this is
3152 * a no-op if there are no slaves.
3154 * Every time the function has to wait for a slave, it will print a message to
3155 * that effect (and then sleep for a little while), so it's probably not best
3156 * to use this outside maintenance scripts in its present form.
3158 * @param $maxLag Integer
3159 * @param $wiki mixed Wiki identifier accepted by wfGetLB
3162 function wfWaitForSlaves( $maxLag, $wiki = false ) {
3164 $lb = wfGetLB( $wiki );
3165 list( $host, $lag ) = $lb->getMaxLag( $wiki );
3166 while( $lag > $maxLag ) {
3167 wfSuppressWarnings();
3168 $name = gethostbyaddr( $host );
3169 wfRestoreWarnings();
3170 if( $name !== false ) {
3173 print "Waiting for $host (lagged $lag seconds)...\n";
3175 list( $host, $lag ) = $lb->getMaxLag();
3181 * Modern version of wfWaitForSlaves(). Instead of looking at replication lag
3182 * and waiting for it to go down, this waits for the slaves to catch up to the
3183 * master position. This is much better for lag control than wfWaitForSlaves()
3185 function wfWaitForSlaves_masterPos() {
3187 // bug 27975 - Don't try to wait for slaves if there are none
3188 // Prevents permission error when getting master position
3189 if ( $lb->getServerCount() > 1 ) {
3190 $dbw = $lb->getConnection( DB_MASTER
);
3191 $pos = $dbw->getMasterPos();
3192 $lb->waitForAll( $pos );
3197 * Used to be used for outputting text in the installer/updater
3198 * @deprecated Warnings in 1.19, removal in 1.20
3200 function wfOut( $s ) {
3201 global $wgCommandLineMode;
3202 if ( $wgCommandLineMode && !defined( 'MEDIAWIKI_INSTALL' ) ) {
3205 echo htmlspecialchars( $s );
3211 * Count down from $n to zero on the terminal, with a one-second pause
3212 * between showing each number. For use in command-line scripts.
3213 * @codeCoverageIgnore
3215 function wfCountDown( $n ) {
3216 for ( $i = $n; $i >= 0; $i-- ) {
3218 echo str_repeat( "\x08", strlen( $i +
1 ) );
3230 * Generate a random 32-character hexadecimal token.
3231 * @param $salt Mixed: some sort of salt, if necessary, to add to random
3232 * characters before hashing.
3233 * @codeCoverageIgnore
3235 function wfGenerateToken( $salt = '' ) {
3236 $salt = serialize( $salt );
3237 return md5( mt_rand( 0, 0x7fffffff ) . $salt );
3241 * Replace all invalid characters with -
3242 * @param $name Mixed: filename to process
3244 function wfStripIllegalFilenameChars( $name ) {
3245 global $wgIllegalFileChars;
3246 $name = wfBaseName( $name );
3247 $name = preg_replace(
3248 "/[^" . Title
::legalChars() . "]" .
3249 ( $wgIllegalFileChars ?
"|[" . $wgIllegalFileChars . "]" : '' ) .
3258 * Insert array into another array after the specified *KEY*
3259 * @param $array Array: The array.
3260 * @param $insert Array: The array to insert.
3261 * @param $after Mixed: The key to insert after
3263 function wfArrayInsertAfter( $array, $insert, $after ) {
3264 // Find the offset of the element to insert after.
3265 $keys = array_keys( $array );
3266 $offsetByKey = array_flip( $keys );
3268 $offset = $offsetByKey[$after];
3270 // Insert at the specified offset
3271 $before = array_slice( $array, 0, $offset +
1, true );
3272 $after = array_slice( $array, $offset +
1, count( $array ) - $offset, true );
3274 $output = $before +
$insert +
$after;
3279 /* Recursively converts the parameter (an object) to an array with the same data */
3280 function wfObjectToArray( $objOrArray, $recursive = true ) {
3282 if( is_object( $objOrArray ) ) {
3283 $objOrArray = get_object_vars( $objOrArray );
3285 foreach ( $objOrArray as $key => $value ) {
3286 if ( $recursive && ( is_object( $value ) ||
is_array( $value ) ) ) {
3287 $value = wfObjectToArray( $value );
3290 $array[$key] = $value;
3297 * Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit;
3298 * @return Integer value memory was set to.
3300 function wfMemoryLimit() {
3301 global $wgMemoryLimit;
3302 $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
3303 if( $memlimit != -1 ) {
3304 $conflimit = wfShorthandToInteger( $wgMemoryLimit );
3305 if( $conflimit == -1 ) {
3306 wfDebug( "Removing PHP's memory limit\n" );
3307 wfSuppressWarnings();
3308 ini_set( 'memory_limit', $conflimit );
3309 wfRestoreWarnings();
3311 } elseif ( $conflimit > $memlimit ) {
3312 wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
3313 wfSuppressWarnings();
3314 ini_set( 'memory_limit', $conflimit );
3315 wfRestoreWarnings();
3323 * Converts shorthand byte notation to integer form
3324 * @param $string String
3327 function wfShorthandToInteger( $string = '' ) {
3328 $string = trim( $string );
3329 if( $string === '' ) {
3332 $last = $string[strlen( $string ) - 1];
3333 $val = intval( $string );
3338 // break intentionally missing
3342 // break intentionally missing
3352 * Get the normalised IETF language tag
3353 * See unit test for examples.
3354 * @param $code String: The language code.
3355 * @return $langCode String: The language code which complying with BCP 47 standards.
3357 function wfBCP47( $code ) {
3358 $codeSegment = explode( '-', $code );
3359 foreach ( $codeSegment as $segNo => $seg ) {
3360 if ( count( $codeSegment ) > 0 ) {
3361 // when previous segment is x, it is a private segment and should be lc
3362 if( $segNo > 0 && strtolower( $codeSegment[($segNo - 1)] ) == 'x') {
3363 $codeBCP[$segNo] = strtolower( $seg );
3364 // ISO 3166 country code
3365 } elseif ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) {
3366 $codeBCP[$segNo] = strtoupper( $seg );
3367 // ISO 15924 script code
3368 } elseif ( ( strlen( $seg ) == 4 ) && ( $segNo > 0 ) ) {
3369 $codeBCP[$segNo] = ucfirst( strtolower( $seg ) );
3370 // Use lowercase for other cases
3372 $codeBCP[$segNo] = strtolower( $seg );
3375 // Use lowercase for single segment
3376 $codeBCP[$segNo] = strtolower( $seg );
3379 $langCode = implode( '-', $codeBCP );
3383 function wfArrayMap( $function, $input ) {
3384 $ret = array_map( $function, $input );
3385 foreach ( $ret as $key => $value ) {
3386 $taint = istainted( $input[$key] );
3388 taint( $ret[$key], $taint );
3396 * Get a cache object.
3397 * @param integer $inputType Cache type, one the the CACHE_* constants.
3401 function wfGetCache( $inputType ) {
3402 return ObjectCache
::getInstance( $inputType );
3405 /** Get the main cache object */
3406 function wfGetMainCache() {
3407 global $wgMainCacheType;
3408 return ObjectCache
::getInstance( $wgMainCacheType );
3411 /** Get the cache object used by the message cache */
3412 function wfGetMessageCacheStorage() {
3413 global $wgMessageCacheType;
3414 return ObjectCache
::getInstance( $wgMessageCacheType );
3417 /** Get the cache object used by the parser cache */
3418 function wfGetParserCacheStorage() {
3419 global $wgParserCacheType;
3420 return ObjectCache
::getInstance( $wgParserCacheType );