includes/GlobalFunctions.php

   1 <?php
   2
   3 /**
   4  * Global functions used everywhere
   5  * @package MediaWiki
   6  */
   7
   8 /**
   9  * Some globals and requires needed
  10  */
  11
  12 /**
  13  * Total number of articles
  14  * @global integer $wgNumberOfArticles
  15  */
  16 $wgNumberOfArticles = -1; # Unset
  17 /**
  18  * Total number of views
  19  * @global integer $wgTotalViews
  20  */
  21 $wgTotalViews = -1;
  22 /**
  23  * Total number of edits
  24  * @global integer $wgTotalEdits
  25  */
  26 $wgTotalEdits = -1;
  27
  28
  29 require_once( 'DatabaseFunctions.php' );
  30 require_once( 'UpdateClasses.php' );
  31 require_once( 'LogPage.php' );
  32 require_once( 'normal/UtfNormalUtil.php' );
  33
  34 /**
  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.
  39  */
  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 );
  48                 return $string;
  49         }
  50 }
  51
  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 ) );
  56         }
  57 }
  58
  59 if( !function_exists('is_a') ) {
  60         # Exists in PHP 4.2.0+
  61         function is_a( $object, $class_name ) {
  62                 return
  63                         (strcasecmp( get_class( $object ), $class_name ) == 0) ||
  64                          is_subclass_of( $object, $class_name );
  65         }
  66 }
  67
  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 );
  72
  73                 if( func_num_args() >= 3 ) {
  74                         $end = func_get_arg( 2 );
  75                         return join( '', array_slice( $ar[0], $start, $end ) );
  76                 } else {
  77                         return join( '', array_slice( $ar[0], $start ) );
  78                 }
  79         }
  80 }
  81
  82 /**
  83  * html_entity_decode exists in PHP 4.3.0+ but is FATALLY BROKEN even then,
  84  * with no UTF-8 support.
  85  *
  86  * @param string $string String having html entities
  87  * @param $quote_style
  88  * @param string $charset Encoding set to use (default 'ISO-8859-1')
  89  */
  90 function do_html_entity_decode( $string, $quote_style=ENT_COMPAT, $charset='ISO-8859-1' ) {
  91         $fname = 'do_html_entity_decode';
  92         wfProfileIn( $fname );
  93
  94         static $trans;
  95         static $savedCharset;
  96         static $regexp;
  97         if( !isset( $trans ) || $savedCharset != $charset ) {
  98                 $trans = array_flip( get_html_translation_table( HTML_ENTITIES, $quote_style ) );
  99                 $savedCharset = $charset;
 100
 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 );
 105                 }
 106
 107                 /**
 108                  * Most links will _not_ contain these fun guys,
 109                  * and on long pages with many links we can get
 110                  * called a lot.
 111                  *
 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
 115                  * replace things.
 116                  *
 117                  * They all look like '&xxxx;'...
 118                  */
 119                 foreach( $trans as $key => $val ) {
 120                         $snip[] = substr( $key, 1, -1 );
 121                 }
 122                 $regexp = '/(&(?:' . implode( '|', $snip ) . ');)/e';
 123         }
 124
 125         $out = preg_replace( $regexp, '$trans["$1"]', $string );
 126         wfProfileOut( $fname );
 127         return $out;
 128 }
 129
 130
 131 /**
 132  * Where as we got a random seed
 133  * @var bool $wgTotalViews
 134  */
 135 $wgRandomSeeded = false;
 136
 137 /**
 138  * Seed Mersenne Twister
 139  * Only necessary in PHP < 4.2.0
 140  *
 141  * @return bool
 142  */
 143 function wfSeedRandom() {
 144         global $wgRandomSeeded;
 145
 146         if ( ! $wgRandomSeeded && version_compare( phpversion(), '4.2.0' ) < 0 ) {
 147                 $seed = hexdec(substr(md5(microtime()),-8)) & 0x7fffffff;
 148                 mt_srand( $seed );
 149                 $wgRandomSeeded = true;
 150         }
 151 }
 152
 153 /**
 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.
 157  *
 158  * @return string
 159  */
 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, '.', '' );
 166         return $rand;
 167 }
 168
 169 /**
 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.
 172  *
 173  * @param string $s
 174  * @return string
 175 */
 176 function wfUrlencode ( $s ) {
 177         $s = urlencode( $s );
 178         $s = preg_replace( '/%3[Aa]/', ':', $s );
 179         $s = preg_replace( '/%2[Ff]/', '/', $s );
 180
 181         return $s;
 182 }
 183
 184 /**
 185  * Return the UTF-8 sequence for a given Unicode code point.
 186  * Currently doesn't work for values outside the Basic Multilingual Plane.
 187  *
 188  * @param string $codepoint UTF-8 code point.
 189  * @return string HTML UTF-8 Entitie such as '&#1234;'.
 190  */
 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);
 202
 203         # There should be no assigned code points outside this range, but...
 204         return "&#$codepoint;";
 205 }
 206
 207 /**
 208  * Converts numeric character entities to UTF-8
 209  *
 210  * @param string $string String to convert.
 211  * @return string Converted string.
 212  */
 213 function wfMungeToUtf8( $string ) {
 214         global $wgInputEncoding; # This is debatable
 215         #$string = iconv($wgInputEncoding, "UTF-8", $string);
 216         $string = preg_replace ( '/&#0*([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
 219         return $string;
 220 }
 221
 222 /**
 223  * Converts a single UTF-8 character into the corresponding HTML character
 224  * entity (for use with preg_replace_callback)
 225  *
 226  * @param array $matches
 227  *
 228  */
 229 function wfUtf8Entity( $matches ) {
 230         $codepoint = utf8ToCodepoint( $matches[0] );
 231         return "&#$codepoint;";
 232 }
 233
 234 /**
 235  * Converts all multi-byte characters in a UTF-8 string into the appropriate
 236  * character entity
 237  */
 238 function wfUtf8ToHTML($string) {
 239         return preg_replace_callback( '/[\\xc0-\\xfd][\\x80-\\xbf]*/', 'wfUtf8Entity', $string );
 240 }
 241
 242 /**
 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.
 245  *
 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.
 251  *
 252  * @param string $text
 253  * @param bool $logonly Set true to avoid appearing in HTML when $wgDebugComments is set
 254  */
 255 function wfDebug( $text, $logonly = false ) {
 256         global $wgOut, $wgDebugLogFile, $wgDebugComments, $wgProfileOnly, $wgDebugRawPage;
 257
 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 ) {
 260                 return;
 261         }
 262
 263         if ( isset( $wgOut ) && $wgDebugComments && !$logonly ) {
 264                 $wgOut->debug( $text );
 265         }
 266         if ( '' != $wgDebugLogFile && !$wgProfileOnly ) {
 267                 @error_log( $text, 3, $wgDebugLogFile );
 268         }
 269 }
 270
 271 /**
 272  * Log for database errors
 273  * @param string $text Database error message.
 274  */
 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 );
 280         }
 281 }
 282
 283 /**
 284  * @todo document
 285  */
 286 function logProfilingData() {
 287         global $wgRequestTime, $wgDebugLogFile, $wgDebugRawPage, $wgRequest;
 288         global $wgProfiling, $wgProfileStack, $wgProfileLimit, $wgUser;
 289         $now = wfTime();
 290
 291         list( $usec, $sec ) = explode( ' ', $wgRequestTime );
 292         $start = (float)$sec + (float)$usec;
 293         $elapsed = $now - $start;
 294         if ( $wgProfiling ) {
 295                 $prof = wfGetProfilingOutput( $start, $elapsed );
 296                 $forward = '';
 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'];
 303                 if( $forward )
 304                         $forward = "\t(proxied via {$_SERVER['REMOTE_ADDR']}{$forward})";
 305                 if( $wgUser->isAnon() )
 306                         $forward .= ' anon';
 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 );
 312                 }
 313         }
 314 }
 315
 316 /**
 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
 319  * modified.
 320  * @return bool
 321  */
 322 function wfReadOnly() {
 323         global $wgReadOnlyFile;
 324
 325         if ( '' == $wgReadOnlyFile ) {
 326                 return false;
 327         }
 328         return is_file( $wgReadOnlyFile );
 329 }
 330
 331
 332 /**
 333  * Get a message from anywhere, for the UI elements
 334  */
 335 function wfMsg( $key ) {
 336         $args = func_get_args();
 337         array_shift( $args );
 338         return wfMsgReal( $key, $args, true );
 339 }
 340
 341 /**
 342  * Get a message from anywhere, for the content
 343  */
 344 function wfMsgForContent( $key ) {
 345         global $wgForceUIMsgAsContentMsg;
 346         $args = func_get_args();
 347         array_shift( $args );
 348         $forcontent = true;
 349         if( is_array( $wgForceUIMsgAsContentMsg ) &&
 350                 in_array( $key, $wgForceUIMsgAsContentMsg ) )
 351                 $forcontent = false;
 352         return wfMsgReal( $key, $args, true, $forcontent );
 353 }
 354
 355 /**
 356  * Get a message from the language file, for the UI elements
 357  */
 358 function wfMsgNoDB( $key ) {
 359         $args = func_get_args();
 360         array_shift( $args );
 361         return wfMsgReal( $key, $args, false );
 362 }
 363
 364 /**
 365  * Get a message from the language file, for the content
 366  */
 367 function wfMsgNoDBForContent( $key ) {
 368         global $wgForceUIMsgAsContentMsg;
 369         $args = func_get_args();
 370         array_shift( $args );
 371         $forcontent = true;
 372         if( is_array( $wgForceUIMsgAsContentMsg ) &&
 373                 in_array( $key, $wgForceUIMsgAsContentMsg ) )
 374                 $forcontent = false;
 375         return wfMsgReal( $key, $args, false, $forcontent );
 376 }
 377
 378
 379 /**
 380  * Really get a message
 381  */
 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;
 387
 388         $fname = 'wfMsgReal';
 389         wfProfileIn( $fname );
 390
 391         if( is_object( $wgMessageCache ) ) {
 392                 $message = $wgMessageCache->get( $key, $useDB, $forContent );
 393         } else {
 394                 if( $forContent ) {
 395                         $lang = &$wgContLang;
 396                 } else {
 397                         $lang = &$wgLang;
 398                 }
 399
 400                 wfSuppressWarnings();
 401
 402                 if( is_object( $lang ) ) {
 403                         $message = $lang->getMessage( $key );
 404                 } else {
 405                         $message = '';
 406                 }
 407                 wfRestoreWarnings();
 408                 if(!$message)
 409                         $message = Language::getMessage($key);
 410                 if(strstr($message, '{{' ) !== false) {
 411                         $message = $wgParser->transformMsg($message, $wgMsgParserOptions);
 412                 }
 413         }
 414
 415         # Replace arguments
 416         if( count( $args ) ) {
 417                 $message = str_replace( $replacementKeys, $args, $message );
 418         }
 419         wfProfileOut( $fname );
 420         return $message;
 421 }
 422
 423
 424
 425 /**
 426  * Just like exit() but makes a note of it.
 427  * Commits open transactions except if the error parameter is set
 428  */
 429 function wfAbruptExit( $error = false ){
 430         global $wgLoadBalancer;
 431         static $called = false;
 432         if ( $called ){
 433                 exit();
 434         }
 435         $called = true;
 436
 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");
 443                 }
 444         } else {
 445                 wfDebug('WARNING: Abrupt exit\n');
 446         }
 447         if ( !$error ) {
 448                 $wgLoadBalancer->closeAll();
 449         }
 450         exit();
 451 }
 452
 453 /**
 454  * @todo document
 455  */
 456 function wfErrorExit() {
 457         wfAbruptExit( true );
 458 }
 459
 460 /**
 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.
 464  *
 465  * @param string $msg Message shown when dieing.
 466  */
 467 function wfDebugDieBacktrace( $msg = '' ) {
 468         global $wgCommandLineMode;
 469
 470         $backtrace = wfBacktrace();
 471         if ( $backtrace !== false ) {
 472                 if ( $wgCommandLineMode ) {
 473                         $msg .= "\nBacktrace:\n$backtrace";
 474                 } else {
 475                         $msg .= "\n<p>Backtrace:</p>\n$backtrace";
 476                 }
 477          }
 478          die( $msg );
 479 }
 480
 481 function wfBacktrace() {
 482         global $wgCommandLineMode;
 483         if ( !function_exists( 'debug_backtrace' ) ) {
 484                 return false;
 485         }
 486
 487         if ( $wgCommandLineMode ) {
 488                 $msg = '';
 489         } else {
 490                 $msg = "<ul>\n";
 491         }
 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];
 497                 } else {
 498                         $file = '-';
 499                 }
 500                 if( isset( $call['line'] ) ) {
 501                         $line = $call['line'];
 502                 } else {
 503                         $line = '-';
 504                 }
 505                 if ( $wgCommandLineMode ) {
 506                         $msg .= "$file line $line calls ";
 507                 } else {
 508                         $msg .= '<li>' . $file . ' line ' . $line . ' calls ';
 509                 }
 510                 if( !empty( $call['class'] ) ) $msg .= $call['class'] . '::';
 511                 $msg .= $call['function'] . '()';
 512
 513                 if ( $wgCommandLineMode ) {
 514                         $msg .= "\n";
 515                 } else {
 516                         $msg .= "</li>\n";
 517                 }
 518         }
 519         if ( $wgCommandLineMode ) {
 520                 $msg .= "\n";
 521         } else {
 522                 $msg .= "</ul>\n";
 523         }
 524
 525         return $msg;
 526 }
 527
 528
 529 /* Some generic result counters, pulled out of SearchEngine */
 530
 531
 532 /**
 533  * @todo document
 534  */
 535 function wfShowingResults( $offset, $limit ) {
 536         global $wgLang;
 537         return wfMsg( 'showingresults', $wgLang->formatNum( $limit ), $wgLang->formatNum( $offset+1 ) );
 538 }
 539
 540 /**
 541  * @todo document
 542  */
 543 function wfShowingResultsNum( $offset, $limit, $num ) {
 544         global $wgLang;
 545         return wfMsg( 'showingresultsnum', $wgLang->formatNum( $limit ), $wgLang->formatNum( $offset+1 ), $wgLang->formatNum( $num ) );
 546 }
 547
 548 /**
 549  * @todo document
 550  */
 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 );
 556
 557         if( is_object( $link ) ) {
 558                 $title =& $link;
 559         } else {
 560                 $title =& Title::newFromText( $link );
 561                 if( is_null( $title ) ) {
 562                         return false;
 563                 }
 564         }
 565
 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; }
 574
 575         $no = $offset + $limit;
 576         $q = 'limit='.$limit.'&offset='.$no;
 577         if ( '' != $query ) { $q .= '&'.$query; }
 578
 579         if ( $atend ) {
 580                 $nlink = $next;
 581         } else {
 582                 $nlink = '<a href="' . $title->escapeLocalUrl( $q ) . "\">{$next}</a>";
 583         }
 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 );
 589
 590         return wfMsg( 'viewprevnext', $plink, $nlink, $nums );
 591 }
 592
 593 /**
 594  * @todo document
 595  */
 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;
 601
 602         $fmtLimit = $wgLang->formatNum( $limit );
 603         $s = '<a href="' . $title->escapeLocalUrl( $q ) . "\">{$fmtLimit}</a>";
 604         return $s;
 605 }
 606
 607 /**
 608  * @todo document
 609  * @todo FIXME: we may want to blacklist some broken browsers
 610  *
 611  * @return bool Whereas client accept gzip compression
 612  */
 613 function wfClientAcceptsGzip() {
 614         global $wgUseGzip;
 615         if( $wgUseGzip ) {
 616                 # FIXME: we may want to blacklist some broken browsers
 617                 if( preg_match(
 618                         '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
 619                         $_SERVER['HTTP_ACCEPT_ENCODING'],
 620                         $m ) ) {
 621                         if( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) return false;
 622                         wfDebug( " accepts gzip\n" );
 623                         return true;
 624                 }
 625         }
 626         return false;
 627 }
 628
 629 /**
 630  * Yay, more global functions!
 631  */
 632 function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
 633         global $wgRequest;
 634         return $wgRequest->getLimitOffset( $deflimit, $optionname );
 635 }
 636
 637 /**
 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 "*".
 644  *
 645  * @param string $text Text to be escaped
 646  */
 647 function wfEscapeWikiText( $text ) {
 648         $text = str_replace(
 649                 array( '[',             '|',      '\'',    'ISBN '        , '://'         , "\n=", '{{' ),
 650                 array( '&#91;', '&#124;', '&#39;', 'ISBN&#32;', '&#58;//' , "\n&#61;", '&#123;&#123;' ),
 651                 htmlspecialchars($text) );
 652         return $text;
 653 }
 654
 655 /**
 656  * @todo document
 657  */
 658 function wfQuotedPrintable( $string, $charset = '' ) {
 659         # Probably incomplete; see RFC 2045
 660         if( empty( $charset ) ) {
 661                 global $wgInputEncoding;
 662                 $charset = $wgInputEncoding;
 663         }
 664         $charset = strtoupper( $charset );
 665         $charset = str_replace( 'ISO-8859', 'ISO8859', $charset ); // ?
 666
 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 );
 672         $out .= '?=';
 673         return $out;
 674 }
 675
 676 /**
 677  * Returns an escaped string suitable for inclusion in a string literal
 678  * for JavaScript source code.
 679  * Illegal control characters are assumed not to be present.
 680  *
 681  * @param string $string
 682  * @return string
 683  */
 684 function wfEscapeJsString( $string ) {
 685         // See ECMA 262 section 7.8.4 for string literal format
 686         $pairs = array(
 687                 "\\" => "\\\\",
 688                 "\"" => "\\\"",
 689                 "\'" => "\\\'",
 690                 "\n" => "\\n",
 691                 "\r" => "\\r",
 692
 693                 # To avoid closing the element or CDATA section
 694                 "<" => "\\x3c",
 695                 ">" => "\\x3e",
 696         );
 697         return strtr( $string, $pairs );
 698 }
 699
 700 /**
 701  * @todo document
 702  * @return float
 703  */
 704 function wfTime() {
 705         $st = explode( ' ', microtime() );
 706         return (float)$st[0] + (float)$st[1];
 707 }
 708
 709 /**
 710  * Changes the first character to an HTML entity
 711  */
 712 function wfHtmlEscapeFirst( $text ) {
 713         $ord = ord($text);
 714         $newText = substr($text, 1);
 715         return "&#$ord;$newText";
 716 }
 717
 718 /**
 719  * Sets dest to source and returns the original value of dest
 720  * If source is NULL, it just returns the value, it doesn't set the variable
 721  */
 722 function wfSetVar( &$dest, $source ) {
 723         $temp = $dest;
 724         if ( !is_null( $source ) ) {
 725                 $dest = $source;
 726         }
 727         return $temp;
 728 }
 729
 730 /**
 731  * As for wfSetVar except setting a bit
 732  */
 733 function wfSetBit( &$dest, $bit, $state = true ) {
 734         $temp = (bool)($dest & $bit );
 735         if ( !is_null( $state ) ) {
 736                 if ( $state ) {
 737                         $dest |= $bit;
 738                 } else {
 739                         $dest &= ~$bit;
 740                 }
 741         }
 742         return $temp;
 743 }
 744
 745 /**
 746  * This function takes two arrays as input, and returns a CGI-style string, e.g.
 747  * "days=7&limit=100". Options in the first array override options in the second.
 748  * Options set to "" will not be output.
 749  */
 750 function wfArrayToCGI( $array1, $array2 = NULL )
 751 {
 752         if ( !is_null( $array2 ) ) {
 753                 $array1 = $array1 + $array2;
 754         }
 755
 756         $cgi = '';
 757         foreach ( $array1 as $key => $value ) {
 758                 if ( '' !== $value ) {
 759                         if ( '' != $cgi ) {
 760                                 $cgi .= '&';
 761                         }
 762                         $cgi .= urlencode( $key ) . '=' . urlencode( $value );
 763                 }
 764         }
 765         return $cgi;
 766 }
 767
 768 /**
 769  * This is obsolete, use SquidUpdate::purge()
 770  * @deprecated
 771  */
 772 function wfPurgeSquidServers ($urlArr) {
 773         SquidUpdate::purge( $urlArr );
 774 }
 775
 776 /**
 777  * Windows-compatible version of escapeshellarg()
 778  * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
 779  * function puts single quotes in regardless of OS
 780  */
 781 function wfEscapeShellArg( ) {
 782         $args = func_get_args();
 783         $first = true;
 784         $retVal = '';
 785         foreach ( $args as $arg ) {
 786                 if ( !$first ) {
 787                         $retVal .= ' ';
 788                 } else {
 789                         $first = false;
 790                 }
 791
 792                 if ( wfIsWindows() ) {
 793                         $retVal .= '"' . str_replace( '"','\"', $arg ) . '"';
 794                 } else {
 795                         $retVal .= escapeshellarg( $arg );
 796                 }
 797         }
 798         return $retVal;
 799 }
 800
 801 /**
 802  * wfMerge attempts to merge differences between three texts.
 803  * Returns true for a clean merge and false for failure or a conflict.
 804  */
 805 function wfMerge( $old, $mine, $yours, &$result ){
 806         global $wgDiff3;
 807
 808         # This check may also protect against code injection in
 809         # case of broken installations.
 810         if(! file_exists( $wgDiff3 ) ){
 811                 return false;
 812         }
 813
 814         # Make temporary files
 815         $td = '/tmp/';
 816         $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
 817         $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
 818         $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
 819
 820         fwrite( $oldtextFile, $old ); fclose( $oldtextFile );
 821         fwrite( $mytextFile, $mine ); fclose( $mytextFile );
 822         fwrite( $yourtextFile, $yours ); fclose( $yourtextFile );
 823
 824         # Check for a conflict
 825         $cmd = wfEscapeShellArg( $wgDiff3 ) . ' -a --overlap-only ' .
 826           wfEscapeShellArg( $mytextName ) . ' ' .
 827           wfEscapeShellArg( $oldtextName ) . ' ' .
 828           wfEscapeShellArg( $yourtextName );
 829         $handle = popen( $cmd, 'r' );
 830
 831         if( fgets( $handle, 1024 ) ){
 832                 $conflict = true;
 833         } else {
 834                 $conflict = false;
 835         }
 836         pclose( $handle );
 837
 838         # Merge differences
 839         $cmd = wfEscapeShellArg( $wgDiff3 ) . ' -a -e --merge ' .
 840           wfEscapeShellArg( $mytextName, $oldtextName, $yourtextName );
 841         $handle = popen( $cmd, 'r' );
 842         $result = '';
 843         do {
 844                 $data = fread( $handle, 8192 );
 845                 if ( strlen( $data ) == 0 ) {
 846                         break;
 847                 }
 848                 $result .= $data;
 849         } while ( true );
 850         pclose( $handle );
 851         unlink( $mytextName ); unlink( $oldtextName ); unlink( $yourtextName );
 852         return ! $conflict;
 853 }
 854
 855 /**
 856  * @todo document
 857  */
 858 function wfVarDump( $var ) {
 859         global $wgOut;
 860         $s = str_replace("\n","<br />\n", var_export( $var, true ) . "\n");
 861         if ( headers_sent() || !@is_object( $wgOut ) ) {
 862                 print $s;
 863         } else {
 864                 $wgOut->addHTML( $s );
 865         }
 866 }
 867
 868 /**
 869  * Provide a simple HTTP error.
 870  */
 871 function wfHttpError( $code, $label, $desc ) {
 872         global $wgOut;
 873         $wgOut->disable();
 874         header( "HTTP/1.0 $code $label" );
 875         header( "Status: $code $label" );
 876         $wgOut->sendCacheControl();
 877
 878         header( 'Content-type: text/plain' );
 879         print $desc."\n";
 880 }
 881
 882 /**
 883  * Converts an Accept-* header into an array mapping string values to quality
 884  * factors
 885  */
 886 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
 887         # No arg means accept anything (per HTTP spec)
 888         if( !$accept ) {
 889                 return array( $def => 1 );
 890         }
 891
 892         $prefs = array();
 893
 894         $parts = explode( ',', $accept );
 895
 896         foreach( $parts as $part ) {
 897                 # FIXME: doesn't deal with params like 'text/html; level=1'
 898                 @list( $value, $qpart ) = explode( ';', $part );
 899                 if( !isset( $qpart ) ) {
 900                         $prefs[$value] = 1;
 901                 } elseif( preg_match( '/q\s*=\s*(\d*\.\d+)/', $qpart, $match ) ) {
 902                         $prefs[$value] = $match[1];
 903                 }
 904         }
 905
 906         return $prefs;
 907 }
 908
 909 /**
 910  * Checks if a given MIME type matches any of the keys in the given
 911  * array. Basic wildcards are accepted in the array keys.
 912  *
 913  * Returns the matching MIME type (or wildcard) if a match, otherwise
 914  * NULL if no match.
 915  *
 916  * @param string $type
 917  * @param array $avail
 918  * @return string
 919  * @access private
 920  */
 921 function mimeTypeMatch( $type, $avail ) {
 922         if( array_key_exists($type, $avail) ) {
 923                 return $type;
 924         } else {
 925                 $parts = explode( '/', $type );
 926                 if( array_key_exists( $parts[0] . '/*', $avail ) ) {
 927                         return $parts[0] . '/*';
 928                 } elseif( array_key_exists( '*/*', $avail ) ) {
 929                         return '*/*';
 930                 } else {
 931                         return NULL;
 932                 }
 933         }
 934 }
 935
 936 /**
 937  * Returns the 'best' match between a client's requested internet media types
 938  * and the server's list of available types. Each list should be an associative
 939  * array of type to preference (preference is a float between 0.0 and 1.0).
 940  * Wildcards in the types are acceptable.
 941  *
 942  * @param array $cprefs Client's acceptable type list
 943  * @param array $sprefs Server's offered types
 944  * @return string
 945  *
 946  * @todo FIXME: doesn't handle params like 'text/plain; charset=UTF-8'
 947  * XXX: generalize to negotiate other stuff
 948  */
 949 function wfNegotiateType( $cprefs, $sprefs ) {
 950         $combine = array();
 951
 952         foreach( array_keys($sprefs) as $type ) {
 953                 $parts = explode( '/', $type );
 954                 if( $parts[1] != '*' ) {
 955                         $ckey = mimeTypeMatch( $type, $cprefs );
 956                         if( $ckey ) {
 957                                 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
 958                         }
 959                 }
 960         }
 961
 962         foreach( array_keys( $cprefs ) as $type ) {
 963                 $parts = explode( '/', $type );
 964                 if( $parts[1] != '*' && !array_key_exists( $type, $sprefs ) ) {
 965                         $skey = mimeTypeMatch( $type, $sprefs );
 966                         if( $skey ) {
 967                                 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
 968                         }
 969                 }
 970         }
 971
 972         $bestq = 0;
 973         $besttype = NULL;
 974
 975         foreach( array_keys( $combine ) as $type ) {
 976                 if( $combine[$type] > $bestq ) {
 977                         $besttype = $type;
 978                         $bestq = $combine[$type];
 979                 }
 980         }
 981
 982         return $besttype;
 983 }
 984
 985 /**
 986  * Array lookup
 987  * Returns an array where the values in the first array are replaced by the
 988  * values in the second array with the corresponding keys
 989  *
 990  * @return array
 991  */
 992 function wfArrayLookup( $a, $b ) {
 993         return array_flip( array_intersect( array_flip( $a ), array_keys( $b ) ) );
 994 }
 995
 996 /**
 997  * Convenience function; returns MediaWiki timestamp for the present time.
 998  * @return string
 999  */
