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 $wgProfileLimit, $wgUser;
347 $profiler = Profiler
::instance();
349 # Profiling must actually be enabled...
350 if ( $profiler->isStub() ) {
354 // Get total page request time and only show pages that longer than
355 // $wgProfileLimit time (default is 0)
357 $elapsed = $now - $wgRequestTime;
358 if ( $elapsed <= $wgProfileLimit ) {
362 $profiler->logData();
364 // Check whether this should be logged in the debug file.
365 if ( $wgDebugLogFile == '' ||
( $wgRequest->getVal( 'action' ) == 'raw' && !$wgDebugRawPage ) ) {
370 if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
371 $forward = ' forwarded for ' . $_SERVER['HTTP_X_FORWARDED_FOR'];
373 if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
374 $forward .= ' client IP ' . $_SERVER['HTTP_CLIENT_IP'];
376 if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
377 $forward .= ' from ' . $_SERVER['HTTP_FROM'];
380 $forward = "\t(proxied via {$_SERVER['REMOTE_ADDR']}{$forward})";
382 // Don't unstub $wgUser at this late stage just for statistics purposes
383 // FIXME: We can detect some anons even if it is not loaded. See User::getId()
384 if ( $wgUser->mDataLoaded
&& $wgUser->isAnon() ) {
387 $log = sprintf( "%s\t%04.3f\t%s\n",
388 gmdate( 'YmdHis' ), $elapsed,
389 urldecode( $wgRequest->getRequestURL() . $forward ) );
391 wfErrorLog( $log . $profiler->getOutput(), $wgDebugLogFile );
395 * Check if the wiki read-only lock file is present. This can be used to lock
396 * off editing functions, but doesn't guarantee that the database will not be
400 function wfReadOnly() {
401 global $wgReadOnlyFile, $wgReadOnly;
403 if ( !is_null( $wgReadOnly ) ) {
404 return (bool)$wgReadOnly;
406 if ( $wgReadOnlyFile == '' ) {
409 // Set $wgReadOnly for faster access next time
410 if ( is_file( $wgReadOnlyFile ) ) {
411 $wgReadOnly = file_get_contents( $wgReadOnlyFile );
415 return (bool)$wgReadOnly;
418 function wfReadOnlyReason() {
425 * Return a Language object from $langcode
426 * @param $langcode Mixed: either:
427 * - a Language object
428 * - code of the language to get the message for, if it is
429 * a valid code create a language for that language, if
430 * it is a string but not a valid code then make a basic
432 * - a boolean: if it's false then use the current users
433 * language (as a fallback for the old parameter
434 * functionality), or if it is true then use the wikis
435 * @return Language object
437 function wfGetLangObj( $langcode = false ) {
438 # Identify which language to get or create a language object for.
439 # Using is_object here due to Stub objects.
440 if( is_object( $langcode ) ) {
441 # Great, we already have the object (hopefully)!
445 global $wgContLang, $wgLanguageCode;
446 if( $langcode === true ||
$langcode === $wgLanguageCode ) {
447 # $langcode is the language code of the wikis content language object.
448 # or it is a boolean and value is true
453 if( $langcode === false ||
$langcode === $wgLang->getCode() ) {
454 # $langcode is the language code of user language object.
455 # or it was a boolean and value is false
459 $validCodes = array_keys( Language
::getLanguageNames() );
460 if( in_array( $langcode, $validCodes ) ) {
461 # $langcode corresponds to a valid language.
462 return Language
::factory( $langcode );
465 # $langcode is a string, but not a valid language code; use content language.
466 wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
471 * Use this instead of $wgContLang, when working with user interface.
472 * User interface is currently hard coded according to wiki content language
473 * in many ways, especially regarding to text direction. There is lots stuff
474 * to fix, hence this function to keep the old behaviour unless the global
475 * $wgBetterDirectionality is enabled (or removed when everything works).
477 function wfUILang() {
478 global $wgBetterDirectionality;
479 return wfGetLangObj( !$wgBetterDirectionality );
483 * This is the new function for getting translated interface messages.
484 * See the Message class for documentation how to use them.
485 * The intention is that this function replaces all old wfMsg* functions.
486 * @param $key \string Message key.
487 * Varargs: normal message parameters.
491 function wfMessage( $key /*...*/) {
492 $params = func_get_args();
493 array_shift( $params );
494 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
495 $params = $params[0];
497 return new Message( $key, $params );
501 * This function accepts multiple message keys and returns a message instance
502 * for the first message which is non-empty. If all messages are empty then an
503 * instance of the first message key is returned.
504 * Varargs: message keys
508 function wfMessageFallback( /*...*/ ) {
509 $args = func_get_args();
510 return MWFunction
::callArray( 'Message::newFallbackSequence', $args );
514 * Get a message from anywhere, for the current user language.
516 * Use wfMsgForContent() instead if the message should NOT
517 * change depending on the user preferences.
519 * @param $key String: lookup key for the message, usually
520 * defined in languages/Language.php
522 * This function also takes extra optional parameters (not
523 * shown in the function definition), which can be used to
524 * insert variable text into the predefined message.
526 function wfMsg( $key ) {
527 $args = func_get_args();
528 array_shift( $args );
529 return wfMsgReal( $key, $args, true );
533 * Same as above except doesn't transform the message
535 function wfMsgNoTrans( $key ) {
536 $args = func_get_args();
537 array_shift( $args );
538 return wfMsgReal( $key, $args, true, false, false );
542 * Get a message from anywhere, for the current global language
543 * set with $wgLanguageCode.
545 * Use this if the message should NOT change dependent on the
546 * language set in the user's preferences. This is the case for
547 * most text written into logs, as well as link targets (such as
548 * the name of the copyright policy page). Link titles, on the
549 * other hand, should be shown in the UI language.
551 * Note that MediaWiki allows users to change the user interface
552 * language in their preferences, but a single installation
553 * typically only contains content in one language.
555 * Be wary of this distinction: If you use wfMsg() where you should
556 * use wfMsgForContent(), a user of the software may have to
557 * customize potentially hundreds of messages in
558 * order to, e.g., fix a link in every possible language.
560 * @param $key String: lookup key for the message, usually
561 * defined in languages/Language.php
563 function wfMsgForContent( $key ) {
564 global $wgForceUIMsgAsContentMsg;
565 $args = func_get_args();
566 array_shift( $args );
568 if( is_array( $wgForceUIMsgAsContentMsg ) &&
569 in_array( $key, $wgForceUIMsgAsContentMsg ) )
573 return wfMsgReal( $key, $args, true, $forcontent );
577 * Same as above except doesn't transform the message
579 function wfMsgForContentNoTrans( $key ) {
580 global $wgForceUIMsgAsContentMsg;
581 $args = func_get_args();
582 array_shift( $args );
584 if( is_array( $wgForceUIMsgAsContentMsg ) &&
585 in_array( $key, $wgForceUIMsgAsContentMsg ) )
589 return wfMsgReal( $key, $args, true, $forcontent, false );
593 * Get a message from the language file, for the UI elements
595 function wfMsgNoDB( $key ) {
596 $args = func_get_args();
597 array_shift( $args );
598 return wfMsgReal( $key, $args, false );
602 * Get a message from the language file, for the content
604 * @deprecated in 1.18; use wfMessage()
606 function wfMsgNoDBForContent( $key ) {
607 wfDeprecated( __FUNCTION__
);
608 global $wgForceUIMsgAsContentMsg;
609 $args = func_get_args();
610 array_shift( $args );
612 if( is_array( $wgForceUIMsgAsContentMsg ) &&
613 in_array( $key, $wgForceUIMsgAsContentMsg ) )
617 return wfMsgReal( $key, $args, false, $forcontent );
622 * Really get a message
623 * @param $key String: key to get.
625 * @param $useDB Boolean
626 * @param $forContent Mixed: Language code, or false for user lang, true for content lang.
627 * @param $transform Boolean: Whether or not to transform the message.
628 * @return String: the requested message.
630 function wfMsgReal( $key, $args, $useDB = true, $forContent = false, $transform = true ) {
631 wfProfileIn( __METHOD__
);
632 $message = wfMsgGetKey( $key, $useDB, $forContent, $transform );
633 $message = wfMsgReplaceArgs( $message, $args );
634 wfProfileOut( __METHOD__
);
639 * This function provides the message source for messages to be edited which are *not* stored in the database.
641 * @deprecated in 1.18; use wfMessage()
644 function wfMsgWeirdKey( $key ) {
645 wfDeprecated( __FUNCTION__
);
646 $source = wfMsgGetKey( $key, false, true, false );
647 if ( wfEmptyMsg( $key ) ) {
655 * Fetch a message string value, but don't replace any keys yet.
658 * @param $langCode String: Code of the language to get the message for, or
659 * behaves as a content language switch if it is a boolean.
660 * @param $transform Boolean: whether to parse magic words, etc.
663 function wfMsgGetKey( $key, $useDB, $langCode = false, $transform = true ) {
664 wfRunHooks( 'NormalizeMessageKey', array( &$key, &$useDB, &$langCode, &$transform ) );
666 $cache = MessageCache
::singleton();
667 $message = $cache->get( $key, $useDB, $langCode );
668 if( $message === false ) {
669 $message = '<' . htmlspecialchars( $key ) . '>';
670 } elseif ( $transform ) {
671 $message = $cache->transform( $message );
677 * Replace message parameter keys on the given formatted output.
679 * @param $message String
684 function wfMsgReplaceArgs( $message, $args ) {
685 # Fix windows line-endings
686 # Some messages are split with explode("\n", $msg)
687 $message = str_replace( "\r", '', $message );
690 if ( count( $args ) ) {
691 if ( is_array( $args[0] ) ) {
692 $args = array_values( $args[0] );
694 $replacementKeys = array();
695 foreach( $args as $n => $param ) {
696 $replacementKeys['$' . ( $n +
1 )] = $param;
698 $message = strtr( $message, $replacementKeys );
705 * Return an HTML-escaped version of a message.
706 * Parameter replacements, if any, are done *after* the HTML-escaping,
707 * so parameters may contain HTML (eg links or form controls). Be sure
708 * to pre-escape them if you really do want plaintext, or just wrap
709 * the whole thing in htmlspecialchars().
712 * @param string ... parameters
715 function wfMsgHtml( $key ) {
716 $args = func_get_args();
717 array_shift( $args );
718 return wfMsgReplaceArgs( htmlspecialchars( wfMsgGetKey( $key, true ) ), $args );
722 * Return an HTML version of message
723 * Parameter replacements, if any, are done *after* parsing the wiki-text message,
724 * so parameters may contain HTML (eg links or form controls). Be sure
725 * to pre-escape them if you really do want plaintext, or just wrap
726 * the whole thing in htmlspecialchars().
729 * @param string ... parameters
732 function wfMsgWikiHtml( $key ) {
733 $args = func_get_args();
734 array_shift( $args );
735 return wfMsgReplaceArgs(
736 MessageCache
::singleton()->parse( wfMsgGetKey( $key, true ), $key, /* can't be set to false */ true )->getText(),
741 * Returns message in the requested format
742 * @param $key String: key of the message
743 * @param $options Array: processing rules. Can take the following options:
744 * <i>parse</i>: parses wikitext to HTML
745 * <i>parseinline</i>: parses wikitext to HTML and removes the surrounding
746 * p's added by parser or tidy
747 * <i>escape</i>: filters message through htmlspecialchars
748 * <i>escapenoentities</i>: same, but allows entity references like   through
749 * <i>replaceafter</i>: parameters are substituted after parsing or escaping
750 * <i>parsemag</i>: transform the message using magic phrases
751 * <i>content</i>: fetch message for content language instead of interface
752 * Also can accept a single associative argument, of the form 'language' => 'xx':
753 * <i>language</i>: Language object or language code to fetch message for
754 * (overriden by <i>content</i>), its behaviour with parse, parseinline
755 * and parsemag is undefined.
756 * Behavior for conflicting options (e.g., parse+parseinline) is undefined.
758 function wfMsgExt( $key, $options ) {
759 $args = func_get_args();
760 array_shift( $args );
761 array_shift( $args );
762 $options = (array)$options;
764 foreach( $options as $arrayKey => $option ) {
765 if( !preg_match( '/^[0-9]+|language$/', $arrayKey ) ) {
766 # An unknown index, neither numeric nor "language"
767 wfWarn( "wfMsgExt called with incorrect parameter key $arrayKey", 1, E_USER_WARNING
);
768 } elseif( preg_match( '/^[0-9]+$/', $arrayKey ) && !in_array( $option,
769 array( 'parse', 'parseinline', 'escape', 'escapenoentities',
770 'replaceafter', 'parsemag', 'content' ) ) ) {
771 # A numeric index with unknown value
772 wfWarn( "wfMsgExt called with incorrect parameter $option", 1, E_USER_WARNING
);
776 if( in_array( 'content', $options, true ) ) {
780 } elseif( array_key_exists( 'language', $options ) ) {
782 $langCode = wfGetLangObj( $options['language'] );
783 $langCodeObj = $langCode;
790 $string = wfMsgGetKey( $key, /*DB*/true, $langCode, /*Transform*/false );
792 if( !in_array( 'replaceafter', $options, true ) ) {
793 $string = wfMsgReplaceArgs( $string, $args );
796 $messageCache = MessageCache
::singleton();
797 if( in_array( 'parse', $options, true ) ) {
798 $string = $messageCache->parse( $string, $key, true, !$forContent, $langCodeObj )->getText();
799 } elseif ( in_array( 'parseinline', $options, true ) ) {
800 $string = $messageCache->parse( $string, $key, true, !$forContent, $langCodeObj )->getText();
802 if( preg_match( '/^<p>(.*)\n?<\/p>\n?$/sU', $string, $m ) ) {
805 } elseif ( in_array( 'parsemag', $options, true ) ) {
806 $string = $messageCache->transform( $string,
807 !$forContent, $langCodeObj );
810 if ( in_array( 'escape', $options, true ) ) {
811 $string = htmlspecialchars ( $string );
812 } elseif ( in_array( 'escapenoentities', $options, true ) ) {
813 $string = Sanitizer
::escapeHtmlAllowEntities( $string );
816 if( in_array( 'replaceafter', $options, true ) ) {
817 $string = wfMsgReplaceArgs( $string, $args );
825 * Just like exit() but makes a note of it.
826 * Commits open transactions except if the error parameter is set
828 * @deprecated Please return control to the caller or throw an exception. Will
829 * be removed in 1.19.
831 function wfAbruptExit( $error = false ) {
832 static $called = false;
838 wfDeprecated( __FUNCTION__
);
839 $bt = wfDebugBacktrace();
841 for( $i = 0; $i < count( $bt ); $i++
) {
842 $file = isset( $bt[$i]['file'] ) ?
$bt[$i]['file'] : 'unknown';
843 $line = isset( $bt[$i]['line'] ) ?
$bt[$i]['line'] : 'unknown';
844 wfDebug( "WARNING: Abrupt exit in $file at line $line\n");
847 wfDebug( "WARNING: Abrupt exit\n" );
850 wfLogProfilingData();
853 wfGetLB()->closeAll();
859 * @deprecated Please return control the caller or throw an exception. Will
860 * be removed in 1.19.
862 function wfErrorExit() {
863 wfDeprecated( __FUNCTION__
);
864 wfAbruptExit( true );
868 * Print an error message and die, returning nonzero to the shell if any. Plain die()
869 * fails to return nonzero to the shell if you pass a string. Entry points may customise
870 * this function to return a prettier error message, but implementations must not assume
871 * access to any of the usual MediaWiki infrastructure (AutoLoader, localisation, database,
872 * etc). This should not be called directly once $wgFullyInitialised is set; instead,
873 * throw an exception and let Exception.php handle whether or not it's possible to show
877 if( !function_exists( 'wfDie' ) ){
878 function wfDie( $msg = '' ) {
885 * Throw a debugging exception. This function previously once exited the process,
886 * but now throws an exception instead, with similar results.
888 * @param $msg String: message shown when dieing.
890 function wfDebugDieBacktrace( $msg = '' ) {
891 throw new MWException( $msg );
895 * Fetch server name for use in error reporting etc.
896 * Use real server name if available, so we know which machine
897 * in a server farm generated the current page.
900 function wfHostname() {
902 if ( is_null( $host ) ) {
903 if ( function_exists( 'posix_uname' ) ) {
904 // This function not present on Windows
905 $uname = @posix_uname
();
909 if( is_array( $uname ) && isset( $uname['nodename'] ) ) {
910 $host = $uname['nodename'];
911 } elseif ( getenv( 'COMPUTERNAME' ) ) {
912 # Windows computer name
913 $host = getenv( 'COMPUTERNAME' );
915 # This may be a virtual server.
916 $host = $_SERVER['SERVER_NAME'];
923 * Returns a HTML comment with the elapsed time since request.
924 * This method has no side effects.
927 function wfReportTime() {
928 global $wgRequestTime, $wgShowHostnames;
931 $elapsed = $now - $wgRequestTime;
933 return $wgShowHostnames
934 ?
sprintf( '<!-- Served by %s in %01.3f secs. -->', wfHostname(), $elapsed )
935 : sprintf( '<!-- Served in %01.3f secs. -->', $elapsed );
939 * Safety wrapper for debug_backtrace().
941 * With Zend Optimizer 3.2.0 loaded, this causes segfaults under somewhat
942 * murky circumstances, which may be triggered in part by stub objects
943 * or other fancy talkin'.
945 * Will return an empty array if Zend Optimizer is detected or if
946 * debug_backtrace is disabled, otherwise the output from
947 * debug_backtrace() (trimmed).
949 * @return array of backtrace information
951 function wfDebugBacktrace() {
952 static $disabled = null;
954 if( extension_loaded( 'Zend Optimizer' ) ) {
955 wfDebug( "Zend Optimizer detected; skipping debug_backtrace for safety.\n" );
959 if ( is_null( $disabled ) ) {
961 $functions = explode( ',', ini_get( 'disable_functions' ) );
962 $functions = array_map( 'trim', $functions );
963 $functions = array_map( 'strtolower', $functions );
964 if ( in_array( 'debug_backtrace', $functions ) ) {
965 wfDebug( "debug_backtrace is in disabled_functions\n" );
973 return array_slice( debug_backtrace(), 1 );
976 function wfBacktrace() {
977 global $wgCommandLineMode;
979 if ( $wgCommandLineMode ) {
984 $backtrace = wfDebugBacktrace();
985 foreach( $backtrace as $call ) {
986 if( isset( $call['file'] ) ) {
987 $f = explode( DIRECTORY_SEPARATOR
, $call['file'] );
988 $file = $f[count( $f ) - 1];
992 if( isset( $call['line'] ) ) {
993 $line = $call['line'];
997 if ( $wgCommandLineMode ) {
998 $msg .= "$file line $line calls ";
1000 $msg .= '<li>' . $file . ' line ' . $line . ' calls ';
1002 if( !empty( $call['class'] ) ) {
1003 $msg .= $call['class'] . '::';
1005 $msg .= $call['function'] . '()';
1007 if ( $wgCommandLineMode ) {
1013 if ( $wgCommandLineMode ) {
1023 /* Some generic result counters, pulled out of SearchEngine */
1029 function wfShowingResults( $offset, $limit ) {
1033 array( 'parseinline' ),
1034 $wgLang->formatNum( $limit ),
1035 $wgLang->formatNum( $offset +
1 )
1042 function wfShowingResultsNum( $offset, $limit, $num ) {
1045 'showingresultsnum',
1046 array( 'parseinline' ),
1047 $wgLang->formatNum( $limit ),
1048 $wgLang->formatNum( $offset +
1 ),
1049 $wgLang->formatNum( $num )
1054 * Generate (prev x| next x) (20|50|100...) type links for paging
1055 * @param $offset String
1056 * @param $limit Integer
1057 * @param $link String
1058 * @param $query String: optional URL query parameter string
1059 * @param $atend Bool: optional param for specified if this is the last page
1061 function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) {
1063 $fmtLimit = $wgLang->formatNum( $limit );
1064 // FIXME: Why on earth this needs one message for the text and another one for tooltip??
1065 # Get prev/next link display text
1066 $prev = wfMsgExt( 'prevn', array( 'parsemag', 'escape' ), $fmtLimit );
1067 $next = wfMsgExt( 'nextn', array( 'parsemag', 'escape' ), $fmtLimit );
1068 # Get prev/next link title text
1069 $pTitle = wfMsgExt( 'prevn-title', array( 'parsemag', 'escape' ), $fmtLimit );
1070 $nTitle = wfMsgExt( 'nextn-title', array( 'parsemag', 'escape' ), $fmtLimit );
1071 # Fetch the title object
1072 if( is_object( $link ) ) {
1075 $title = Title
::newFromText( $link );
1076 if( is_null( $title ) ) {
1080 # Make 'previous' link
1081 if( 0 != $offset ) {
1082 $po = $offset - $limit;
1083 $po = max( $po, 0 );
1084 $q = "limit={$limit}&offset={$po}";
1085 if( $query != '' ) {
1088 $plink = '<a href="' . $title->escapeLocalURL( $q ) . "\" title=\"{$pTitle}\" class=\"mw-prevlink\">{$prev}</a>";
1093 $no = $offset +
$limit;
1094 $q = "limit={$limit}&offset={$no}";
1095 if( $query != '' ) {
1101 $nlink = '<a href="' . $title->escapeLocalURL( $q ) . "\" title=\"{$nTitle}\" class=\"mw-nextlink\">{$next}</a>";
1103 # Make links to set number of items per page
1104 $nums = $wgLang->pipeList( array(
1105 wfNumLink( $offset, 20, $title, $query ),
1106 wfNumLink( $offset, 50, $title, $query ),
1107 wfNumLink( $offset, 100, $title, $query ),
1108 wfNumLink( $offset, 250, $title, $query ),
1109 wfNumLink( $offset, 500, $title, $query )
1111 return wfMsgHtml( 'viewprevnext', $plink, $nlink, $nums );
1115 * Generate links for (20|50|100...) items-per-page links
1116 * @param $offset String
1117 * @param $limit Integer
1118 * @param $title Title
1119 * @param $query String: optional URL query parameter string
1121 function wfNumLink( $offset, $limit, $title, $query = '' ) {
1123 if( $query == '' ) {
1128 $q .= "limit={$limit}&offset={$offset}";
1129 $fmtLimit = $wgLang->formatNum( $limit );
1130 $lTitle = wfMsgExt( 'shown-title', array( 'parsemag', 'escape' ), $limit );
1131 $s = '<a href="' . $title->escapeLocalURL( $q ) . "\" title=\"{$lTitle}\" class=\"mw-numlink\">{$fmtLimit}</a>";
1137 * @todo FIXME: we may want to blacklist some broken browsers
1139 * @return bool Whereas client accept gzip compression
1141 function wfClientAcceptsGzip( $force = false ) {
1142 static $result = null;
1143 if ( $result === null ||
$force ) {
1145 if( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
1146 # FIXME: we may want to blacklist some broken browsers
1149 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
1150 $_SERVER['HTTP_ACCEPT_ENCODING'],
1154 if( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
1158 wfDebug( " accepts gzip\n" );
1167 * Obtain the offset and limit values from the request string;
1168 * used in special pages
1170 * @param $deflimit Default limit if none supplied
1171 * @param $optionname Name of a user preference to check against
1175 function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
1177 return $wgRequest->getLimitOffset( $deflimit, $optionname );
1181 * Escapes the given text so that it may be output using addWikiText()
1182 * without any linking, formatting, etc. making its way through. This
1183 * is achieved by substituting certain characters with HTML entities.
1184 * As required by the callers, <nowiki> is not used.
1186 * @param $text String: text to be escaped
1188 function wfEscapeWikiText( $text ) {
1189 $text = strtr( "\n$text", array(
1190 '"' => '"', '&' => '&', "'" => ''', '<' => '<',
1191 '=' => '=', '>' => '>', '[' => '[', ']' => ']',
1192 '{' => '{', '|' => '|', '}' => '}',
1193 "\n#" => "\n#", "\n*" => "\n*",
1194 "\n:" => "\n:", "\n;" => "\n;",
1195 '://' => '://', 'ISBN ' => 'ISBN ', 'RFC ' => 'RFC ',
1197 return substr( $text, 1 );
1205 return microtime( true );
1209 * Sets dest to source and returns the original value of dest
1210 * If source is NULL, it just returns the value, it doesn't set the variable
1211 * If force is true, it will set the value even if source is NULL
1213 function wfSetVar( &$dest, $source, $force = false ) {
1215 if ( !is_null( $source ) ||
$force ) {
1222 * As for wfSetVar except setting a bit
1224 function wfSetBit( &$dest, $bit, $state = true ) {
1225 $temp = (bool)( $dest & $bit );
1226 if ( !is_null( $state ) ) {
1237 * This function takes two arrays as input, and returns a CGI-style string, e.g.
1238 * "days=7&limit=100". Options in the first array override options in the second.
1239 * Options set to "" will not be output.
1241 function wfArrayToCGI( $array1, $array2 = null ) {
1242 if ( !is_null( $array2 ) ) {
1243 $array1 = $array1 +
$array2;
1247 foreach ( $array1 as $key => $value ) {
1248 if ( $value !== '' ) {
1252 if ( is_array( $value ) ) {
1254 foreach ( $value as $v ) {
1255 $cgi .= ( $firstTime ?
'' : '&') .
1256 urlencode( $key . '[]' ) . '=' .
1261 if ( is_object( $value ) ) {
1262 $value = $value->__toString();
1264 $cgi .= urlencode( $key ) . '=' .
1265 urlencode( $value );
1273 * This is the logical opposite of wfArrayToCGI(): it accepts a query string as
1274 * its argument and returns the same string in array form. This allows compa-
1275 * tibility with legacy functions that accept raw query strings instead of nice
1276 * arrays. Of course, keys and values are urldecode()d. Don't try passing in-
1277 * valid query strings, or it will explode.
1279 * @param $query String: query string
1280 * @return array Array version of input
1282 function wfCgiToArray( $query ) {
1283 if( isset( $query[0] ) && $query[0] == '?' ) {
1284 $query = substr( $query, 1 );
1286 $bits = explode( '&', $query );
1288 foreach( $bits as $bit ) {
1292 list( $key, $value ) = explode( '=', $bit );
1293 $key = urldecode( $key );
1294 $value = urldecode( $value );
1295 $ret[$key] = $value;
1301 * Append a query string to an existing URL, which may or may not already
1302 * have query string parameters already. If so, they will be combined.
1304 * @param $url String
1305 * @param $query Mixed: string or associative array
1308 function wfAppendQuery( $url, $query ) {
1309 if ( is_array( $query ) ) {
1310 $query = wfArrayToCGI( $query );
1312 if( $query != '' ) {
1313 if( false === strpos( $url, '?' ) ) {
1324 * Expand a potentially local URL to a fully-qualified URL. Assumes $wgServer
1325 * and $wgProto are correct.
1327 * @todo this won't work with current-path-relative URLs
1328 * like "subdir/foo.html", etc.
1330 * @param $url String: either fully-qualified or a local path + query
1331 * @return string Fully-qualified URL
1333 function wfExpandUrl( $url ) {
1334 if( substr( $url, 0, 2 ) == '//' ) {
1336 return $wgProto . ':' . $url;
1337 } elseif( substr( $url, 0, 1 ) == '/' ) {
1339 return $wgServer . $url;
1346 * Windows-compatible version of escapeshellarg()
1347 * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
1348 * function puts single quotes in regardless of OS.
1350 * Also fixes the locale problems on Linux in PHP 5.2.6+ (bug backported to
1351 * earlier distro releases of PHP)
1353 function wfEscapeShellArg( ) {
1354 wfInitShellLocale();
1356 $args = func_get_args();
1359 foreach ( $args as $arg ) {
1366 if ( wfIsWindows() ) {
1367 // Escaping for an MSVC-style command line parser and CMD.EXE
1369 // * http://web.archive.org/web/20020708081031/http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
1370 // * http://technet.microsoft.com/en-us/library/cc723564.aspx
1373 // Double the backslashes before any double quotes. Escape the double quotes.
1374 $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE
);
1377 foreach ( $tokens as $token ) {
1378 if ( $iteration %
2 == 1 ) {
1379 // Delimiter, a double quote preceded by zero or more slashes
1380 $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
1381 } elseif ( $iteration %
4 == 2 ) {
1382 // ^ in $token will be outside quotes, need to be escaped
1383 $arg .= str_replace( '^', '^^', $token );
1384 } else { // $iteration % 4 == 0
1385 // ^ in $token will appear inside double quotes, so leave as is
1390 // Double the backslashes before the end of the string, because
1391 // we will soon add a quote
1393 if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
1394 $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
1397 // Add surrounding quotes
1398 $retVal .= '"' . $arg . '"';
1400 $retVal .= escapeshellarg( $arg );
1407 * wfMerge attempts to merge differences between three texts.
1408 * Returns true for a clean merge and false for failure or a conflict.
1410 function wfMerge( $old, $mine, $yours, &$result ) {
1413 # This check may also protect against code injection in
1414 # case of broken installations.
1415 wfSuppressWarnings();
1416 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
1417 wfRestoreWarnings();
1420 wfDebug( "diff3 not found\n" );
1424 # Make temporary files
1426 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
1427 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
1428 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
1430 fwrite( $oldtextFile, $old );
1431 fclose( $oldtextFile );
1432 fwrite( $mytextFile, $mine );
1433 fclose( $mytextFile );
1434 fwrite( $yourtextFile, $yours );
1435 fclose( $yourtextFile );
1437 # Check for a conflict
1438 $cmd = $wgDiff3 . ' -a --overlap-only ' .
1439 wfEscapeShellArg( $mytextName ) . ' ' .
1440 wfEscapeShellArg( $oldtextName ) . ' ' .
1441 wfEscapeShellArg( $yourtextName );
1442 $handle = popen( $cmd, 'r' );
1444 if( fgets( $handle, 1024 ) ) {
1452 $cmd = $wgDiff3 . ' -a -e --merge ' .
1453 wfEscapeShellArg( $mytextName, $oldtextName, $yourtextName );
1454 $handle = popen( $cmd, 'r' );
1457 $data = fread( $handle, 8192 );
1458 if ( strlen( $data ) == 0 ) {
1464 unlink( $mytextName );
1465 unlink( $oldtextName );
1466 unlink( $yourtextName );
1468 if ( $result === '' && $old !== '' && !$conflict ) {
1469 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
1476 * Returns unified plain-text diff of two texts.
1477 * Useful for machine processing of diffs.
1478 * @param $before String: the text before the changes.
1479 * @param $after String: the text after the changes.
1480 * @param $params String: command-line options for the diff command.
1481 * @return String: unified diff of $before and $after
1483 function wfDiff( $before, $after, $params = '-u' ) {
1484 if ( $before == $after ) {
1489 wfSuppressWarnings();
1490 $haveDiff = $wgDiff && file_exists( $wgDiff );
1491 wfRestoreWarnings();
1493 # This check may also protect against code injection in
1494 # case of broken installations.
1496 wfDebug( "diff executable not found\n" );
1497 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
1498 $format = new UnifiedDiffFormatter();
1499 return $format->format( $diffs );
1502 # Make temporary files
1504 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
1505 $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
1507 fwrite( $oldtextFile, $before );
1508 fclose( $oldtextFile );
1509 fwrite( $newtextFile, $after );
1510 fclose( $newtextFile );
1512 // Get the diff of the two files
1513 $cmd = "$wgDiff " . $params . ' ' . wfEscapeShellArg( $oldtextName, $newtextName );
1515 $h = popen( $cmd, 'r' );
1520 $data = fread( $h, 8192 );
1521 if ( strlen( $data ) == 0 ) {
1529 unlink( $oldtextName );
1530 unlink( $newtextName );
1532 // Kill the --- and +++ lines. They're not useful.
1533 $diff_lines = explode( "\n", $diff );
1534 if ( strpos( $diff_lines[0], '---' ) === 0 ) {
1535 unset( $diff_lines[0] );
1537 if ( strpos( $diff_lines[1], '+++' ) === 0 ) {
1538 unset( $diff_lines[1] );
1541 $diff = implode( "\n", $diff_lines );
1547 * A wrapper around the PHP function var_export().
1548 * Either print it or add it to the regular output ($wgOut).
1550 * @param $var A PHP variable to dump.
1552 function wfVarDump( $var ) {
1554 $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
1555 if ( headers_sent() ||
!@is_object
( $wgOut ) ) {
1558 $wgOut->addHTML( $s );
1563 * Provide a simple HTTP error.
1565 function wfHttpError( $code, $label, $desc ) {
1568 header( "HTTP/1.0 $code $label" );
1569 header( "Status: $code $label" );
1570 $wgOut->sendCacheControl();
1572 header( 'Content-type: text/html; charset=utf-8' );
1573 print "<!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML 2.0//EN\">".
1574 '<html><head><title>' .
1575 htmlspecialchars( $label ) .
1576 '</title></head><body><h1>' .
1577 htmlspecialchars( $label ) .
1579 nl2br( htmlspecialchars( $desc ) ) .
1580 "</p></body></html>\n";
1584 * Clear away any user-level output buffers, discarding contents.
1586 * Suitable for 'starting afresh', for instance when streaming
1587 * relatively large amounts of data without buffering, or wanting to
1588 * output image files without ob_gzhandler's compression.
1590 * The optional $resetGzipEncoding parameter controls suppression of
1591 * the Content-Encoding header sent by ob_gzhandler; by default it
1592 * is left. See comments for wfClearOutputBuffers() for why it would
1595 * Note that some PHP configuration options may add output buffer
1596 * layers which cannot be removed; these are left in place.
1598 * @param $resetGzipEncoding Bool
1600 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
1601 if( $resetGzipEncoding ) {
1602 // Suppress Content-Encoding and Content-Length
1603 // headers from 1.10+s wfOutputHandler
1604 global $wgDisableOutputCompression;
1605 $wgDisableOutputCompression = true;
1607 while( $status = ob_get_status() ) {
1608 if( $status['type'] == 0 /* PHP_OUTPUT_HANDLER_INTERNAL */ ) {
1609 // Probably from zlib.output_compression or other
1610 // PHP-internal setting which can't be removed.
1612 // Give up, and hope the result doesn't break
1616 if( !ob_end_clean() ) {
1617 // Could not remove output buffer handler; abort now
1618 // to avoid getting in some kind of infinite loop.
1621 if( $resetGzipEncoding ) {
1622 if( $status['name'] == 'ob_gzhandler' ) {
1623 // Reset the 'Content-Encoding' field set by this handler
1624 // so we can start fresh.
1625 if ( function_exists( 'header_remove' ) ) {
1626 // Available since PHP 5.3.0
1627 header_remove( 'Content-Encoding' );
1629 // We need to provide a valid content-coding. See bug 28069
1630 header( 'Content-Encoding: identity' );
1639 * More legible than passing a 'false' parameter to wfResetOutputBuffers():
1641 * Clear away output buffers, but keep the Content-Encoding header
1642 * produced by ob_gzhandler, if any.
1644 * This should be used for HTTP 304 responses, where you need to
1645 * preserve the Content-Encoding header of the real result, but
1646 * also need to suppress the output of ob_gzhandler to keep to spec
1647 * and avoid breaking Firefox in rare cases where the headers and
1648 * body are broken over two packets.
1650 function wfClearOutputBuffers() {
1651 wfResetOutputBuffers( false );
1655 * Converts an Accept-* header into an array mapping string values to quality
1658 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
1659 # No arg means accept anything (per HTTP spec)
1661 return array( $def => 1.0 );
1666 $parts = explode( ',', $accept );
1668 foreach( $parts as $part ) {
1669 # FIXME: doesn't deal with params like 'text/html; level=1'
1670 @list
( $value, $qpart ) = explode( ';', trim( $part ) );
1672 if( !isset( $qpart ) ) {
1673 $prefs[$value] = 1.0;
1674 } elseif( preg_match( '/q\s*=\s*(\d*\.\d+)/', $qpart, $match ) ) {
1675 $prefs[$value] = floatval( $match[1] );
1683 * Checks if a given MIME type matches any of the keys in the given
1684 * array. Basic wildcards are accepted in the array keys.
1686 * Returns the matching MIME type (or wildcard) if a match, otherwise
1689 * @param $type String
1690 * @param $avail Array
1694 function mimeTypeMatch( $type, $avail ) {
1695 if( array_key_exists( $type, $avail ) ) {
1698 $parts = explode( '/', $type );
1699 if( array_key_exists( $parts[0] . '/*', $avail ) ) {
1700 return $parts[0] . '/*';
1701 } elseif( array_key_exists( '*/*', $avail ) ) {
1710 * Returns the 'best' match between a client's requested internet media types
1711 * and the server's list of available types. Each list should be an associative
1712 * array of type to preference (preference is a float between 0.0 and 1.0).
1713 * Wildcards in the types are acceptable.
1715 * @param $cprefs Array: client's acceptable type list
1716 * @param $sprefs Array: server's offered types
1719 * @todo FIXME: doesn't handle params like 'text/plain; charset=UTF-8'
1720 * XXX: generalize to negotiate other stuff
1722 function wfNegotiateType( $cprefs, $sprefs ) {
1725 foreach( array_keys($sprefs) as $type ) {
1726 $parts = explode( '/', $type );
1727 if( $parts[1] != '*' ) {
1728 $ckey = mimeTypeMatch( $type, $cprefs );
1730 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1735 foreach( array_keys( $cprefs ) as $type ) {
1736 $parts = explode( '/', $type );
1737 if( $parts[1] != '*' && !array_key_exists( $type, $sprefs ) ) {
1738 $skey = mimeTypeMatch( $type, $sprefs );
1740 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1748 foreach( array_keys( $combine ) as $type ) {
1749 if( $combine[$type] > $bestq ) {
1751 $bestq = $combine[$type];
1760 * Returns an array where the values in the first array are replaced by the
1761 * values in the second array with the corresponding keys
1765 function wfArrayLookup( $a, $b ) {
1766 return array_flip( array_intersect( array_flip( $a ), array_keys( $b ) ) );
1770 * Convenience function; returns MediaWiki timestamp for the present time.
1773 function wfTimestampNow() {
1775 return wfTimestamp( TS_MW
, time() );
1779 * Reference-counted warning suppression
1781 function wfSuppressWarnings( $end = false ) {
1782 static $suppressCount = 0;
1783 static $originalLevel = false;
1786 if ( $suppressCount ) {
1788 if ( !$suppressCount ) {
1789 error_reporting( $originalLevel );
1793 if ( !$suppressCount ) {
1794 // E_DEPRECATED is undefined in PHP 5.2
1795 if( !defined( 'E_DEPRECATED' ) ){
1796 define( 'E_DEPRECATED', 8192 );
1798 $originalLevel = error_reporting( E_ALL
& ~
( E_WARNING | E_NOTICE | E_USER_WARNING | E_USER_NOTICE | E_DEPRECATED
) );
1805 * Restore error level to previous value
1807 function wfRestoreWarnings() {
1808 wfSuppressWarnings( true );
1811 # Autodetect, convert and provide timestamps of various types
1814 * Unix time - the number of seconds since 1970-01-01 00:00:00 UTC
1816 define( 'TS_UNIX', 0 );
1819 * MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
1821 define( 'TS_MW', 1 );
1824 * MySQL DATETIME (YYYY-MM-DD HH:MM:SS)
1826 define( 'TS_DB', 2 );
1829 * RFC 2822 format, for E-mail and HTTP headers
1831 define( 'TS_RFC2822', 3 );
1834 * ISO 8601 format with no timezone: 1986-02-09T20:00:00Z
1836 * This is used by Special:Export
1838 define( 'TS_ISO_8601', 4 );
1841 * An Exif timestamp (YYYY:MM:DD HH:MM:SS)
1843 * @see http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the
1844 * DateTime tag and page 36 for the DateTimeOriginal and
1845 * DateTimeDigitized tags.
1847 define( 'TS_EXIF', 5 );
1850 * Oracle format time.
1852 define( 'TS_ORACLE', 6 );
1855 * Postgres format time.
1857 define( 'TS_POSTGRES', 7 );
1862 define( 'TS_DB2', 8 );
1865 * ISO 8601 basic format with no timezone: 19860209T200000Z
1867 * This is used by ResourceLoader
1869 define( 'TS_ISO_8601_BASIC', 9 );
1872 * @param $outputtype Mixed: A timestamp in one of the supported formats, the
1873 * function will autodetect which format is supplied and act
1875 * @param $ts Mixed: the timestamp to convert or 0 for the current timestamp
1876 * @return Mixed: String / false The same date in the format specified in $outputtype or false
1878 function wfTimestamp( $outputtype = TS_UNIX
, $ts = 0 ) {
1883 if ( !$ts ) { // We want to catch 0, '', null... but not date strings starting with a letter.
1886 } elseif ( preg_match( '/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)$/D', $ts, $da ) ) {
1888 } elseif ( preg_match( '/^(\d{4}):(\d\d):(\d\d) (\d\d):(\d\d):(\d\d)$/D', $ts, $da ) ) {
1890 } elseif ( preg_match( '/^(\d{4})(\d\d)(\d\d)(\d\d)(\d\d)(\d\d)$/D', $ts, $da ) ) {
1892 } elseif ( preg_match( '/^-?\d{1,13}$/D', $ts ) ) {
1895 $strtime = "@$ts"; // Undocumented?
1896 } elseif ( preg_match( '/^\d{2}-\d{2}-\d{4} \d{2}:\d{2}:\d{2}.\d{6}$/', $ts ) ) {
1897 # TS_ORACLE // session altered to DD-MM-YYYY HH24:MI:SS.FF6
1898 $strtime = preg_replace( '/(\d\d)\.(\d\d)\.(\d\d)(\.(\d+))?/', "$1:$2:$3",
1899 str_replace( '+00:00', 'UTC', $ts ) );
1900 } elseif ( preg_match( '/^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})(?:\.*\d*)?Z$/', $ts, $da ) ) {
1902 } elseif ( preg_match( '/^(\d{4})(\d{2})(\d{2})T(\d{2})(\d{2})(\d{2})(?:\.*\d*)?Z$/', $ts, $da ) ) {
1904 } elseif ( preg_match( '/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)\.*\d*[\+\- ](\d\d)$/', $ts, $da ) ) {
1906 } elseif ( preg_match( '/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)\.*\d* GMT$/', $ts, $da ) ) {
1908 } elseif (preg_match('/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)\.\d\d\d$/',$ts,$da)) {
1910 } elseif ( preg_match( '/^[ \t\r\n]*([A-Z][a-z]{2},[ \t\r\n]*)?' . # Day of week
1911 '\d\d?[ \t\r\n]*[A-Z][a-z]{2}[ \t\r\n]*\d{2}(?:\d{2})?' . # dd Mon yyyy
1912 '[ \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
1913 # TS_RFC2822, accepting a trailing comment. See http://www.squid-cache.org/mail-archive/squid-users/200307/0122.html / r77171
1914 # The regex is a superset of rfc2822 for readability
1915 $strtime = strtok( $ts, ';' );
1916 } 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 ) ) {
1919 } 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 ) ) {
1924 wfDebug("wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n");
1931 static $formats = array(
1934 TS_DB
=> 'Y-m-d H:i:s',
1935 TS_ISO_8601
=> 'Y-m-d\TH:i:s\Z',
1936 TS_ISO_8601_BASIC
=> 'Ymd\THis\Z',
1937 TS_EXIF
=> 'Y:m:d H:i:s', // This shouldn't ever be used, but is included for completeness
1938 TS_RFC2822
=> 'D, d M Y H:i:s',
1939 TS_ORACLE
=> 'd-m-Y H:i:s.000000', // Was 'd-M-y h.i.s A' . ' +00:00' before r51500
1940 TS_POSTGRES
=> 'Y-m-d H:i:s',
1941 TS_DB2
=> 'Y-m-d H:i:s',
1944 if ( !isset( $formats[$outputtype] ) ) {
1945 throw new MWException( 'wfTimestamp() called with illegal output type.' );
1948 if ( function_exists( "date_create" ) ) {
1949 if ( count( $da ) ) {
1950 $ds = sprintf("%04d-%02d-%02dT%02d:%02d:%02d.00+00:00",
1951 (int)$da[1], (int)$da[2], (int)$da[3],
1952 (int)$da[4], (int)$da[5], (int)$da[6]);
1954 $d = date_create( $ds, new DateTimeZone( 'GMT' ) );
1955 } elseif ( $strtime ) {
1956 $d = date_create( $strtime, new DateTimeZone( 'GMT' ) );
1962 wfDebug("wfTimestamp() fed bogus time value: $outputtype; $ts\n");
1966 $output = $d->format( $formats[$outputtype] );
1968 if ( count( $da ) ) {
1969 // Warning! gmmktime() acts oddly if the month or day is set to 0
1970 // We may want to handle that explicitly at some point
1971 $uts = gmmktime( (int)$da[4], (int)$da[5], (int)$da[6],
1972 (int)$da[2], (int)$da[3], (int)$da[1] );
1973 } elseif ( $strtime ) {
1974 $uts = strtotime( $strtime );
1977 if ( $uts === false ) {
1978 wfDebug("wfTimestamp() can't parse the timestamp (non 32-bit time? Update php): $outputtype; $ts\n");
1982 if ( TS_UNIX
== $outputtype ) {
1985 $output = gmdate( $formats[$outputtype], $uts );
1988 if ( ( $outputtype == TS_RFC2822
) ||
( $outputtype == TS_POSTGRES
) ) {
1996 * Return a formatted timestamp, or null if input is null.
1997 * For dealing with nullable timestamp columns in the database.
1998 * @param $outputtype Integer
2002 function wfTimestampOrNull( $outputtype = TS_UNIX
, $ts = null ) {
2003 if( is_null( $ts ) ) {
2006 return wfTimestamp( $outputtype, $ts );
2011 * Check if the operating system is Windows
2013 * @return Bool: true if it's Windows, False otherwise.
2015 function wfIsWindows() {
2016 static $isWindows = null;
2017 if ( $isWindows === null ) {
2018 $isWindows = substr( php_uname(), 0, 7 ) == 'Windows';
2024 * Check if we are running under HipHop
2026 function wfIsHipHop() {
2027 return function_exists( 'hphp_thread_set_warmup_enabled' );
2031 * Swap two variables
2033 function swap( &$x, &$y ) {
2040 * BC wrapper for MimeMagic::singleton()
2041 * @deprecated No longer needed as of 1.17 (r68836). Remove in 1.19.
2043 function &wfGetMimeMagic() {
2044 wfDeprecated( __FUNCTION__
);
2045 return MimeMagic
::singleton();
2049 * Tries to get the system directory for temporary files. The TMPDIR, TMP, and
2050 * TEMP environment variables are then checked in sequence, and if none are set
2051 * try sys_get_temp_dir() for PHP >= 5.2.1. All else fails, return /tmp for Unix
2052 * or C:\Windows\Temp for Windows and hope for the best.
2053 * It is common to call it with tempnam().
2055 * NOTE: When possible, use instead the tmpfile() function to create
2056 * temporary files to avoid race conditions on file creation, etc.
2060 function wfTempDir() {
2061 foreach( array( 'TMPDIR', 'TMP', 'TEMP' ) as $var ) {
2062 $tmp = getenv( $var );
2063 if( $tmp && file_exists( $tmp ) && is_dir( $tmp ) && is_writable( $tmp ) ) {
2067 if( function_exists( 'sys_get_temp_dir' ) ) {
2068 return sys_get_temp_dir();
2071 return wfIsWindows() ?
'C:\Windows\Temp' : '/tmp';
2075 * Make directory, and make all parent directories if they don't exist
2077 * @param $dir String: full path to directory to create
2078 * @param $mode Integer: chmod value to use, default is $wgDirectoryMode
2079 * @param $caller String: optional caller param for debugging.
2082 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2083 global $wgDirectoryMode;
2085 if ( !is_null( $caller ) ) {
2086 wfDebug( "$caller: called wfMkdirParents($dir)" );
2089 if( strval( $dir ) === '' ||
file_exists( $dir ) ) {
2093 $dir = str_replace( array( '\\', '/' ), DIRECTORY_SEPARATOR
, $dir );
2095 if ( is_null( $mode ) ) {
2096 $mode = $wgDirectoryMode;
2099 // Turn off the normal warning, we're doing our own below
2100 wfSuppressWarnings();
2101 $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2102 wfRestoreWarnings();
2105 // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2106 trigger_error( __FUNCTION__
. ": failed to mkdir \"$dir\" mode $mode", E_USER_WARNING
);
2112 * Increment a statistics counter
2114 function wfIncrStats( $key, $count = 1 ) {
2115 global $wgStatsMethod;
2117 $count = intval( $count );
2119 if( $wgStatsMethod == 'udp' ) {
2120 global $wgUDPProfilerHost, $wgUDPProfilerPort, $wgDBname, $wgAggregateStatsID;
2123 $id = $wgAggregateStatsID !== false ?
$wgAggregateStatsID : $wgDBname;
2126 $socket = socket_create( AF_INET
, SOCK_DGRAM
, SOL_UDP
);
2127 $statline = "stats/{$id} - {$count} 1 1 1 1 -total\n";
2131 strlen( $statline ),
2137 $statline = "stats/{$id} - {$count} 1 1 1 1 {$key}\n";
2138 wfSuppressWarnings();
2142 strlen( $statline ),
2147 wfRestoreWarnings();
2148 } elseif( $wgStatsMethod == 'cache' ) {
2150 $key = wfMemcKey( 'stats', $key );
2151 if ( is_null( $wgMemc->incr( $key, $count ) ) ) {
2152 $wgMemc->add( $key, $count );
2160 * @param $nr Mixed: the number to format
2161 * @param $acc Integer: the number of digits after the decimal point, default 2
2162 * @param $round Boolean: whether or not to round the value, default true
2165 function wfPercent( $nr, $acc = 2, $round = true ) {
2166 $ret = sprintf( "%.${acc}f", $nr );
2167 return $round ?
round( $ret, $acc ) . '%' : "$ret%";
2171 * Encrypt a username/password.
2173 * @param $userid Integer: ID of the user
2174 * @param $password String: password of the user
2175 * @return String: hashed password
2176 * @deprecated Use User::crypt() or User::oldCrypt() instead
2178 function wfEncryptPassword( $userid, $password ) {
2179 wfDeprecated(__FUNCTION__
);
2180 # Just wrap around User::oldCrypt()
2181 return User
::oldCrypt( $password, $userid );
2185 * Appends to second array if $value differs from that in $default
2187 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
2188 if ( is_null( $changed ) ) {
2189 throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' );
2191 if ( $default[$key] !== $value ) {
2192 $changed[$key] = $value;
2197 * Since wfMsg() and co suck, they don't return false if the message key they
2198 * looked up didn't exist but a XHTML string, this function checks for the
2199 * nonexistance of messages by looking at wfMsg() output
2201 * @param $key String: the message key looked up
2202 * @return Boolean True if the message *doesn't* exist.
2204 function wfEmptyMsg( $key ) {
2205 return MessageCache
::singleton()->get( $key, /*useDB*/true, /*content*/false ) === false;
2209 * Find out whether or not a mixed variable exists in a string
2211 * @param $needle String
2212 * @param $str String
2213 * @param $insensitive Boolean
2216 function in_string( $needle, $str, $insensitive = false ) {
2218 if( $insensitive ) $func = 'stripos';
2220 return $func( $str, $needle ) !== false;
2223 function wfSpecialList( $page, $details ) {
2225 $details = $details ?
' ' . $wgContLang->getDirMark() . "($details)" : '';
2226 return $page . $details;
2230 * Returns a regular expression of url protocols
2234 function wfUrlProtocols() {
2235 global $wgUrlProtocols;
2237 static $retval = null;
2238 if ( !is_null( $retval ) ) {
2242 // Support old-style $wgUrlProtocols strings, for backwards compatibility
2243 // with LocalSettings files from 1.5
2244 if ( is_array( $wgUrlProtocols ) ) {
2245 $protocols = array();
2246 foreach ( $wgUrlProtocols as $protocol ) {
2247 $protocols[] = preg_quote( $protocol, '/' );
2250 $retval = implode( '|', $protocols );
2252 $retval = $wgUrlProtocols;
2258 * Safety wrapper around ini_get() for boolean settings.
2259 * The values returned from ini_get() are pre-normalized for settings
2260 * set via php.ini or php_flag/php_admin_flag... but *not*
2261 * for those set via php_value/php_admin_value.
2263 * It's fairly common for people to use php_value instead of php_flag,
2264 * which can leave you with an 'off' setting giving a false positive
2265 * for code that just takes the ini_get() return value as a boolean.
2267 * To make things extra interesting, setting via php_value accepts
2268 * "true" and "yes" as true, but php.ini and php_flag consider them false. :)
2269 * Unrecognized values go false... again opposite PHP's own coercion
2270 * from string to bool.
2272 * Luckily, 'properly' set settings will always come back as '0' or '1',
2273 * so we only have to worry about them and the 'improper' settings.
2275 * I frickin' hate PHP... :P
2277 * @param $setting String
2280 function wfIniGetBool( $setting ) {
2281 $val = ini_get( $setting );
2282 // 'on' and 'true' can't have whitespace around them, but '1' can.
2283 return strtolower( $val ) == 'on'
2284 ||
strtolower( $val ) == 'true'
2285 ||
strtolower( $val ) == 'yes'
2286 ||
preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2290 * Wrapper function for PHP's dl(). This doesn't work in most situations from
2291 * PHP 5.3 onward, and is usually disabled in shared environments anyway.
2293 * @param $extension String A PHP extension. The file suffix (.so or .dll)
2295 * @param $fileName String Name of the library, if not $extension.suffix
2296 * @return Bool - Whether or not the extension is loaded
2298 function wfDl( $extension, $fileName = null ) {
2299 if( extension_loaded( $extension ) ) {
2304 $sapi = php_sapi_name();
2305 if( version_compare( PHP_VERSION
, '5.3.0', '<' ) ||
2306 $sapi == 'cli' ||
$sapi == 'cgi' ||
$sapi == 'embed' )
2308 $canDl = ( function_exists( 'dl' ) && is_callable( 'dl' )
2309 && wfIniGetBool( 'enable_dl' ) && !wfIniGetBool( 'safe_mode' ) );
2313 $fileName = $fileName ?
$fileName : $extension;
2314 if( wfIsWindows() ) {
2315 $fileName = 'php_' . $fileName;
2317 wfSuppressWarnings();
2318 dl( $fileName . '.' . PHP_SHLIB_SUFFIX
);
2319 wfRestoreWarnings();
2321 return extension_loaded( $extension );
2325 * Execute a shell command, with time and memory limits mirrored from the PHP
2326 * configuration if supported.
2327 * @param $cmd String Command line, properly escaped for shell.
2328 * @param &$retval optional, will receive the program's exit code.
2329 * (non-zero is usually failure)
2330 * @param $environ Array optional environment variables which should be
2331 * added to the executed command environment.
2332 * @return collected stdout as a string (trailing newlines stripped)
2334 function wfShellExec( $cmd, &$retval = null, $environ = array() ) {
2335 global $IP, $wgMaxShellMemory, $wgMaxShellFileSize, $wgMaxShellTime;
2338 if ( is_null( $disabled ) ) {
2340 if( wfIniGetBool( 'safe_mode' ) ) {
2341 wfDebug( "wfShellExec can't run in safe_mode, PHP's exec functions are too broken.\n" );
2342 $disabled = 'safemode';
2344 $functions = explode( ',', ini_get( 'disable_functions' ) );
2345 $functions = array_map( 'trim', $functions );
2346 $functions = array_map( 'strtolower', $functions );
2347 if ( in_array( 'passthru', $functions ) ) {
2348 wfDebug( "passthru is in disabled_functions\n" );
2349 $disabled = 'passthru';
2355 return $disabled == 'safemode' ?
2356 'Unable to run external programs in safe mode.' :
2357 'Unable to run external programs, passthru() is disabled.';
2360 wfInitShellLocale();
2363 foreach( $environ as $k => $v ) {
2364 if ( wfIsWindows() ) {
2365 /* Surrounding a set in quotes (method used by wfEscapeShellArg) makes the quotes themselves
2366 * appear in the environment variable, so we must use carat escaping as documented in
2367 * http://technet.microsoft.com/en-us/library/cc723564.aspx
2368 * Note however that the quote isn't listed there, but is needed, and the parentheses
2369 * are listed there but doesn't appear to need it.
2371 $envcmd .= "set $k=" . preg_replace( '/([&|()<>^"])/', '^\\1', $v ) . '&& ';
2373 /* Assume this is a POSIX shell, thus required to accept variable assignments before the command
2374 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_09_01
2376 $envcmd .= "$k=" . escapeshellarg( $v ) . ' ';
2379 $cmd = $envcmd . $cmd;
2381 if ( wfIsWindows() ) {
2382 if ( version_compare( PHP_VERSION
, '5.3.0', '<' ) && /* Fixed in 5.3.0 :) */
2383 ( version_compare( PHP_VERSION
, '5.2.1', '>=' ) ||
php_uname( 's' ) == 'Windows NT' ) )
2385 # Hack to work around PHP's flawed invocation of cmd.exe
2386 # http://news.php.net/php.internals/21796
2387 # Windows 9x doesn't accept any kind of quotes
2388 $cmd = '"' . $cmd . '"';
2390 } elseif ( php_uname( 's' ) == 'Linux' ) {
2391 $time = intval( $wgMaxShellTime );
2392 $mem = intval( $wgMaxShellMemory );
2393 $filesize = intval( $wgMaxShellFileSize );
2395 if ( $time > 0 && $mem > 0 ) {
2396 $script = "$IP/bin/ulimit4.sh";
2397 if ( is_executable( $script ) ) {
2398 $cmd = '/bin/bash ' . escapeshellarg( $script ) . " $time $mem $filesize " . escapeshellarg( $cmd );
2402 wfDebug( "wfShellExec: $cmd\n" );
2404 $retval = 1; // error by default?
2406 passthru( $cmd, $retval );
2407 $output = ob_get_contents();
2410 if ( $retval == 127 ) {
2411 wfDebugLog( 'exec', "Possibly missing executable file: $cmd\n" );
2417 * Workaround for http://bugs.php.net/bug.php?id=45132
2418 * escapeshellarg() destroys non-ASCII characters if LANG is not a UTF-8 locale
2420 function wfInitShellLocale() {
2421 static $done = false;
2426 global $wgShellLocale;
2427 if ( !wfIniGetBool( 'safe_mode' ) ) {
2428 putenv( "LC_CTYPE=$wgShellLocale" );
2429 setlocale( LC_CTYPE
, $wgShellLocale );
2434 * This function works like "use VERSION" in Perl, the program will die with a
2435 * backtrace if the current version of PHP is less than the version provided
2437 * This is useful for extensions which due to their nature are not kept in sync
2438 * with releases, and might depend on other versions of PHP than the main code
2440 * Note: PHP might die due to parsing errors in some cases before it ever
2441 * manages to call this function, such is life
2443 * @see perldoc -f use
2445 * @param $req_ver Mixed: the version to check, can be a string, an integer, or
2448 function wfUsePHP( $req_ver ) {
2449 $php_ver = PHP_VERSION
;
2451 if ( version_compare( $php_ver, (string)$req_ver, '<' ) ) {
2452 throw new MWException( "PHP $req_ver required--this is only $php_ver" );
2457 * This function works like "use VERSION" in Perl except it checks the version
2458 * of MediaWiki, the program will die with a backtrace if the current version
2459 * of MediaWiki is less than the version provided.
2461 * This is useful for extensions which due to their nature are not kept in sync
2464 * @see perldoc -f use
2466 * @param $req_ver Mixed: the version to check, can be a string, an integer, or
2469 function wfUseMW( $req_ver ) {
2472 if ( version_compare( $wgVersion, (string)$req_ver, '<' ) ) {
2473 throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
2478 * Return the final portion of a pathname.
2479 * Reimplemented because PHP5's basename() is buggy with multibyte text.
2480 * http://bugs.php.net/bug.php?id=33898
2482 * PHP's basename() only considers '\' a pathchar on Windows and Netware.
2483 * We'll consider it so always, as we don't want \s in our Unix paths either.
2485 * @param $path String
2486 * @param $suffix String: to remove if present
2489 function wfBaseName( $path, $suffix = '' ) {
2490 $encSuffix = ( $suffix == '' )
2492 : ( '(?:' . preg_quote( $suffix, '#' ) . ')?' );
2494 if( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
2502 * Generate a relative path name to the given file.
2503 * May explode on non-matching case-insensitive paths,
2504 * funky symlinks, etc.
2506 * @param $path String: absolute destination path including target filename
2507 * @param $from String: Absolute source path, directory only
2510 function wfRelativePath( $path, $from ) {
2511 // Normalize mixed input on Windows...
2512 $path = str_replace( '/', DIRECTORY_SEPARATOR
, $path );
2513 $from = str_replace( '/', DIRECTORY_SEPARATOR
, $from );
2515 // Trim trailing slashes -- fix for drive root
2516 $path = rtrim( $path, DIRECTORY_SEPARATOR
);
2517 $from = rtrim( $from, DIRECTORY_SEPARATOR
);
2519 $pieces = explode( DIRECTORY_SEPARATOR
, dirname( $path ) );
2520 $against = explode( DIRECTORY_SEPARATOR
, $from );
2522 if( $pieces[0] !== $against[0] ) {
2523 // Non-matching Windows drive letters?
2524 // Return a full path.
2528 // Trim off common prefix
2529 while( count( $pieces ) && count( $against )
2530 && $pieces[0] == $against[0] ) {
2531 array_shift( $pieces );
2532 array_shift( $against );
2535 // relative dots to bump us to the parent
2536 while( count( $against ) ) {
2537 array_unshift( $pieces, '..' );
2538 array_shift( $against );
2541 array_push( $pieces, wfBaseName( $path ) );
2543 return implode( DIRECTORY_SEPARATOR
, $pieces );
2547 * Backwards array plus for people who haven't bothered to read the PHP manual
2548 * XXX: will not darn your socks for you.
2550 * @param $array1 Array
2551 * @param [$array2, [...]] Arrays
2554 function wfArrayMerge( $array1/* ... */ ) {
2555 $args = func_get_args();
2556 $args = array_reverse( $args, true );
2558 foreach ( $args as $arg ) {
2565 * Merge arrays in the style of getUserPermissionsErrors, with duplicate removal
2567 * wfMergeErrorArrays(
2568 * array( array( 'x' ) ),
2569 * array( array( 'x', '2' ) ),
2570 * array( array( 'x' ) ),
2571 * array( array( 'y') )
2575 * array( 'x', '2' ),
2580 function wfMergeErrorArrays( /*...*/ ) {
2581 $args = func_get_args();
2583 foreach ( $args as $errors ) {
2584 foreach ( $errors as $params ) {
2585 # FIXME: sometimes get nested arrays for $params,
2586 # which leads to E_NOTICEs
2587 $spec = implode( "\t", $params );
2588 $out[$spec] = $params;
2591 return array_values( $out );
2595 * parse_url() work-alike, but non-broken. Differences:
2597 * 1) Does not raise warnings on bad URLs (just returns false)
2598 * 2) Handles protocols that don't use :// (e.g., mailto: and news:) correctly
2599 * 3) Adds a "delimiter" element to the array, either '://' or ':' (see (2))
2601 * @param $url String: a URL to parse
2602 * @return Array: bits of the URL in an associative array, per PHP docs
2604 function wfParseUrl( $url ) {
2605 global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
2606 wfSuppressWarnings();
2607 $bits = parse_url( $url );
2608 wfRestoreWarnings();
2613 // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
2614 if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
2615 $bits['delimiter'] = '://';
2616 } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
2617 $bits['delimiter'] = ':';
2618 // parse_url detects for news: and mailto: the host part of an url as path
2619 // We have to correct this wrong detection
2620 if ( isset( $bits['path'] ) ) {
2621 $bits['host'] = $bits['path'];
2632 * Make a URL index, appropriate for the el_index field of externallinks.
2634 function wfMakeUrlIndex( $url ) {
2635 $bits = wfParseUrl( $url );
2637 // Reverse the labels in the hostname, convert to lower case
2638 // For emails reverse domainpart only
2639 if ( $bits['scheme'] == 'mailto' ) {
2640 $mailparts = explode( '@', $bits['host'], 2 );
2641 if ( count( $mailparts ) === 2 ) {
2642 $domainpart = strtolower( implode( '.', array_reverse( explode( '.', $mailparts[1] ) ) ) );
2644 // No domain specified, don't mangle it
2647 $reversedHost = $domainpart . '@' . $mailparts[0];
2649 $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) );
2651 // Add an extra dot to the end
2652 // Why? Is it in wrong place in mailto links?
2653 if ( substr( $reversedHost, -1, 1 ) !== '.' ) {
2654 $reversedHost .= '.';
2656 // Reconstruct the pseudo-URL
2657 $prot = $bits['scheme'];
2658 $index = $prot . $bits['delimiter'] . $reversedHost;
2659 // Leave out user and password. Add the port, path, query and fragment
2660 if ( isset( $bits['port'] ) ) {
2661 $index .= ':' . $bits['port'];
2663 if ( isset( $bits['path'] ) ) {
2664 $index .= $bits['path'];
2668 if ( isset( $bits['query'] ) ) {
2669 $index .= '?' . $bits['query'];
2671 if ( isset( $bits['fragment'] ) ) {
2672 $index .= '#' . $bits['fragment'];
2678 * Do any deferred updates and clear the list
2680 * @param $commit String: set to 'commit' to commit after every update to
2681 * prevent lock contention
2683 function wfDoUpdates( $commit = '' ) {
2684 global $wgDeferredUpdateList;
2686 wfProfileIn( __METHOD__
);
2688 // No need to get master connections in case of empty updates array
2689 if ( !count( $wgDeferredUpdateList ) ) {
2690 wfProfileOut( __METHOD__
);
2694 $doCommit = $commit == 'commit';
2696 $dbw = wfGetDB( DB_MASTER
);
2699 foreach ( $wgDeferredUpdateList as $update ) {
2700 $update->doUpdate();
2702 if ( $doCommit && $dbw->trxLevel() ) {
2707 $wgDeferredUpdateList = array();
2708 wfProfileOut( __METHOD__
);
2712 * Convert an arbitrarily-long digit string from one numeric base
2713 * to another, optionally zero-padding to a minimum column width.
2715 * Supports base 2 through 36; digit values 10-36 are represented
2716 * as lowercase letters a-z. Input is case-insensitive.
2718 * @param $input String: of digits
2719 * @param $sourceBase Integer: 2-36
2720 * @param $destBase Integer: 2-36
2721 * @param $pad Integer: 1 or greater
2722 * @param $lowercase Boolean
2723 * @return String or false on invalid input
2725 function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1, $lowercase = true ) {
2726 $input = strval( $input );
2727 if( $sourceBase < 2 ||
2732 $sourceBase != intval( $sourceBase ) ||
2733 $destBase != intval( $destBase ) ||
2734 $pad != intval( $pad ) ||
2735 !is_string( $input ) ||
2739 $digitChars = ( $lowercase ) ?
'0123456789abcdefghijklmnopqrstuvwxyz' : '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ';
2740 $inDigits = array();
2743 // Decode and validate input string
2744 $input = strtolower( $input );
2745 for( $i = 0; $i < strlen( $input ); $i++
) {
2746 $n = strpos( $digitChars, $input[$i] );
2747 if( $n === false ||
$n > $sourceBase ) {
2753 // Iterate over the input, modulo-ing out an output digit
2754 // at a time until input is gone.
2755 while( count( $inDigits ) ) {
2757 $workDigits = array();
2760 foreach( $inDigits as $digit ) {
2761 $work *= $sourceBase;
2764 if( $work < $destBase ) {
2765 // Gonna need to pull another digit.
2766 if( count( $workDigits ) ) {
2767 // Avoid zero-padding; this lets us find
2768 // the end of the input very easily when
2769 // length drops to zero.
2773 // Finally! Actual division!
2774 $workDigits[] = intval( $work / $destBase );
2776 // Isn't it annoying that most programming languages
2777 // don't have a single divide-and-remainder operator,
2778 // even though the CPU implements it that way?
2779 $work = $work %
$destBase;
2783 // All that division leaves us with a remainder,
2784 // which is conveniently our next output digit.
2785 $outChars .= $digitChars[$work];
2788 $inDigits = $workDigits;
2791 while( strlen( $outChars ) < $pad ) {
2795 return strrev( $outChars );
2799 * Create an object with a given name and an array of construct parameters
2800 * @param $name String
2801 * @param $p Array: parameters
2804 function wfCreateObject( $name, $p ) {
2805 return MWFunction
::newObj( $name, $p );
2808 function wfHttpOnlySafe() {
2809 global $wgHttpOnlyBlacklist;
2811 if( isset( $_SERVER['HTTP_USER_AGENT'] ) ) {
2812 foreach( $wgHttpOnlyBlacklist as $regex ) {
2813 if( preg_match( $regex, $_SERVER['HTTP_USER_AGENT'] ) ) {
2823 * Initialise php session
2825 function wfSetupSession( $sessionId = false ) {
2826 global $wgSessionsInMemcached, $wgCookiePath, $wgCookieDomain,
2827 $wgCookieSecure, $wgCookieHttpOnly, $wgSessionHandler;
2828 if( $wgSessionsInMemcached ) {
2829 if ( !defined( 'MW_COMPILED' ) ) {
2830 require_once( 'MemcachedSessions.php' );
2832 session_set_save_handler( 'memsess_open', 'memsess_close', 'memsess_read',
2833 'memsess_write', 'memsess_destroy', 'memsess_gc' );
2835 // It's necessary to register a shutdown function to call session_write_close(),
2836 // because by the time the request shutdown function for the session module is
2837 // called, $wgMemc has already been destroyed. Shutdown functions registered
2838 // this way are called before object destruction.
2839 register_shutdown_function( 'memsess_write_close' );
2840 } elseif( $wgSessionHandler && $wgSessionHandler != ini_get( 'session.save_handler' ) ) {
2841 # Only set this if $wgSessionHandler isn't null and session.save_handler
2842 # hasn't already been set to the desired value (that causes errors)
2843 ini_set( 'session.save_handler', $wgSessionHandler );
2845 $httpOnlySafe = wfHttpOnlySafe() && $wgCookieHttpOnly;
2846 wfDebugLog( 'cookie',
2847 'session_set_cookie_params: "' . implode( '", "',
2853 $httpOnlySafe ) ) . '"' );
2854 session_set_cookie_params( 0, $wgCookiePath, $wgCookieDomain, $wgCookieSecure, $httpOnlySafe );
2855 session_cache_limiter( 'private, must-revalidate' );
2857 session_id( $sessionId );
2859 wfSuppressWarnings();
2861 wfRestoreWarnings();
2865 * Get an object from the precompiled serialized directory
2867 * @return Mixed: the variable on success, false on failure
2869 function wfGetPrecompiledData( $name ) {
2872 $file = "$IP/serialized/$name";
2873 if ( file_exists( $file ) ) {
2874 $blob = file_get_contents( $file );
2876 return unserialize( $blob );
2882 function wfGetCaller( $level = 2 ) {
2883 $backtrace = wfDebugBacktrace();
2884 if ( isset( $backtrace[$level] ) ) {
2885 return wfFormatStackFrame( $backtrace[$level] );
2887 $caller = 'unknown';
2893 * Return a string consisting of callers in the stack. Useful sometimes
2894 * for profiling specific points.
2896 * @param $limit The maximum depth of the stack frame to return, or false for
2899 function wfGetAllCallers( $limit = 3 ) {
2900 $trace = array_reverse( wfDebugBacktrace() );
2901 if ( !$limit ||
$limit > count( $trace ) - 1 ) {
2902 $limit = count( $trace ) - 1;
2904 $trace = array_slice( $trace, -$limit - 1, $limit );
2905 return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
2909 * Return a string representation of frame
2911 function wfFormatStackFrame( $frame ) {
2912 return isset( $frame['class'] ) ?
2913 $frame['class'] . '::' . $frame['function'] :
2920 function wfMemcKey( /*... */ ) {
2921 $args = func_get_args();
2922 $key = wfWikiID() . ':' . implode( ':', $args );
2923 $key = str_replace( ' ', '_', $key );
2928 * Get a cache key for a foreign DB
2930 function wfForeignMemcKey( $db, $prefix /*, ... */ ) {
2931 $args = array_slice( func_get_args(), 2 );
2933 $key = "$db-$prefix:" . implode( ':', $args );
2935 $key = $db . ':' . implode( ':', $args );
2941 * Get an ASCII string identifying this wiki
2942 * This is used as a prefix in memcached keys
2944 function wfWikiID() {
2945 global $wgDBprefix, $wgDBname;
2946 if ( $wgDBprefix ) {
2947 return "$wgDBname-$wgDBprefix";
2954 * Split a wiki ID into DB name and table prefix
2956 function wfSplitWikiID( $wiki ) {
2957 $bits = explode( '-', $wiki, 2 );
2958 if ( count( $bits ) < 2 ) {
2965 * Get a Database object.
2966 * @param $db Integer: index of the connection to get. May be DB_MASTER for the
2967 * master (for write queries), DB_SLAVE for potentially lagged read
2968 * queries, or an integer >= 0 for a particular server.
2970 * @param $groups Mixed: query groups. An array of group names that this query
2971 * belongs to. May contain a single string if the query is only
2974 * @param $wiki String: the wiki ID, or false for the current wiki
2976 * Note: multiple calls to wfGetDB(DB_SLAVE) during the course of one request
2977 * will always return the same object, unless the underlying connection or load
2978 * balancer is manually destroyed.
2980 * @return DatabaseBase
2982 function &wfGetDB( $db, $groups = array(), $wiki = false ) {
2983 return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
2987 * Get a load balancer object.
2989 * @param $wiki String: wiki ID, or false for the current wiki
2990 * @return LoadBalancer
2992 function wfGetLB( $wiki = false ) {
2993 return wfGetLBFactory()->getMainLB( $wiki );
2997 * Get the load balancer factory object
3000 function &wfGetLBFactory() {
3001 return LBFactory
::singleton();
3006 * Shortcut for RepoGroup::singleton()->findFile()
3007 * @param $title String or Title object
3008 * @param $options Associative array of options:
3009 * time: requested time for an archived image, or false for the
3010 * current version. An image object will be returned which was
3011 * created at the specified time.
3013 * ignoreRedirect: If true, do not follow file redirects
3015 * private: If true, return restricted (deleted) files if the current
3016 * user is allowed to view them. Otherwise, such files will not
3019 * bypassCache: If true, do not use the process-local cache of File objects
3021 * @return File, or false if the file does not exist
3023 function wfFindFile( $title, $options = array() ) {
3024 return RepoGroup
::singleton()->findFile( $title, $options );
3028 * Get an object referring to a locally registered file.
3029 * Returns a valid placeholder object if the file does not exist.
3030 * @param $title Title or String
3031 * @return File, or null if passed an invalid Title
3033 function wfLocalFile( $title ) {
3034 return RepoGroup
::singleton()->getLocalRepo()->newFile( $title );
3038 * Should low-performance queries be disabled?
3041 * @codeCoverageIgnore
3043 function wfQueriesMustScale() {
3044 global $wgMiserMode;
3046 ||
( SiteStats
::pages() > 100000
3047 && SiteStats
::edits() > 1000000
3048 && SiteStats
::users() > 10000 );
3052 * Get the path to a specified script file, respecting file
3053 * extensions; this is a wrapper around $wgScriptExtension etc.
3055 * @param $script String: script filename, sans extension
3058 function wfScript( $script = 'index' ) {
3059 global $wgScriptPath, $wgScriptExtension;
3060 return "{$wgScriptPath}/{$script}{$wgScriptExtension}";
3064 * Get the script URL.
3066 * @return script URL
3068 function wfGetScriptUrl() {
3069 if( isset( $_SERVER['SCRIPT_NAME'] ) ) {
3071 # as it was called, minus the query string.
3073 # Some sites use Apache rewrite rules to handle subdomains,
3074 # and have PHP set up in a weird way that causes PHP_SELF
3075 # to contain the rewritten URL instead of the one that the
3076 # outside world sees.
3078 # If in this mode, use SCRIPT_URL instead, which mod_rewrite
3079 # provides containing the "before" URL.
3080 return $_SERVER['SCRIPT_NAME'];
3082 return $_SERVER['URL'];
3087 * Convenience function converts boolean values into "true"
3088 * or "false" (string) values
3090 * @param $value Boolean
3093 function wfBoolToStr( $value ) {
3094 return $value ?
'true' : 'false';
3098 * Load an extension messages file
3099 * @deprecated in 1.16, warnings in 1.18, remove in 1.20
3100 * @codeCoverageIgnore
3102 function wfLoadExtensionMessages( $extensionName, $langcode = false ) {
3103 wfDeprecated( __FUNCTION__
);
3107 * Get a platform-independent path to the null file, e.g.
3112 function wfGetNull() {
3113 return wfIsWindows()
3119 * Throws a warning that $function is deprecated
3120 * @param $function String
3123 function wfDeprecated( $function ) {
3124 static $functionsWarned = array();
3125 if ( !isset( $functionsWarned[$function] ) ) {
3126 $functionsWarned[$function] = true;
3127 wfWarn( "Use of $function is deprecated.", 2 );
3132 * Send a warning either to the debug log or in a PHP error depending on
3133 * $wgDevelopmentWarnings
3135 * @param $msg String: message to send
3136 * @param $callerOffset Integer: number of itmes to go back in the backtrace to
3137 * find the correct caller (1 = function calling wfWarn, ...)
3138 * @param $level Integer: PHP error level; only used when $wgDevelopmentWarnings
3141 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE
) {
3142 $callers = wfDebugBacktrace();
3143 if( isset( $callers[$callerOffset +
1] ) ){
3144 $callerfunc = $callers[$callerOffset +
1];
3145 $callerfile = $callers[$callerOffset];
3146 if( isset( $callerfile['file'] ) && isset( $callerfile['line'] ) ) {
3147 $file = $callerfile['file'] . ' at line ' . $callerfile['line'];
3149 $file = '(internal function)';
3152 if( isset( $callerfunc['class'] ) ) {
3153 $func .= $callerfunc['class'] . '::';
3155 if( isset( $callerfunc['function'] ) ) {
3156 $func .= $callerfunc['function'];
3158 $msg .= " [Called from $func in $file]";
3161 global $wgDevelopmentWarnings;
3162 if ( $wgDevelopmentWarnings ) {
3163 trigger_error( $msg, $level );
3165 wfDebug( "$msg\n" );
3170 * Modern version of wfWaitForSlaves(). Instead of looking at replication lag
3171 * and waiting for it to go down, this waits for the slaves to catch up to the
3172 * master position. Use this when updating very large numbers of rows, as
3173 * in maintenance scripts, to avoid causing too much lag. Of course, this is
3174 * a no-op if there are no slaves.
3176 * @param $maxLag Integer (deprecated)
3177 * @param $wiki mixed Wiki identifier accepted by wfGetLB
3180 function wfWaitForSlaves( $maxLag = false, $wiki = false ) {
3181 $lb = wfGetLB( $wiki );
3182 // bug 27975 - Don't try to wait for slaves if there are none
3183 // Prevents permission error when getting master position
3184 if ( $lb->getServerCount() > 1 ) {
3185 $dbw = $lb->getConnection( DB_MASTER
);
3186 $pos = $dbw->getMasterPos();
3187 $lb->waitForAll( $pos );
3192 * Used to be used for outputting text in the installer/updater
3193 * @deprecated Warnings in 1.19, removal in 1.20
3195 function wfOut( $s ) {
3196 global $wgCommandLineMode;
3197 if ( $wgCommandLineMode && !defined( 'MEDIAWIKI_INSTALL' ) ) {
3200 echo htmlspecialchars( $s );
3206 * Count down from $n to zero on the terminal, with a one-second pause
3207 * between showing each number. For use in command-line scripts.
3208 * @codeCoverageIgnore
3210 function wfCountDown( $n ) {
3211 for ( $i = $n; $i >= 0; $i-- ) {
3213 echo str_repeat( "\x08", strlen( $i +
1 ) );
3225 * Generate a random 32-character hexadecimal token.
3226 * @param $salt Mixed: some sort of salt, if necessary, to add to random
3227 * characters before hashing.
3228 * @codeCoverageIgnore
3230 function wfGenerateToken( $salt = '' ) {
3231 $salt = serialize( $salt );
3232 return md5( mt_rand( 0, 0x7fffffff ) . $salt );
3236 * Replace all invalid characters with -
3237 * @param $name Mixed: filename to process
3239 function wfStripIllegalFilenameChars( $name ) {
3240 global $wgIllegalFileChars;
3241 $name = wfBaseName( $name );
3242 $name = preg_replace(
3243 "/[^" . Title
::legalChars() . "]" .
3244 ( $wgIllegalFileChars ?
"|[" . $wgIllegalFileChars . "]" : '' ) .
3253 * Insert array into another array after the specified *KEY*
3254 * @param $array Array: The array.
3255 * @param $insert Array: The array to insert.
3256 * @param $after Mixed: The key to insert after
3258 function wfArrayInsertAfter( $array, $insert, $after ) {
3259 // Find the offset of the element to insert after.
3260 $keys = array_keys( $array );
3261 $offsetByKey = array_flip( $keys );
3263 $offset = $offsetByKey[$after];
3265 // Insert at the specified offset
3266 $before = array_slice( $array, 0, $offset +
1, true );
3267 $after = array_slice( $array, $offset +
1, count( $array ) - $offset, true );
3269 $output = $before +
$insert +
$after;
3274 /* Recursively converts the parameter (an object) to an array with the same data */
3275 function wfObjectToArray( $objOrArray, $recursive = true ) {
3277 if( is_object( $objOrArray ) ) {
3278 $objOrArray = get_object_vars( $objOrArray );
3280 foreach ( $objOrArray as $key => $value ) {
3281 if ( $recursive && ( is_object( $value ) ||
is_array( $value ) ) ) {
3282 $value = wfObjectToArray( $value );
3285 $array[$key] = $value;
3292 * Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit;
3293 * @return Integer value memory was set to.
3295 function wfMemoryLimit() {
3296 global $wgMemoryLimit;
3297 $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
3298 if( $memlimit != -1 ) {
3299 $conflimit = wfShorthandToInteger( $wgMemoryLimit );
3300 if( $conflimit == -1 ) {
3301 wfDebug( "Removing PHP's memory limit\n" );
3302 wfSuppressWarnings();
3303 ini_set( 'memory_limit', $conflimit );
3304 wfRestoreWarnings();
3306 } elseif ( $conflimit > $memlimit ) {
3307 wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
3308 wfSuppressWarnings();
3309 ini_set( 'memory_limit', $conflimit );
3310 wfRestoreWarnings();
3318 * Converts shorthand byte notation to integer form
3319 * @param $string String
3322 function wfShorthandToInteger( $string = '' ) {
3323 $string = trim( $string );
3324 if( $string === '' ) {
3327 $last = $string[strlen( $string ) - 1];
3328 $val = intval( $string );
3333 // break intentionally missing
3337 // break intentionally missing
3347 * Get the normalised IETF language tag
3348 * See unit test for examples.
3349 * @param $code String: The language code.
3350 * @return $langCode String: The language code which complying with BCP 47 standards.
3352 function wfBCP47( $code ) {
3353 $codeSegment = explode( '-', $code );
3354 foreach ( $codeSegment as $segNo => $seg ) {
3355 if ( count( $codeSegment ) > 0 ) {
3356 // when previous segment is x, it is a private segment and should be lc
3357 if( $segNo > 0 && strtolower( $codeSegment[($segNo - 1)] ) == 'x') {
3358 $codeBCP[$segNo] = strtolower( $seg );
3359 // ISO 3166 country code
3360 } elseif ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) {
3361 $codeBCP[$segNo] = strtoupper( $seg );
3362 // ISO 15924 script code
3363 } elseif ( ( strlen( $seg ) == 4 ) && ( $segNo > 0 ) ) {
3364 $codeBCP[$segNo] = ucfirst( strtolower( $seg ) );
3365 // Use lowercase for other cases
3367 $codeBCP[$segNo] = strtolower( $seg );
3370 // Use lowercase for single segment
3371 $codeBCP[$segNo] = strtolower( $seg );
3374 $langCode = implode( '-', $codeBCP );
3378 function wfArrayMap( $function, $input ) {
3379 $ret = array_map( $function, $input );
3380 foreach ( $ret as $key => $value ) {
3381 $taint = istainted( $input[$key] );
3383 taint( $ret[$key], $taint );
3391 * Get a cache object.
3392 * @param integer $inputType Cache type, one the the CACHE_* constants.
3396 function wfGetCache( $inputType ) {
3397 return ObjectCache
::getInstance( $inputType );
3400 /** Get the main cache object */
3401 function wfGetMainCache() {
3402 global $wgMainCacheType;
3403 return ObjectCache
::getInstance( $wgMainCacheType );
3406 /** Get the cache object used by the message cache */
3407 function wfGetMessageCacheStorage() {
3408 global $wgMessageCacheType;
3409 return ObjectCache
::getInstance( $wgMessageCacheType );
3412 /** Get the cache object used by the parser cache */
3413 function wfGetParserCacheStorage() {
3414 global $wgParserCacheType;
3415 return ObjectCache
::getInstance( $wgParserCacheType );