4 * Global functions used everywhere
9 * Some globals and requires needed
13 * Total number of articles
14 * @global integer $wgNumberOfArticles
16 $wgNumberOfArticles = -1; # Unset
18 * Total number of views
19 * @global integer $wgTotalViews
23 * Total number of edits
24 * @global integer $wgTotalEdits
29 require_once( 'DatabaseFunctions.php' );
30 require_once( 'UpdateClasses.php' );
31 require_once( 'LogPage.php' );
32 require_once( 'normal/UtfNormalUtil.php' );
35 * Compatibility functions
36 * PHP <4.3.x is not actively supported; 4.1.x and 4.2.x might or might not work.
37 * <4.1.x will not work, as we use a number of features introduced in 4.1.0
38 * such as the new autoglobals.
40 if( !function_exists('iconv') ) {
41 # iconv support is not in the default configuration and so may not be present.
42 # Assume will only ever use utf-8 and iso-8859-1.
43 # This will *not* work in all circumstances.
44 function iconv( $from, $to, $string ) {
45 if(strcasecmp( $from, $to ) == 0) return $string;
46 if(strcasecmp( $from, 'utf-8' ) == 0) return utf8_decode( $string );
47 if(strcasecmp( $to, 'utf-8' ) == 0) return utf8_encode( $string );
52 if( !function_exists('file_get_contents') ) {
53 # Exists in PHP 4.3.0+
54 function file_get_contents( $filename ) {
55 return implode( '', file( $filename ) );
59 if( !function_exists('is_a') ) {
60 # Exists in PHP 4.2.0+
61 function is_a( $object, $class_name ) {
63 (strcasecmp( get_class( $object ), $class_name ) == 0) ||
64 is_subclass_of( $object, $class_name );
68 # UTF-8 substr function based on a PHP manual comment
69 if ( !function_exists( 'mb_substr' ) ) {
70 function mb_substr( $str, $start ) {
71 preg_match_all( '/./us', $str, $ar );
73 if( func_num_args() >= 3 ) {
74 $end = func_get_arg( 2 );
75 return join( '', array_slice( $ar[0], $start, $end ) );
77 return join( '', array_slice( $ar[0], $start ) );
82 if( !function_exists( 'floatval' ) ) {
84 * First defined in PHP 4.2.0
88 function floatval( $var ) {
94 * Where as we got a random seed
95 * @var bool $wgTotalViews
97 $wgRandomSeeded = false;
100 * Seed Mersenne Twister
101 * Only necessary in PHP < 4.2.0
105 function wfSeedRandom() {
106 global $wgRandomSeeded;
108 if ( ! $wgRandomSeeded && version_compare( phpversion(), '4.2.0' ) < 0 ) {
109 $seed = hexdec(substr(md5(microtime()),-8)) & 0x7fffffff;
111 $wgRandomSeeded = true;
116 * Get a random decimal value between 0 and 1, in a way
117 * not likely to give duplicate values for any realistic
118 * number of articles.
122 function wfRandom() {
123 # The maximum random value is "only" 2^31-1, so get two random
124 # values to reduce the chance of dupes
125 $max = mt_getrandmax();
126 $rand = number_format( (mt_rand() * $max +
mt_rand())
127 / $max / $max, 12, '.', '' );
132 * We want / and : to be included as literal characters in our title URLs.
133 * %2F in the page titles seems to fatally break for some reason.
138 function wfUrlencode ( $s ) {
139 $s = urlencode( $s );
140 $s = preg_replace( '/%3[Aa]/', ':', $s );
141 $s = preg_replace( '/%2[Ff]/', '/', $s );
147 * Sends a line to the debug log if enabled or, optionally, to a comment in output.
148 * In normal operation this is a NOP.
150 * Controlling globals:
151 * $wgDebugLogFile - points to the log file
152 * $wgProfileOnly - if set, normal debug messages will not be recorded.
153 * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
154 * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
156 * @param string $text
157 * @param bool $logonly Set true to avoid appearing in HTML when $wgDebugComments is set
159 function wfDebug( $text, $logonly = false ) {
160 global $wgOut, $wgDebugLogFile, $wgDebugComments, $wgProfileOnly, $wgDebugRawPage;
162 # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
163 if ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' && !$wgDebugRawPage ) {
167 if ( isset( $wgOut ) && $wgDebugComments && !$logonly ) {
168 $wgOut->debug( $text );
170 if ( '' != $wgDebugLogFile && !$wgProfileOnly ) {
171 # Strip unprintables; they can switch terminal modes when binary data
172 # gets dumped, which is pretty annoying.
173 $text = preg_replace( '![\x00-\x08\x0b\x0c\x0e-\x1f]!', ' ', $text );
174 @error_log
( $text, 3, $wgDebugLogFile );
179 * Send a line to a supplementary debug log file, if configured, or main debug log if not.
180 * $wgDebugLogGroups[$logGroup] should be set to a filename to send to a separate log.
181 * @param string $logGroup
182 * @param string $text
184 function wfDebugLog( $logGroup, $text ) {
185 global $wgDebugLogGroups, $wgDBname;
186 if( $text{strlen( $text ) - 1} != "\n" ) $text .= "\n";
187 if( isset( $wgDebugLogGroups[$logGroup] ) ) {
188 @error_log
( "$wgDBname: $text", 3, $wgDebugLogGroups[$logGroup] );
190 wfDebug( $text, true );
195 * Log for database errors
196 * @param string $text Database error message.
198 function wfLogDBError( $text ) {
199 global $wgDBerrorLog;
200 if ( $wgDBerrorLog ) {
201 $text = date('D M j G:i:s T Y') . "\t".$text;
202 error_log( $text, 3, $wgDBerrorLog );
209 function logProfilingData() {
210 global $wgRequestTime, $wgDebugLogFile, $wgDebugRawPage, $wgRequest;
211 global $wgProfiling, $wgProfileStack, $wgProfileLimit, $wgUser;
214 list( $usec, $sec ) = explode( ' ', $wgRequestTime );
215 $start = (float)$sec +
(float)$usec;
216 $elapsed = $now - $start;
217 if ( $wgProfiling ) {
218 $prof = wfGetProfilingOutput( $start, $elapsed );
220 if( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) )
221 $forward = ' forwarded for ' . $_SERVER['HTTP_X_FORWARDED_FOR'];
222 if( !empty( $_SERVER['HTTP_CLIENT_IP'] ) )
223 $forward .= ' client IP ' . $_SERVER['HTTP_CLIENT_IP'];
224 if( !empty( $_SERVER['HTTP_FROM'] ) )
225 $forward .= ' from ' . $_SERVER['HTTP_FROM'];
227 $forward = "\t(proxied via {$_SERVER['REMOTE_ADDR']}{$forward})";
228 if( $wgUser->isAnon() )
230 $log = sprintf( "%s\t%04.3f\t%s\n",
231 gmdate( 'YmdHis' ), $elapsed,
232 urldecode( $_SERVER['REQUEST_URI'] . $forward ) );
233 if ( '' != $wgDebugLogFile && ( $wgRequest->getVal('action') != 'raw' ||
$wgDebugRawPage ) ) {
234 error_log( $log . $prof, 3, $wgDebugLogFile );
240 * Check if the wiki read-only lock file is present. This can be used to lock
241 * off editing functions, but doesn't guarantee that the database will not be
245 function wfReadOnly() {
246 global $wgReadOnlyFile, $wgReadOnly;
251 if ( '' == $wgReadOnlyFile ) {
255 // Set $wgReadOnly and unset $wgReadOnlyFile, for faster access next time
256 if ( is_file( $wgReadOnlyFile ) ) {
257 $wgReadOnly = file_get_contents( $wgReadOnlyFile );
261 $wgReadOnlyFile = '';
267 * Get a message from anywhere, for the current user language.
269 * Use wfMsgForContent() instead if the message should NOT
270 * change depending on the user preferences.
272 * Note that the message may contain HTML, and is therefore
273 * not safe for insertion anywhere. Some functions such as
274 * addWikiText will do the escaping for you. Use wfMsgHtml()
275 * if you need an escaped message.
277 * @param string lookup key for the message, usually
278 * defined in languages/Language.php
280 function wfMsg( $key ) {
281 $args = func_get_args();
282 array_shift( $args );
283 return wfMsgReal( $key, $args, true );
287 * Get a message from anywhere, for the current global language
288 * set with $wgLanguageCode.
290 * Use this if the message should NOT change dependent on the
291 * language set in the user's preferences. This is the case for
292 * most text written into logs, as well as link targets (such as
293 * the name of the copyright policy page). Link titles, on the
294 * other hand, should be shown in the UI language.
296 * Note that MediaWiki allows users to change the user interface
297 * language in their preferences, but a single installation
298 * typically only contains content in one language.
300 * Be wary of this distinction: If you use wfMsg() where you should
301 * use wfMsgForContent(), a user of the software may have to
302 * customize over 70 messages in order to, e.g., fix a link in every
305 * @param string lookup key for the message, usually
306 * defined in languages/Language.php
308 function wfMsgForContent( $key ) {
309 global $wgForceUIMsgAsContentMsg;
310 $args = func_get_args();
311 array_shift( $args );
313 if( is_array( $wgForceUIMsgAsContentMsg ) &&
314 in_array( $key, $wgForceUIMsgAsContentMsg ) )
316 return wfMsgReal( $key, $args, true, $forcontent );
320 * Get a message from the language file, for the UI elements
322 function wfMsgNoDB( $key ) {
323 $args = func_get_args();
324 array_shift( $args );
325 return wfMsgReal( $key, $args, false );
329 * Get a message from the language file, for the content
331 function wfMsgNoDBForContent( $key ) {
332 global $wgForceUIMsgAsContentMsg;
333 $args = func_get_args();
334 array_shift( $args );
336 if( is_array( $wgForceUIMsgAsContentMsg ) &&
337 in_array( $key, $wgForceUIMsgAsContentMsg ) )
339 return wfMsgReal( $key, $args, false, $forcontent );
344 * Really get a message
346 function wfMsgReal( $key, $args, $useDB, $forContent=false ) {
347 $fname = 'wfMsgReal';
348 wfProfileIn( $fname );
350 $message = wfMsgGetKey( $key, $useDB, $forContent );
351 $message = wfMsgReplaceArgs( $message, $args );
352 wfProfileOut( $fname );
357 * Fetch a message string value, but don't replace any keys yet.
360 * @param bool $forContent
364 function wfMsgGetKey( $key, $useDB, $forContent = false ) {
365 global $wgParser, $wgMsgParserOptions;
366 global $wgContLang, $wgLanguageCode;
367 global $wgMessageCache, $wgLang;
369 if( is_object( $wgMessageCache ) ) {
370 $message = $wgMessageCache->get( $key, $useDB, $forContent );
373 $lang = &$wgContLang;
378 wfSuppressWarnings();
380 if( is_object( $lang ) ) {
381 $message = $lang->getMessage( $key );
387 $message = Language
::getMessage($key);
388 if(strstr($message, '{{' ) !== false) {
389 $message = $wgParser->transformMsg($message, $wgMsgParserOptions);
396 * Replace message parameter keys on the given formatted output.
398 * @param string $message
403 function wfMsgReplaceArgs( $message, $args ) {
404 static $replacementKeys = array( '$1', '$2', '$3', '$4', '$5', '$6', '$7', '$8', '$9' );
406 # Fix windows line-endings
407 # Some messages are split with explode("\n", $msg)
408 $message = str_replace( "\r", '', $message );
411 if( count( $args ) ) {
412 $message = str_replace( $replacementKeys, $args, $message );
418 * Return an HTML-escaped version of a message.
419 * Parameter replacements, if any, are done *after* the HTML-escaping,
420 * so parameters may contain HTML (eg links or form controls). Be sure
421 * to pre-escape them if you really do want plaintext, or just wrap
422 * the whole thing in htmlspecialchars().
425 * @param string ... parameters
428 function wfMsgHtml( $key ) {
429 $args = func_get_args();
430 array_shift( $args );
431 return wfMsgReplaceArgs( htmlspecialchars( wfMsgGetKey( $key, true ) ), $args );
435 * Return an HTML version of message
436 * Parameter replacements, if any, are done *after* parsing the wiki-text message,
437 * so parameters may contain HTML (eg links or form controls). Be sure
438 * to pre-escape them if you really do want plaintext, or just wrap
439 * the whole thing in htmlspecialchars().
442 * @param string ... parameters
445 function wfMsgWikiHtml( $key ) {
447 $args = func_get_args();
448 array_shift( $args );
449 return wfMsgReplaceArgs( $wgOut->parse( wfMsgGetKey( $key, true ), /* can't be set to false */ true ), $args );
453 * Just like exit() but makes a note of it.
454 * Commits open transactions except if the error parameter is set
456 function wfAbruptExit( $error = false ){
457 global $wgLoadBalancer;
458 static $called = false;
464 if( function_exists( 'debug_backtrace' ) ){ // PHP >= 4.3
465 $bt = debug_backtrace();
466 for($i = 0; $i < count($bt) ; $i++
){
467 $file = $bt[$i]['file'];
468 $line = $bt[$i]['line'];
469 wfDebug("WARNING: Abrupt exit in $file at line $line\n");
472 wfDebug('WARNING: Abrupt exit\n');
475 $wgLoadBalancer->closeAll();
483 function wfErrorExit() {
484 wfAbruptExit( true );
488 * Die with a backtrace
489 * This is meant as a debugging aid to track down where bad data comes from.
490 * Shouldn't be used in production code except maybe in "shouldn't happen" areas.
492 * @param string $msg Message shown when dieing.
494 function wfDebugDieBacktrace( $msg = '' ) {
495 global $wgCommandLineMode;
497 $backtrace = wfBacktrace();
498 if ( $backtrace !== false ) {
499 if ( $wgCommandLineMode ) {
500 $msg .= "\nBacktrace:\n$backtrace";
502 $msg .= "\n<p>Backtrace:</p>\n$backtrace";
509 function wfBacktrace() {
510 global $wgCommandLineMode;
511 if ( !function_exists( 'debug_backtrace' ) ) {
515 if ( $wgCommandLineMode ) {
520 $backtrace = debug_backtrace();
521 foreach( $backtrace as $call ) {
522 if( isset( $call['file'] ) ) {
523 $f = explode( DIRECTORY_SEPARATOR
, $call['file'] );
524 $file = $f[count($f)-1];
528 if( isset( $call['line'] ) ) {
529 $line = $call['line'];
533 if ( $wgCommandLineMode ) {
534 $msg .= "$file line $line calls ";
536 $msg .= '<li>' . $file . ' line ' . $line . ' calls ';
538 if( !empty( $call['class'] ) ) $msg .= $call['class'] . '::';
539 $msg .= $call['function'] . '()';
541 if ( $wgCommandLineMode ) {
547 if ( $wgCommandLineMode ) {
557 /* Some generic result counters, pulled out of SearchEngine */
563 function wfShowingResults( $offset, $limit ) {
565 return wfMsg( 'showingresults', $wgLang->formatNum( $limit ), $wgLang->formatNum( $offset+
1 ) );
571 function wfShowingResultsNum( $offset, $limit, $num ) {
573 return wfMsg( 'showingresultsnum', $wgLang->formatNum( $limit ), $wgLang->formatNum( $offset+
1 ), $wgLang->formatNum( $num ) );
579 function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) {
580 global $wgUser, $wgLang;
581 $fmtLimit = $wgLang->formatNum( $limit );
582 $prev = wfMsg( 'prevn', $fmtLimit );
583 $next = wfMsg( 'nextn', $fmtLimit );
585 if( is_object( $link ) ) {
588 $title = Title
::newFromText( $link );
589 if( is_null( $title ) ) {
594 $sk = $wgUser->getSkin();
595 if ( 0 != $offset ) {
596 $po = $offset - $limit;
597 if ( $po < 0 ) { $po = 0; }
598 $q = "limit={$limit}&offset={$po}";
599 if ( '' != $query ) { $q .= '&'.$query; }
600 $plink = '<a href="' . $title->escapeLocalUrl( $q ) . "\">{$prev}</a>";
601 } else { $plink = $prev; }
603 $no = $offset +
$limit;
604 $q = 'limit='.$limit.'&offset='.$no;
605 if ( '' != $query ) { $q .= '&'.$query; }
610 $nlink = '<a href="' . $title->escapeLocalUrl( $q ) . "\">{$next}</a>";
612 $nums = wfNumLink( $offset, 20, $title, $query ) . ' | ' .
613 wfNumLink( $offset, 50, $title, $query ) . ' | ' .
614 wfNumLink( $offset, 100, $title, $query ) . ' | ' .
615 wfNumLink( $offset, 250, $title, $query ) . ' | ' .
616 wfNumLink( $offset, 500, $title, $query );
618 return wfMsg( 'viewprevnext', $plink, $nlink, $nums );
624 function wfNumLink( $offset, $limit, &$title, $query = '' ) {
625 global $wgUser, $wgLang;
626 if ( '' == $query ) { $q = ''; }
627 else { $q = $query.'&'; }
628 $q .= 'limit='.$limit.'&offset='.$offset;
630 $fmtLimit = $wgLang->formatNum( $limit );
631 $s = '<a href="' . $title->escapeLocalUrl( $q ) . "\">{$fmtLimit}</a>";
637 * @todo FIXME: we may want to blacklist some broken browsers
639 * @return bool Whereas client accept gzip compression
641 function wfClientAcceptsGzip() {
644 # FIXME: we may want to blacklist some broken browsers
646 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
647 $_SERVER['HTTP_ACCEPT_ENCODING'],
649 if( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) return false;
650 wfDebug( " accepts gzip\n" );
658 * Yay, more global functions!
660 function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
662 return $wgRequest->getLimitOffset( $deflimit, $optionname );
666 * Escapes the given text so that it may be output using addWikiText()
667 * without any linking, formatting, etc. making its way through. This
668 * is achieved by substituting certain characters with HTML entities.
669 * As required by the callers, <nowiki> is not used. It currently does
670 * not filter out characters which have special meaning only at the
671 * start of a line, such as "*".
673 * @param string $text Text to be escaped
675 function wfEscapeWikiText( $text ) {
677 array( '[', '|', '\'', 'ISBN ' , '://' , "\n=", '{{' ),
678 array( '[', '|', ''', 'ISBN ', '://' , "\n=", '{{' ),
679 htmlspecialchars($text) );
686 function wfQuotedPrintable( $string, $charset = '' ) {
687 # Probably incomplete; see RFC 2045
688 if( empty( $charset ) ) {
689 global $wgInputEncoding;
690 $charset = $wgInputEncoding;
692 $charset = strtoupper( $charset );
693 $charset = str_replace( 'ISO-8859', 'ISO8859', $charset ); // ?
695 $illegal = '\x00-\x08\x0b\x0c\x0e-\x1f\x7f-\xff=';
696 $replace = $illegal . '\t ?_';
697 if( !preg_match( "/[$illegal]/", $string ) ) return $string;
698 $out = "=?$charset?Q?";
699 $out .= preg_replace( "/([$replace])/e", 'sprintf("=%02X",ord("$1"))', $string );
705 * Returns an escaped string suitable for inclusion in a string literal
706 * for JavaScript source code.
707 * Illegal control characters are assumed not to be present.
709 * @param string $string
712 function wfEscapeJsString( $string ) {
713 // See ECMA 262 section 7.8.4 for string literal format
721 # To avoid closing the element or CDATA section
725 return strtr( $string, $pairs );
733 $st = explode( ' ', microtime() );
734 return (float)$st[0] +
(float)$st[1];
738 * Changes the first character to an HTML entity
740 function wfHtmlEscapeFirst( $text ) {
742 $newText = substr($text, 1);
743 return "&#$ord;$newText";
747 * Sets dest to source and returns the original value of dest
748 * If source is NULL, it just returns the value, it doesn't set the variable
750 function wfSetVar( &$dest, $source ) {
752 if ( !is_null( $source ) ) {
759 * As for wfSetVar except setting a bit
761 function wfSetBit( &$dest, $bit, $state = true ) {
762 $temp = (bool)($dest & $bit );
763 if ( !is_null( $state ) ) {
774 * This function takes two arrays as input, and returns a CGI-style string, e.g.
775 * "days=7&limit=100". Options in the first array override options in the second.
776 * Options set to "" will not be output.
778 function wfArrayToCGI( $array1, $array2 = NULL )
780 if ( !is_null( $array2 ) ) {
781 $array1 = $array1 +
$array2;
785 foreach ( $array1 as $key => $value ) {
786 if ( '' !== $value ) {
790 $cgi .= urlencode( $key ) . '=' . urlencode( $value );
797 * This is obsolete, use SquidUpdate::purge()
800 function wfPurgeSquidServers ($urlArr) {
801 SquidUpdate
::purge( $urlArr );
805 * Windows-compatible version of escapeshellarg()
806 * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
807 * function puts single quotes in regardless of OS
809 function wfEscapeShellArg( ) {
810 $args = func_get_args();
813 foreach ( $args as $arg ) {
820 if ( wfIsWindows() ) {
821 $retVal .= '"' . str_replace( '"','\"', $arg ) . '"';
823 $retVal .= escapeshellarg( $arg );
830 * wfMerge attempts to merge differences between three texts.
831 * Returns true for a clean merge and false for failure or a conflict.
833 function wfMerge( $old, $mine, $yours, &$result ){
836 # This check may also protect against code injection in
837 # case of broken installations.
838 if(! file_exists( $wgDiff3 ) ){
839 wfDebug( "diff3 not found\n" );
843 # Make temporary files
845 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
846 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
847 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
849 fwrite( $oldtextFile, $old ); fclose( $oldtextFile );
850 fwrite( $mytextFile, $mine ); fclose( $mytextFile );
851 fwrite( $yourtextFile, $yours ); fclose( $yourtextFile );
853 # Check for a conflict
854 $cmd = $wgDiff3 . ' -a --overlap-only ' .
855 wfEscapeShellArg( $mytextName ) . ' ' .
856 wfEscapeShellArg( $oldtextName ) . ' ' .
857 wfEscapeShellArg( $yourtextName );
858 $handle = popen( $cmd, 'r' );
860 if( fgets( $handle, 1024 ) ){
868 $cmd = $wgDiff3 . ' -a -e --merge ' .
869 wfEscapeShellArg( $mytextName, $oldtextName, $yourtextName );
870 $handle = popen( $cmd, 'r' );
873 $data = fread( $handle, 8192 );
874 if ( strlen( $data ) == 0 ) {
880 unlink( $mytextName ); unlink( $oldtextName ); unlink( $yourtextName );
882 if ( $result === '' && $old !== '' && $conflict == false ) {
883 wfDebug( "Unexpected null result from diff3.\nCommand: $cmd\nOutput: " . `
$cmd 2>&1`
. "\n" );
892 function wfVarDump( $var ) {
894 $s = str_replace("\n","<br />\n", var_export( $var, true ) . "\n");
895 if ( headers_sent() ||
!@is_object
( $wgOut ) ) {
898 $wgOut->addHTML( $s );
903 * Provide a simple HTTP error.
905 function wfHttpError( $code, $label, $desc ) {
908 header( "HTTP/1.0 $code $label" );
909 header( "Status: $code $label" );
910 $wgOut->sendCacheControl();
912 header( 'Content-type: text/html' );
913 print "<html><head><title>" .
914 htmlspecialchars( $label ) .
915 "</title></head><body><h1>" .
916 htmlspecialchars( $label ) .
918 htmlspecialchars( $desc ) .
919 "</p></body></html>\n";
923 * Converts an Accept-* header into an array mapping string values to quality
926 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
927 # No arg means accept anything (per HTTP spec)
929 return array( $def => 1 );
934 $parts = explode( ',', $accept );
936 foreach( $parts as $part ) {
937 # FIXME: doesn't deal with params like 'text/html; level=1'
938 @list
( $value, $qpart ) = explode( ';', $part );
939 if( !isset( $qpart ) ) {
941 } elseif( preg_match( '/q\s*=\s*(\d*\.\d+)/', $qpart, $match ) ) {
942 $prefs[$value] = $match[1];
950 * Checks if a given MIME type matches any of the keys in the given
951 * array. Basic wildcards are accepted in the array keys.
953 * Returns the matching MIME type (or wildcard) if a match, otherwise
956 * @param string $type
957 * @param array $avail
961 function mimeTypeMatch( $type, $avail ) {
962 if( array_key_exists($type, $avail) ) {
965 $parts = explode( '/', $type );
966 if( array_key_exists( $parts[0] . '/*', $avail ) ) {
967 return $parts[0] . '/*';
968 } elseif( array_key_exists( '*/*', $avail ) ) {
977 * Returns the 'best' match between a client's requested internet media types
978 * and the server's list of available types. Each list should be an associative
979 * array of type to preference (preference is a float between 0.0 and 1.0).
980 * Wildcards in the types are acceptable.
982 * @param array $cprefs Client's acceptable type list
983 * @param array $sprefs Server's offered types
986 * @todo FIXME: doesn't handle params like 'text/plain; charset=UTF-8'
987 * XXX: generalize to negotiate other stuff
989 function wfNegotiateType( $cprefs, $sprefs ) {
992 foreach( array_keys($sprefs) as $type ) {
993 $parts = explode( '/', $type );
994 if( $parts[1] != '*' ) {
995 $ckey = mimeTypeMatch( $type, $cprefs );
997 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1002 foreach( array_keys( $cprefs ) as $type ) {
1003 $parts = explode( '/', $type );
1004 if( $parts[1] != '*' && !array_key_exists( $type, $sprefs ) ) {
1005 $skey = mimeTypeMatch( $type, $sprefs );
1007 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1015 foreach( array_keys( $combine ) as $type ) {
1016 if( $combine[$type] > $bestq ) {
1018 $bestq = $combine[$type];
1027 * Returns an array where the values in the first array are replaced by the
1028 * values in the second array with the corresponding keys
1032 function wfArrayLookup( $a, $b ) {
1033 return array_flip( array_intersect( array_flip( $a ), array_keys( $b ) ) );
1037 * Convenience function; returns MediaWiki timestamp for the present time.
1040 function wfTimestampNow() {
1042 return wfTimestamp( TS_MW
, time() );
1046 * Reference-counted warning suppression
1048 function wfSuppressWarnings( $end = false ) {
1049 static $suppressCount = 0;
1050 static $originalLevel = false;
1053 if ( $suppressCount ) {
1055 if ( !$suppressCount ) {
1056 error_reporting( $originalLevel );
1060 if ( !$suppressCount ) {
1061 $originalLevel = error_reporting( E_ALL
& ~
( E_WARNING | E_NOTICE
) );
1068 * Restore error level to previous value
1070 function wfRestoreWarnings() {
1071 wfSuppressWarnings( true );
1074 # Autodetect, convert and provide timestamps of various types
1077 * Unix time - the number of seconds since 1970-01-01 00:00:00 UTC
1079 define('TS_UNIX', 0);
1082 * MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
1087 * MySQL DATETIME (YYYY-MM-DD HH:MM:SS)
1092 * RFC 2822 format, for E-mail and HTTP headers
1094 define('TS_RFC2822', 3);
1097 * An Exif timestamp (YYYY:MM:DD HH:MM:SS)
1099 * @link http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the
1100 * DateTime tag and page 36 for the DateTimeOriginal and
1101 * DateTimeDigitized tags.
1103 define('TS_EXIF', 4);
1106 * Oracle format time.
1108 define('TS_ORACLE', 5);
1111 * @param mixed $outputtype A timestamp in one of the supported formats, the
1112 * function will autodetect which format is supplied
1113 and act accordingly.
1114 * @return string Time in the format specified in $outputtype
1116 function wfTimestamp($outputtype=TS_UNIX
,$ts=0) {
1120 } elseif (preg_match("/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)$/",$ts,$da)) {
1122 $uts=gmmktime((int)$da[4],(int)$da[5],(int)$da[6],
1123 (int)$da[2],(int)$da[3],(int)$da[1]);
1124 } elseif (preg_match("/^(\d{4}):(\d\d):(\d\d) (\d\d):(\d\d):(\d\d)$/",$ts,$da)) {
1126 $uts=gmmktime((int)$da[4],(int)$da[5],(int)$da[6],
1127 (int)$da[2],(int)$da[3],(int)$da[1]);
1128 } elseif (preg_match("/^(\d{4})(\d\d)(\d\d)(\d\d)(\d\d)(\d\d)$/",$ts,$da)) {
1130 $uts=gmmktime((int)$da[4],(int)$da[5],(int)$da[6],
1131 (int)$da[2],(int)$da[3],(int)$da[1]);
1132 } elseif (preg_match("/^(\d{1,13})$/",$ts,$datearray)) {
1135 } elseif (preg_match('/^(\d{1,2})-(...)-(\d\d(\d\d)?) (\d\d)\.(\d\d)\.(\d\d)/', $ts, $da)) {
1137 $uts = strtotime(preg_replace('/(\d\d)\.(\d\d)\.(\d\d)(\.(\d+))?/', "$1:$2:$3",
1138 str_replace("+00:00", "UTC", $ts)));
1140 # Bogus value; fall back to the epoch...
1141 wfDebug("wfTimestamp() fed bogus time value: $outputtype; $ts\n");
1146 switch($outputtype) {
1150 return gmdate( 'YmdHis', $uts );
1152 return gmdate( 'Y-m-d H:i:s', $uts );
1153 // This shouldn't ever be used, but is included for completeness
1155 return gmdate( 'Y:m:d H:i:s', $uts );
1157 return gmdate( 'D, d M Y H:i:s', $uts ) . ' GMT';
1159 return gmdate( 'd-M-y h.i.s A', $uts) . ' +00:00';
1161 wfDebugDieBacktrace( 'wfTimestamp() called with illegal output type.');
1166 * Return a formatted timestamp, or null if input is null.
1167 * For dealing with nullable timestamp columns in the database.
1168 * @param int $outputtype
1172 function wfTimestampOrNull( $outputtype = TS_UNIX
, $ts = null ) {
1173 if( is_null( $ts ) ) {
1176 return wfTimestamp( $outputtype, $ts );
1181 * Check where as the operating system is Windows
1183 * @return bool True if it's windows, False otherwise.
1185 function wfIsWindows() {
1186 if (substr(php_uname(), 0, 7) == 'Windows') {
1194 * Swap two variables
1196 function swap( &$x, &$y ) {
1202 function wfGetSiteNotice() {
1203 global $wgSiteNotice, $wgTitle, $wgOut;
1204 $fname = 'wfGetSiteNotice';
1205 wfProfileIn( $fname );
1207 $notice = wfMsg( 'sitenotice' );
1208 if( $notice == '<sitenotice>' ||
$notice == '-' ) {
1211 if( $notice == '' ) {
1212 # We may also need to override a message with eg downtime info
1213 # FIXME: make this work!
1214 $notice = $wgSiteNotice;
1216 if($notice != '-' && $notice != '') {
1217 $specialparser = new Parser();
1218 $parserOutput = $specialparser->parse( $notice, $wgTitle, $wgOut->mParserOptions
, false );
1219 $notice = $parserOutput->getText();
1221 wfProfileOut( $fname );
1226 * Format an XML element with given attributes and, optionally, text content.
1227 * Element and attribute names are assumed to be ready for literal inclusion.
1228 * Strings are assumed to not contain XML-illegal characters; special
1229 * characters (<, >, &) are escaped but illegals are not touched.
1231 * @param string $element
1232 * @param array $attribs Name=>value pairs. Values will be escaped.
1233 * @param string $contents NULL to make an open tag only; '' for a contentless closed tag (default)
1236 function wfElement( $element, $attribs = null, $contents = '') {
1237 $out = '<' . $element;
1238 if( !is_null( $attribs ) ) {
1239 foreach( $attribs as $name => $val ) {
1240 $out .= ' ' . $name . '="' . htmlspecialchars( $val ) . '"';
1243 if( is_null( $contents ) ) {
1246 if( $contents == '' ) {
1250 $out .= htmlspecialchars( $contents );
1251 $out .= "</$element>";
1258 * Format an XML element as with wfElement(), but run text through the
1259 * UtfNormal::cleanUp() validator first to ensure that no invalid UTF-8
1262 * @param string $element
1263 * @param array $attribs Name=>value pairs. Values will be escaped.
1264 * @param string $contents NULL to make an open tag only; '' for a contentless closed tag (default)
1267 function wfElementClean( $element, $attribs = array(), $contents = '') {
1269 $attribs = array_map( array( 'UtfNormal', 'cleanUp' ), $attribs );
1272 $contents = UtfNormal
::cleanUp( $contents );
1274 return wfElement( $element, $attribs, $contents );
1278 * Create a namespace selector
1280 * @param mixed $selected The namespace which should be selected, default ''
1281 * @param string $allnamespaces Value of a special item denoting all namespaces. Null to not include (default)
1282 * @return Html string containing the namespace selector
1284 function &HTMLnamespaceselector($selected = '', $allnamespaces = null) {
1286 $s = "<select name='namespace' class='namespaceselector'>\n\t";
1287 $arr = $wgContLang->getFormattedNamespaces();
1288 if( !is_null($allnamespaces) ) {
1289 $arr = array($allnamespaces => wfMsgHtml('namespacesall')) +
$arr;
1291 foreach ($arr as $index => $name) {
1292 if ($index < NS_MAIN
) continue;
1294 $name = $index !== 0 ?
$name : wfMsgHtml('blanknamespace');
1296 if ($index === $selected) {
1297 $s .= wfElement("option",
1298 array("value" => $index, "selected" => "selected"),
1301 $s .= wfElement("option", array("value" => $index), $name);
1304 $s .= "\n</select>\n";
1308 /** Global singleton instance of MimeMagic. This is initialized on demand,
1309 * please always use the wfGetMimeMagic() function to get the instance.
1315 /** Factory functions for the global MimeMagic object.
1316 * This function always returns the same singleton instance of MimeMagic.
1317 * That objects will be instantiated on the first call to this function.
1318 * If needed, the MimeMagic.php file is automatically included by this function.
1319 * @return MimeMagic the global MimeMagic objects.
1321 function &wfGetMimeMagic() {
1322 global $wgMimeMagic;
1324 if (!is_null($wgMimeMagic)) {
1325 return $wgMimeMagic;
1328 if (!class_exists("MimeMagic")) {
1330 require_once("MimeMagic.php");
1333 $wgMimeMagic= new MimeMagic();
1335 return $wgMimeMagic;
1340 * Tries to get the system directory for temporary files.
1341 * The TMPDIR, TMP, and TEMP environment variables are checked in sequence,
1342 * and if none are set /tmp is returned as the generic Unix default.
1344 * NOTE: When possible, use the tempfile() function to create temporary
1345 * files to avoid race conditions on file creation, etc.
1349 function wfTempDir() {
1350 foreach( array( 'TMPDIR', 'TMP', 'TEMP' ) as $var ) {
1351 $tmp = getenv( $var );
1352 if( $tmp && file_exists( $tmp ) && is_dir( $tmp ) && is_writable( $tmp ) ) {
1356 # Hope this is Unix of some kind!
1361 * Make directory, and make all parent directories if they don't exist
1363 function wfMkdirParents( $fullDir, $mode ) {
1364 $parts = explode( '/', $fullDir );
1367 foreach ( $parts as $dir ) {
1368 $path .= $dir . '/';
1369 if ( !is_dir( $path ) ) {
1370 if ( !mkdir( $path, $mode ) ) {
1379 * Increment a statistics counter
1381 function wfIncrStats( $key ) {
1382 global $wgDBname, $wgMemc;
1383 $key = "$wgDBname:stats:$key";
1384 if ( is_null( $wgMemc->incr( $key ) ) ) {
1385 $wgMemc->add( $key, 1 );
1390 * @param mixed $nr The number to format
1391 * @param int $acc The number of digits after the decimal point, default 2
1392 * @param bool $round Whether or not to round the value, default true
1395 function wfPercent( $nr, $acc = 2, $round = true ) {
1396 $ret = sprintf( "%.${acc}f", $nr );
1397 return $round ?
round( $ret, $acc ) . '%' : "$ret%";
1401 * Encrypt a username/password.
1403 * @param string $userid ID of the user
1404 * @param string $password Password of the user
1405 * @return string Hashed password
1407 function wfEncryptPassword( $userid, $password ) {
1408 global $wgPasswordSalt;
1409 $p = md5( $password);
1412 return md5( "{$userid}-{$p}" );
1418 * Appends to second array if $value differs from that in $default
1420 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
1421 if ( is_null( $changed ) ) {
1422 wfDebugDieBacktrace('GlobalFunctions::wfAppendToArrayIfNotDefault got null');
1424 if ( $default[$key] !== $value ) {
1425 $changed[$key] = $value;
1430 * Since wfMsg() and co suck, they don't return false if the message key they
1431 * looked up didn't exist but a XHTML string, this function checks for the
1432 * nonexistance of messages by looking at wfMsg() output
1434 * @param $msg The message key looked up
1435 * @param $wfMsgOut The output of wfMsg*()
1438 function wfEmptyMsg( $msg, $wfMsgOut ) {
1439 return $wfMsgOut === "<$msg>";