9e334e518ef1132b69df741c644ed0ee58ffa67c
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 ) );
83 * html_entity_decode exists in PHP 4.3.0+ but is FATALLY BROKEN even then,
84 * with no UTF-8 support.
86 * @param string $string String having html entities
88 * @param string $charset Encoding set to use (default 'ISO-8859-1')
90 function do_html_entity_decode( $string, $quote_style=ENT_COMPAT
, $charset='ISO-8859-1' ) {
91 $fname = 'do_html_entity_decode';
92 wfProfileIn( $fname );
97 if( !isset( $trans ) ||
$savedCharset != $charset ) {
98 $trans = array_flip( get_html_translation_table( HTML_ENTITIES
, $quote_style ) );
99 $savedCharset = $charset;
101 # Note - mixing latin1 named entities and unicode numbered
102 # ones will result in a bad link.
103 if( strcasecmp( 'utf-8', $charset ) == 0 ) {
104 $trans = array_map( 'utf8_encode', $trans );
108 * Most links will _not_ contain these fun guys,
109 * and on long pages with many links we can get
112 * A regular expression search is faster than
113 * a strtr or str_replace with a hundred-ish
114 * entries, though it may be slower to actually
117 * They all look like '&xxxx;'...
119 foreach( $trans as $key => $val ) {
120 $snip[] = substr( $key, 1, -1 );
122 $regexp = '/(&(?:' . implode( '|', $snip ) . ');)/e';
125 $out = preg_replace( $regexp, '$trans["$1"]', $string );
126 wfProfileOut( $fname );
132 * Where as we got a random seed
133 * @var bool $wgTotalViews
135 $wgRandomSeeded = false;
138 * Seed Mersenne Twister
139 * Only necessary in PHP < 4.2.0
143 function wfSeedRandom() {
144 global $wgRandomSeeded;
146 if ( ! $wgRandomSeeded && version_compare( phpversion(), '4.2.0' ) < 0 ) {
147 $seed = hexdec(substr(md5(microtime()),-8)) & 0x7fffffff;
149 $wgRandomSeeded = true;
154 * Get a random decimal value between 0 and 1, in a way
155 * not likely to give duplicate values for any realistic
156 * number of articles.
160 function wfRandom() {
161 # The maximum random value is "only" 2^31-1, so get two random
162 # values to reduce the chance of dupes
163 $max = mt_getrandmax();
164 $rand = number_format( mt_rand() * mt_rand()
165 / $max / $max, 12, '.', '' );
170 * We want / and : to be included as literal characters in our title URLs.
171 * %2F in the page titles seems to fatally break for some reason.
176 function wfUrlencode ( $s ) {
177 $s = urlencode( $s );
178 $s = preg_replace( '/%3[Aa]/', ':', $s );
179 $s = preg_replace( '/%2[Ff]/', '/', $s );
185 * Return the UTF-8 sequence for a given Unicode code point.
186 * Currently doesn't work for values outside the Basic Multilingual Plane.
188 * @param string $codepoint UTF-8 code point.
189 * @return string HTML UTF-8 Entitie such as 'Ӓ'.
191 function wfUtf8Sequence( $codepoint ) {
192 if($codepoint < 0x80) return chr($codepoint);
193 if($codepoint < 0x800) return chr($codepoint >> 6 & 0x3f |
0xc0) .
194 chr($codepoint & 0x3f |
0x80);
195 if($codepoint < 0x10000) return chr($codepoint >> 12 & 0x0f |
0xe0) .
196 chr($codepoint >> 6 & 0x3f |
0x80) .
197 chr($codepoint & 0x3f |
0x80);
198 if($codepoint < 0x110000) return chr($codepoint >> 18 & 0x07 |
0xf0) .
199 chr($codepoint >> 12 & 0x3f |
0x80) .
200 chr($codepoint >> 6 & 0x3f |
0x80) .
201 chr($codepoint & 0x3f |
0x80);
203 # There should be no assigned code points outside this range, but...
204 return "&#$codepoint;";
208 * Converts numeric character entities to UTF-8
210 * @param string $string String to convert.
211 * @return string Converted string.
213 function wfMungeToUtf8( $string ) {
214 global $wgInputEncoding; # This is debatable
215 #$string = iconv($wgInputEncoding, "UTF-8", $string);
216 $string = preg_replace ( '/�*([0-9]+);/e', 'wfUtf8Sequence($1)', $string );
217 $string = preg_replace ( '/&#x([0-9a-f]+);/ie', 'wfUtf8Sequence(0x$1)', $string );
218 # Should also do named entities here
223 * Converts a single UTF-8 character into the corresponding HTML character
224 * entity (for use with preg_replace_callback)
226 * @param array $matches
229 function wfUtf8Entity( $matches ) {
230 $codepoint = utf8ToCodepoint( $matches[0] );
231 return "&#$codepoint;";
235 * Converts all multi-byte characters in a UTF-8 string into the appropriate
238 function wfUtf8ToHTML($string) {
239 return preg_replace_callback( '/[\\xc0-\\xfd][\\x80-\\xbf]*/', 'wfUtf8Entity', $string );
243 * Sends a line to the debug log if enabled or, optionally, to a comment in output.
244 * In normal operation this is a NOP.
246 * Controlling globals:
247 * $wgDebugLogFile - points to the log file
248 * $wgProfileOnly - if set, normal debug messages will not be recorded.
249 * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
250 * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
252 * @param string $text
253 * @param bool $logonly Set true to avoid appearing in HTML when $wgDebugComments is set
255 function wfDebug( $text, $logonly = false ) {
256 global $wgOut, $wgDebugLogFile, $wgDebugComments, $wgProfileOnly, $wgDebugRawPage;
258 # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
259 if ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' && !$wgDebugRawPage ) {
263 if ( isset( $wgOut ) && $wgDebugComments && !$logonly ) {
264 $wgOut->debug( $text );
266 if ( '' != $wgDebugLogFile && !$wgProfileOnly ) {
267 error_log( $text, 3, $wgDebugLogFile );
272 * Log for database errors
273 * @param string $text Database error message.
275 function wfLogDBError( $text ) {
276 global $wgDBerrorLog;
277 if ( $wgDBerrorLog ) {
278 $text = date('D M j G:i:s T Y') . "\t".$text;
279 error_log( $text, 3, $wgDBerrorLog );
286 function logProfilingData() {
287 global $wgRequestTime, $wgDebugLogFile, $wgDebugRawPage, $wgRequest;
288 global $wgProfiling, $wgProfileStack, $wgProfileLimit, $wgUser;
291 list( $usec, $sec ) = explode( ' ', $wgRequestTime );
292 $start = (float)$sec +
(float)$usec;
293 $elapsed = $now - $start;
294 if ( $wgProfiling ) {
295 $prof = wfGetProfilingOutput( $start, $elapsed );
297 if( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) )
298 $forward = ' forwarded for ' . $_SERVER['HTTP_X_FORWARDED_FOR'];
299 if( !empty( $_SERVER['HTTP_CLIENT_IP'] ) )
300 $forward .= ' client IP ' . $_SERVER['HTTP_CLIENT_IP'];
301 if( !empty( $_SERVER['HTTP_FROM'] ) )
302 $forward .= ' from ' . $_SERVER['HTTP_FROM'];
304 $forward = "\t(proxied via {$_SERVER['REMOTE_ADDR']}{$forward})";
305 if( $wgUser->isAnon() )
307 $log = sprintf( "%s\t%04.3f\t%s\n",
308 gmdate( 'YmdHis' ), $elapsed,
309 urldecode( $_SERVER['REQUEST_URI'] . $forward ) );
310 if ( '' != $wgDebugLogFile && ( $wgRequest->getVal('action') != 'raw' ||
$wgDebugRawPage ) ) {
311 error_log( $log . $prof, 3, $wgDebugLogFile );
317 * Check if the wiki read-only lock file is present. This can be used to lock
318 * off editing functions, but doesn't guarantee that the database will not be
322 function wfReadOnly() {
323 global $wgReadOnlyFile;
325 if ( '' == $wgReadOnlyFile ) {
328 return is_file( $wgReadOnlyFile );
333 * Get a message from anywhere, for the UI elements
335 function wfMsg( $key ) {
336 $args = func_get_args();
337 array_shift( $args );
338 return wfMsgReal( $key, $args, true );
342 * Get a message from anywhere, for the content
344 function wfMsgForContent( $key ) {
345 global $wgForceUIMsgAsContentMsg;
346 $args = func_get_args();
347 array_shift( $args );
349 if( is_array( $wgForceUIMsgAsContentMsg ) &&
350 in_array( $key, $wgForceUIMsgAsContentMsg ) )
352 return wfMsgReal( $key, $args, true, $forcontent );
356 * Get a message from the language file, for the UI elements
358 function wfMsgNoDB( $key ) {
359 $args = func_get_args();
360 array_shift( $args );
361 return wfMsgReal( $key, $args, false );
365 * Get a message from the language file, for the content
367 function wfMsgNoDBForContent( $key ) {
368 global $wgForceUIMsgAsContentMsg;
369 $args = func_get_args();
370 array_shift( $args );
372 if( is_array( $wgForceUIMsgAsContentMsg ) &&
373 in_array( $key, $wgForceUIMsgAsContentMsg ) )
375 return wfMsgReal( $key, $args, false, $forcontent );
380 * Really get a message
382 function wfMsgReal( $key, $args, $useDB, $forContent=false ) {
383 static $replacementKeys = array( '$1', '$2', '$3', '$4', '$5', '$6', '$7', '$8', '$9' );
384 global $wgParser, $wgMsgParserOptions;
385 global $wgContLang, $wgLanguageCode;
386 global $wgMessageCache, $wgLang;
388 $fname = 'wfMsgReal';
389 wfProfileIn( $fname );
391 if( is_object( $wgMessageCache ) ) {
392 $message = $wgMessageCache->get( $key, $useDB, $forContent );
395 $lang = &$wgContLang;
400 wfSuppressWarnings();
402 if( is_object( $lang ) ) {
403 $message = $lang->getMessage( $key );
409 $message = Language
::getMessage($key);
410 if(strstr($message, '{{' ) !== false) {
411 $message = $wgParser->transformMsg($message, $wgMsgParserOptions);
416 if( count( $args ) ) {
417 $message = str_replace( $replacementKeys, $args, $message );
419 wfProfileOut( $fname );
426 * Just like exit() but makes a note of it.
427 * Commits open transactions except if the error parameter is set
429 function wfAbruptExit( $error = false ){
430 global $wgLoadBalancer;
431 static $called = false;
437 if( function_exists( 'debug_backtrace' ) ){ // PHP >= 4.3
438 $bt = debug_backtrace();
439 for($i = 0; $i < count($bt) ; $i++
){
440 $file = $bt[$i]['file'];
441 $line = $bt[$i]['line'];
442 wfDebug("WARNING: Abrupt exit in $file at line $line\n");
445 wfDebug('WARNING: Abrupt exit\n');
448 $wgLoadBalancer->closeAll();
456 function wfErrorExit() {
457 wfAbruptExit( true );
461 * Die with a backtrace
462 * This is meant as a debugging aid to track down where bad data comes from.
463 * Shouldn't be used in production code except maybe in "shouldn't happen" areas.
465 * @param string $msg Message shown when dieing.
467 function wfDebugDieBacktrace( $msg = '' ) {
468 global $wgCommandLineMode;
470 $backtrace = wfBacktrace();
471 if ( $backtrace !== false ) {
472 if ( $wgCommandLineMode ) {
473 $msg .= "\nBacktrace:\n$backtrace";
475 $msg .= "\n<p>Backtrace:</p>\n$backtrace";
481 function wfBacktrace() {
482 global $wgCommandLineMode;
483 if ( !function_exists( 'debug_backtrace' ) ) {
487 if ( $wgCommandLineMode ) {
492 $backtrace = debug_backtrace();
493 foreach( $backtrace as $call ) {
494 if( isset( $call['file'] ) ) {
495 $f = explode( DIRECTORY_SEPARATOR
, $call['file'] );
496 $file = $f[count($f)-1];
500 if( isset( $call['line'] ) ) {
501 $line = $call['line'];
505 if ( $wgCommandLineMode ) {
506 $msg .= "$file line $line calls ";
508 $msg .= '<li>' . $file . ' line ' . $line . ' calls ';
510 if( !empty( $call['class'] ) ) $msg .= $call['class'] . '::';
511 $msg .= $call['function'] . '()';
513 if ( $wgCommandLineMode ) {
519 if ( $wgCommandLineMode ) {
529 /* Some generic result counters, pulled out of SearchEngine */
535 function wfShowingResults( $offset, $limit ) {
537 return wfMsg( 'showingresults', $wgLang->formatNum( $limit ), $wgLang->formatNum( $offset+
1 ) );
543 function wfShowingResultsNum( $offset, $limit, $num ) {
545 return wfMsg( 'showingresultsnum', $wgLang->formatNum( $limit ), $wgLang->formatNum( $offset+
1 ), $wgLang->formatNum( $num ) );
551 function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) {
552 global $wgUser, $wgLang;
553 $fmtLimit = $wgLang->formatNum( $limit );
554 $prev = wfMsg( 'prevn', $fmtLimit );
555 $next = wfMsg( 'nextn', $fmtLimit );
557 if( is_object( $link ) ) {
560 $title =& Title
::newFromText( $link );
561 if( is_null( $title ) ) {
566 $sk = $wgUser->getSkin();
567 if ( 0 != $offset ) {
568 $po = $offset - $limit;
569 if ( $po < 0 ) { $po = 0; }
570 $q = "limit={$limit}&offset={$po}";
571 if ( '' != $query ) { $q .= '&'.$query; }
572 $plink = '<a href="' . $title->escapeLocalUrl( $q ) . "\">{$prev}</a>";
573 } else { $plink = $prev; }
575 $no = $offset +
$limit;
576 $q = 'limit='.$limit.'&offset='.$no;
577 if ( '' != $query ) { $q .= '&'.$query; }
582 $nlink = '<a href="' . $title->escapeLocalUrl( $q ) . "\">{$next}</a>";
584 $nums = wfNumLink( $offset, 20, $title, $query ) . ' | ' .
585 wfNumLink( $offset, 50, $title, $query ) . ' | ' .
586 wfNumLink( $offset, 100, $title, $query ) . ' | ' .
587 wfNumLink( $offset, 250, $title, $query ) . ' | ' .
588 wfNumLink( $offset, 500, $title, $query );
590 return wfMsg( 'viewprevnext', $plink, $nlink, $nums );
596 function wfNumLink( $offset, $limit, &$title, $query = '' ) {
597 global $wgUser, $wgLang;
598 if ( '' == $query ) { $q = ''; }
599 else { $q = $query.'&'; }
600 $q .= 'limit='.$limit.'&offset='.$offset;
602 $fmtLimit = $wgLang->formatNum( $limit );
603 $s = '<a href="' . $title->escapeLocalUrl( $q ) . "\">{$fmtLimit}</a>";
609 * @todo FIXME: we may want to blacklist some broken browsers
611 * @return bool Whereas client accept gzip compression
613 function wfClientAcceptsGzip() {
616 # FIXME: we may want to blacklist some broken browsers
618 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
619 $_SERVER['HTTP_ACCEPT_ENCODING'],
621 if( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) return false;
622 wfDebug( " accepts gzip\n" );
630 * Yay, more global functions!
632 function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
634 return $wgRequest->getLimitOffset( $deflimit, $optionname );
638 * Escapes the given text so that it may be output using addWikiText()
639 * without any linking, formatting, etc. making its way through. This
640 * is achieved by substituting certain characters with HTML entities.
641 * As required by the callers, <nowiki> is not used. It currently does
642 * not filter out characters which have special meaning only at the
643 * start of a line, such as "*".
645 * @param string $text Text to be escaped
647 function wfEscapeWikiText( $text ) {
649 array( '[', '|', '\'', 'ISBN ' , '://' , "\n=", '{{' ),
650 array( '[', '|', ''', 'ISBN ', '://' , "\n=", '{{' ),
651 htmlspecialchars($text) );
658 function wfQuotedPrintable( $string, $charset = '' ) {
659 # Probably incomplete; see RFC 2045
660 if( empty( $charset ) ) {
661 global $wgInputEncoding;
662 $charset = $wgInputEncoding;
664 $charset = strtoupper( $charset );
665 $charset = str_replace( 'ISO-8859', 'ISO8859', $charset ); // ?
667 $illegal = '\x00-\x08\x0b\x0c\x0e-\x1f\x7f-\xff=';
668 $replace = $illegal . '\t ?_';
669 if( !preg_match( "/[$illegal]/", $string ) ) return $string;
670 $out = "=?$charset?Q?";
671 $out .= preg_replace( "/([$replace])/e", 'sprintf("=%02X",ord("$1"))', $string );
681 $st = explode( ' ', microtime() );
682 return (float)$st[0] +
(float)$st[1];
686 * Changes the first character to an HTML entity
688 function wfHtmlEscapeFirst( $text ) {
690 $newText = substr($text, 1);
691 return "&#$ord;$newText";
695 * Sets dest to source and returns the original value of dest
696 * If source is NULL, it just returns the value, it doesn't set the variable
698 function wfSetVar( &$dest, $source ) {
700 if ( !is_null( $source ) ) {
707 * As for wfSetVar except setting a bit
709 function wfSetBit( &$dest, $bit, $state = true ) {
710 $temp = (bool)($dest & $bit );
711 if ( !is_null( $state ) ) {
722 * This function takes two arrays as input, and returns a CGI-style string, e.g.
723 * "days=7&limit=100". Options in the first array override options in the second.
724 * Options set to "" will not be output.
726 function wfArrayToCGI( $array1, $array2 = NULL )
728 if ( !is_null( $array2 ) ) {
729 $array1 = $array1 +
$array2;
733 foreach ( $array1 as $key => $value ) {
734 if ( '' !== $value ) {
738 $cgi .= urlencode( $key ) . '=' . urlencode( $value );
745 * This is obsolete, use SquidUpdate::purge()
748 function wfPurgeSquidServers ($urlArr) {
749 SquidUpdate
::purge( $urlArr );
753 * Windows-compatible version of escapeshellarg()
754 * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
755 * function puts single quotes in regardless of OS
757 function wfEscapeShellArg( ) {
758 $args = func_get_args();
761 foreach ( $args as $arg ) {
768 if ( wfIsWindows() ) {
769 $retVal .= '"' . str_replace( '"','\"', $arg ) . '"';
771 $retVal .= escapeshellarg( $arg );
778 * wfMerge attempts to merge differences between three texts.
779 * Returns true for a clean merge and false for failure or a conflict.
781 function wfMerge( $old, $mine, $yours, &$result ){
784 # This check may also protect against code injection in
785 # case of broken installations.
786 if(! file_exists( $wgDiff3 ) ){
790 # Make temporary files
792 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
793 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
794 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
796 fwrite( $oldtextFile, $old ); fclose( $oldtextFile );
797 fwrite( $mytextFile, $mine ); fclose( $mytextFile );
798 fwrite( $yourtextFile, $yours ); fclose( $yourtextFile );
800 # Check for a conflict
801 $cmd = wfEscapeShellArg( $wgDiff3 ) . ' -a --overlap-only ' .
802 wfEscapeShellArg( $mytextName ) . ' ' .
803 wfEscapeShellArg( $oldtextName ) . ' ' .
804 wfEscapeShellArg( $yourtextName );
805 $handle = popen( $cmd, 'r' );
807 if( fgets( $handle, 1024 ) ){
815 $cmd = wfEscapeShellArg( $wgDiff3 ) . ' -a -e --merge ' .
816 wfEscapeShellArg( $mytextName, $oldtextName, $yourtextName );
817 $handle = popen( $cmd, 'r' );
820 $data = fread( $handle, 8192 );
821 if ( strlen( $data ) == 0 ) {
827 unlink( $mytextName ); unlink( $oldtextName ); unlink( $yourtextName );
834 function wfVarDump( $var ) {
836 $s = str_replace("\n","<br />\n", var_export( $var, true ) . "\n");
837 if ( headers_sent() ||
!@is_object
( $wgOut ) ) {
840 $wgOut->addHTML( $s );
845 * Provide a simple HTTP error.
847 function wfHttpError( $code, $label, $desc ) {
850 header( "HTTP/1.0 $code $label" );
851 header( "Status: $code $label" );
852 $wgOut->sendCacheControl();
854 header( 'Content-type: text/plain' );
859 * Converts an Accept-* header into an array mapping string values to quality
862 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
863 # No arg means accept anything (per HTTP spec)
865 return array( $def => 1 );
870 $parts = explode( ',', $accept );
872 foreach( $parts as $part ) {
873 # FIXME: doesn't deal with params like 'text/html; level=1'
874 @list
( $value, $qpart ) = explode( ';', $part );
875 if( !isset( $qpart ) ) {
877 } elseif( preg_match( '/q\s*=\s*(\d*\.\d+)/', $qpart, $match ) ) {
878 $prefs[$value] = $match[1];
886 * Checks if a given MIME type matches any of the keys in the given
887 * array. Basic wildcards are accepted in the array keys.
889 * Returns the matching MIME type (or wildcard) if a match, otherwise
892 * @param string $type
893 * @param array $avail
897 function mimeTypeMatch( $type, $avail ) {
898 if( array_key_exists($type, $avail) ) {
901 $parts = explode( '/', $type );
902 if( array_key_exists( $parts[0] . '/*', $avail ) ) {
903 return $parts[0] . '/*';
904 } elseif( array_key_exists( '*/*', $avail ) ) {
913 * Returns the 'best' match between a client's requested internet media types
914 * and the server's list of available types. Each list should be an associative
915 * array of type to preference (preference is a float between 0.0 and 1.0).
916 * Wildcards in the types are acceptable.
918 * @param array $cprefs Client's acceptable type list
919 * @param array $sprefs Server's offered types
922 * @todo FIXME: doesn't handle params like 'text/plain; charset=UTF-8'
923 * XXX: generalize to negotiate other stuff
925 function wfNegotiateType( $cprefs, $sprefs ) {
928 foreach( array_keys($sprefs) as $type ) {
929 $parts = explode( '/', $type );
930 if( $parts[1] != '*' ) {
931 $ckey = mimeTypeMatch( $type, $cprefs );
933 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
938 foreach( array_keys( $cprefs ) as $type ) {
939 $parts = explode( '/', $type );
940 if( $parts[1] != '*' && !array_key_exists( $type, $sprefs ) ) {
941 $skey = mimeTypeMatch( $type, $sprefs );
943 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
951 foreach( array_keys( $combine ) as $type ) {
952 if( $combine[$type] > $bestq ) {
954 $bestq = $combine[$type];
963 * Returns an array where the values in the first array are replaced by the
964 * values in the second array with the corresponding keys
968 function wfArrayLookup( $a, $b ) {
969 return array_flip( array_intersect( array_flip( $a ), array_keys( $b ) ) );
973 * Convenience function; returns MediaWiki timestamp for the present time.
976 function wfTimestampNow() {
978 return wfTimestamp( TS_MW
, time() );
982 * Reference-counted warning suppression
984 function wfSuppressWarnings( $end = false ) {
985 static $suppressCount = 0;
986 static $originalLevel = false;
989 if ( $suppressCount ) {
991 if ( !$suppressCount ) {
992 error_reporting( $originalLevel );
996 if ( !$suppressCount ) {
997 $originalLevel = error_reporting( E_ALL
& ~
( E_WARNING | E_NOTICE
) );
1004 * Restore error level to previous value
1006 function wfRestoreWarnings() {
1007 wfSuppressWarnings( true );
1010 # Autodetect, convert and provide timestamps of various types
1012 /** Standard unix timestamp (number of seconds since 1 Jan 1970) */
1013 define('TS_UNIX',0);
1014 /** MediaWiki concatenated string timestamp (yyyymmddhhmmss) */
1016 /** Standard database timestamp (yyyy-mm-dd hh:mm:ss) */
1018 /** For HTTP and e-mail headers -- output only */
1019 define('TS_RFC2822', 3 );
1024 function wfTimestamp($outputtype=TS_UNIX
,$ts=0) {
1027 } elseif (preg_match("/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)$/",$ts,$da)) {
1029 $uts=gmmktime((int)$da[4],(int)$da[5],(int)$da[6],
1030 (int)$da[2],(int)$da[3],(int)$da[1]);
1031 } elseif (preg_match("/^(\d{4})(\d\d)(\d\d)(\d\d)(\d\d)(\d\d)$/",$ts,$da)) {
1033 $uts=gmmktime((int)$da[4],(int)$da[5],(int)$da[6],
1034 (int)$da[2],(int)$da[3],(int)$da[1]);
1035 } elseif (preg_match("/^(\d{1,13})$/",$ts,$datearray)) {
1039 # Bogus value; fall back to the epoch...
1040 wfDebug("wfTimestamp() fed bogus time value: $outputtype; $ts\n");
1045 switch($outputtype) {
1049 return gmdate( 'YmdHis', $uts );
1051 return gmdate( 'Y-m-d H:i:s', $uts );
1053 return gmdate( 'D, d M Y H:i:s', $uts ) . ' GMT';
1055 wfDebugDieBacktrace( 'wfTimestamp() called with illegal output type.');
1060 * Check where as the operating system is Windows
1062 * @return bool True if it's windows, False otherwise.
1064 function wfIsWindows() {
1065 if (substr(php_uname(), 0, 7) == 'Windows') {
1073 * Swap two variables
1075 function swap( &$x, &$y ) {
1081 function wfGetSiteNotice() {
1082 global $wgSiteNotice, $wgTitle, $wgOut;
1083 $fname = 'wfGetSiteNotice';
1084 wfProfileIn( $fname );
1086 $notice = wfMsg( 'sitenotice' );
1087 if($notice == '<sitenotice>') $notice = '';
1088 # Allow individual wikis to turn it off
1089 if ( $notice == '-' ) {
1092 if ($notice == '') {
1093 $notice = $wgSiteNotice;
1095 if($notice != '-' && $notice != '') {
1096 $specialparser = new Parser();
1097 $parserOutput = $specialparser->parse( $notice, $wgTitle, $wgOut->mParserOptions
, false );
1098 $notice = $parserOutput->getText();
1101 wfProfileOut( $fname );
1106 * Format an XML element with given attributes and, optionally, text content.
1107 * Element and attribute names are assumed to be ready for literal inclusion.
1108 * Strings are assumed to not contain XML-illegal characters; special
1109 * characters (<, >, &) are escaped but illegals are not touched.
1111 * @param string $element
1112 * @param array $attribs Name=>value pairs. Values will be escaped.
1113 * @param bool $contents NULL to make an open tag only; '' for a contentless closed tag (default)
1116 function wfElement( $element, $attribs = array(), $contents = '') {
1117 $out = '<' . $element;
1118 foreach( $attribs as $name => $val ) {
1119 $out .= ' ' . $name . '="' . htmlspecialchars( $val ) . '"';
1121 if( is_null( $contents ) ) {
1124 if( $contents == '' ) {
1128 $out .= htmlspecialchars( $contents );
1129 $out .= "</$element>";