1000 function wfTimestampNow() {
1001         # return NOW
1002         return wfTimestamp( TS_MW, time() );
1003 }
1004
1005 /**
1006  * Reference-counted warning suppression
1007  */
1008 function wfSuppressWarnings( $end = false ) {
1009         static $suppressCount = 0;
1010         static $originalLevel = false;
1011
1012         if ( $end ) {
1013                 if ( $suppressCount ) {
1014                         $suppressCount --;
1015                         if ( !$suppressCount ) {
1016                                 error_reporting( $originalLevel );
1017                         }
1018                 }
1019         } else {
1020                 if ( !$suppressCount ) {
1021                         $originalLevel = error_reporting( E_ALL & ~( E_WARNING | E_NOTICE ) );
1022                 }
1023                 $suppressCount++;
1024         }
1025 }
1026
1027 /**
1028  * Restore error level to previous value
1029  */
1030 function wfRestoreWarnings() {
1031         wfSuppressWarnings( true );
1032 }
1033
1034 # Autodetect, convert and provide timestamps of various types
1035
1036 /** Standard unix timestamp (number of seconds since 1 Jan 1970) */
1037 define('TS_UNIX',0);
1038 /** MediaWiki concatenated string timestamp (yyyymmddhhmmss) */
1039 define('TS_MW',1);
1040 /** Standard database timestamp (yyyy-mm-dd hh:mm:ss) */
1041 define('TS_DB',2);
1042 /** For HTTP and e-mail headers -- output only */
1043 define('TS_RFC2822', 3 );
1044
1045 /**
1046  * @todo document
1047  */
1048 function wfTimestamp($outputtype=TS_UNIX,$ts=0) {
1049         if ($ts==0) {
1050                 $uts=time();
1051         } elseif (preg_match("/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)$/",$ts,$da)) {
1052                 # TS_DB
1053                 $uts=gmmktime((int)$da[4],(int)$da[5],(int)$da[6],
1054                             (int)$da[2],(int)$da[3],(int)$da[1]);
1055         } elseif (preg_match("/^(\d{4})(\d\d)(\d\d)(\d\d)(\d\d)(\d\d)$/",$ts,$da)) {
1056                 # TS_MW
1057                 $uts=gmmktime((int)$da[4],(int)$da[5],(int)$da[6],
1058                             (int)$da[2],(int)$da[3],(int)$da[1]);
1059         } elseif (preg_match("/^(\d{1,13})$/",$ts,$datearray)) {
1060                 # TS_UNIX
1061                 $uts=$ts;
1062         } else {
1063                 # Bogus value; fall back to the epoch...
1064                 wfDebug("wfTimestamp() fed bogus time value: $outputtype; $ts\n");
1065                 $uts = 0;
1066         }
1067
1068
1069         switch($outputtype) {
1070                 case TS_UNIX:
1071                         return $uts;
1072                 case TS_MW:
1073                         return gmdate( 'YmdHis', $uts );
1074                 case TS_DB:
1075                         return gmdate( 'Y-m-d H:i:s', $uts );
1076                 case TS_RFC2822:
1077                         return gmdate( 'D, d M Y H:i:s', $uts ) . ' GMT';
1078                 default:
1079                         wfDebugDieBacktrace( 'wfTimestamp() called with illegal output type.');
1080         }
1081 }
1082
1083 /**
1084  * Return a formatted timestamp, or null if input is null.
1085  * For dealing with nullable timestamp columns in the database.
1086  * @param int $outputtype
1087  * @param string $ts
1088  * @return string
1089  */
1090 function wfTimestampOrNull( $outputtype = TS_UNIX, $ts = null ) {
1091         if( is_null( $ts ) ) {
1092                 return null;
1093         } else {
1094                 return wfTimestamp( $outputtype, $ts );
1095         }
1096 }
1097
1098 /**
1099  * Check where as the operating system is Windows
1100  *
1101  * @return bool True if it's windows, False otherwise.
1102  */
1103 function wfIsWindows() {
1104         if (substr(php_uname(), 0, 7) == 'Windows') {
1105                 return true;
1106         } else {
1107                 return false;
1108         }
1109 }
1110
1111 /**
1112  * Swap two variables
1113  */
1114 function swap( &$x, &$y ) {
1115         $z = $x;
1116         $x = $y;
1117         $y = $z;
1118 }
1119
1120 function wfGetSiteNotice() {
1121         global $wgSiteNotice, $wgTitle, $wgOut;
1122         $fname = 'wfGetSiteNotice';
1123         wfProfileIn( $fname );
1124
1125         $notice = wfMsg( 'sitenotice' );
1126         if($notice == '&lt;sitenotice&gt;') $notice = '';
1127         # Allow individual wikis to turn it off
1128         if ( $notice == '-' ) {
1129                 $notice = '';
1130         } else {
1131                 if ($notice == '') {
1132                         $notice = $wgSiteNotice;
1133                 }
1134                 if($notice != '-' && $notice != '') {
1135                         $specialparser = new Parser();
1136                         $parserOutput = $specialparser->parse( $notice, $wgTitle, $wgOut->mParserOptions, false );
1137                         $notice = $parserOutput->getText();
1138                 }
1139         }
1140         wfProfileOut( $fname );
1141         return $notice;
1142 }
1143
1144 /**
1145  * Format an XML element with given attributes and, optionally, text content.
1146  * Element and attribute names are assumed to be ready for literal inclusion.
1147  * Strings are assumed to not contain XML-illegal characters; special
1148  * characters (<, >, &) are escaped but illegals are not touched.
1149  *
1150  * @param string $element
1151  * @param array $attribs Name=>value pairs. Values will be escaped.
1152  * @param bool $contents NULL to make an open tag only; '' for a contentless closed tag (default)
1153  * @return string
1154  */
1155 function wfElement( $element, $attribs = array(), $contents = '') {
1156         $out = '<' . $element;
1157         foreach( $attribs as $name => $val ) {
1158                 $out .= ' ' . $name . '="' . htmlspecialchars( $val ) . '"';
1159         }
1160         if( is_null( $contents ) ) {
1161                 $out .= '>';
1162         } else {
1163                 if( $contents == '' ) {
1164                         $out .= ' />';
1165                 } else {
1166                         $out .= '>';
1167                         $out .= htmlspecialchars( $contents );
1168                         $out .= "</$element>";
1169                 }
1170         }
1171         return $out;
1172 }
1173
1174 ?>