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-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->getId() == 0)
 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     }
 394         else {
 395                 if( $forContent ) {
 396                         $lang = &$wgContLang;
 397                 } else {
 398                         $lang = &$wgLang;
 399                 }
 400
 401                 wfSuppressWarnings();
 402                 $message = $lang->getMessage( $key );
 403                 wfRestoreWarnings();
 404                 if(!$message)
 405                         $message = Language::getMessage($key);
 406                 if(strstr($message, '{{' ) !== false) {
 407                         $message = $wgParser->transformMsg($message, $wgMsgParserOptions);
 408                 }
 409         }
 410
 411         # Replace arguments
 412         if( count( $args ) ) {
 413                 $message = str_replace( $replacementKeys, $args, $message );
 414         }
 415         wfProfileOut( $fname );
 416         return $message;
 417 }
 418
 419
 420
 421 /**
 422  * Just like exit() but makes a note of it.
 423  * Commits open transactions except if the error parameter is set
 424  */
 425 function wfAbruptExit( $error = false ){
 426         global $wgLoadBalancer;
 427         static $called = false;
 428         if ( $called ){
 429                 exit();
 430         }
 431         $called = true;
 432
 433         if( function_exists( 'debug_backtrace' ) ){ // PHP >= 4.3
 434                 $bt = debug_backtrace();
 435                 for($i = 0; $i < count($bt) ; $i++){
 436                         $file = $bt[$i]['file'];
 437                         $line = $bt[$i]['line'];
 438                         wfDebug("WARNING: Abrupt exit in $file at line $line\n");
 439                 }
 440         } else {
 441                 wfDebug('WARNING: Abrupt exit\n');
 442         }
 443         if ( !$error ) {
 444                 $wgLoadBalancer->closeAll();
 445         }
 446         exit();
 447 }
 448
 449 /**
 450  * @todo document
 451  */
 452 function wfErrorExit() {
 453         wfAbruptExit( true );
 454 }
 455
 456 /**
 457  * Die with a backtrace
 458  * This is meant as a debugging aid to track down where bad data comes from.
 459  * Shouldn't be used in production code except maybe in "shouldn't happen" areas.
 460  *
 461  * @param string $msg Message shown when dieing.
 462  */
 463 function wfDebugDieBacktrace( $msg = '' ) {
 464         global $wgCommandLineMode;
 465
 466         if ( function_exists( 'debug_backtrace' ) ) {
 467                 if ( $wgCommandLineMode ) {
 468                         $msg .= "\nBacktrace:\n";
 469                 } else {
 470                         $msg .= "\n<p>Backtrace:</p>\n<ul>\n";
 471                 }
 472                 $backtrace = debug_backtrace();
 473                 foreach( $backtrace as $call ) {
 474                         $f = explode( DIRECTORY_SEPARATOR, $call['file'] );
 475                         $file = $f[count($f)-1];
 476                         if ( $wgCommandLineMode ) {
 477                                 $msg .= "$file line {$call['line']} calls ";
 478                         } else {
 479                                 $msg .= '<li>' . $file . ' line ' . $call['line'] . ' calls ';
 480                         }
 481                         if( !empty( $call['class'] ) ) $msg .= $call['class'] . '::';
 482                         $msg .= $call['function'] . '()';
 483
 484                         if ( $wgCommandLineMode ) {
 485                                 $msg .= "\n";
 486                         } else {
 487                                 $msg .= "</li>\n";
 488                         }
 489                 }
 490          }
 491          die( $msg );
 492 }
 493
 494
 495 /* Some generic result counters, pulled out of SearchEngine */
 496
 497
 498 /**
 499  * @todo document
 500  */
 501 function wfShowingResults( $offset, $limit ) {
 502         global $wgLang;
 503         return wfMsg( 'showingresults', $wgLang->formatNum( $limit ), $wgLang->formatNum( $offset+1 ) );
 504 }
 505
 506 /**
 507  * @todo document
 508  */
 509 function wfShowingResultsNum( $offset, $limit, $num ) {
 510         global $wgLang;
 511         return wfMsg( 'showingresultsnum', $wgLang->formatNum( $limit ), $wgLang->formatNum( $offset+1 ), $wgLang->formatNum( $num ) );
 512 }
 513
 514 /**
 515  * @todo document
 516  */
 517 function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) {
 518         global $wgUser, $wgLang;
 519         $fmtLimit = $wgLang->formatNum( $limit );
 520         $prev = wfMsg( 'prevn', $fmtLimit );
 521         $next = wfMsg( 'nextn', $fmtLimit );
 522
 523         if( is_object( $link ) ) {
 524                 $title =& $link;
 525         } else {
 526                 $title =& Title::newFromText( $link );
 527                 if( is_null( $title ) ) {
 528                         return false;
 529                 }
 530         }
 531
 532         $sk = $wgUser->getSkin();
 533         if ( 0 != $offset ) {
 534                 $po = $offset - $limit;
 535                 if ( $po < 0 ) { $po = 0; }
 536                 $q = "limit={$limit}&offset={$po}";
 537                 if ( '' != $query ) { $q .= '&'.$query; }
 538                 $plink = '<a href="' . $title->escapeLocalUrl( $q ) . "\">{$prev}</a>";
 539         } else { $plink = $prev; }
 540
 541         $no = $offset + $limit;
 542         $q = 'limit='.$limit.'&offset='.$no;
 543         if ( '' != $query ) { $q .= '&'.$query; }
 544
 545         if ( $atend ) {
 546                 $nlink = $next;
 547         } else {
 548                 $nlink = '<a href="' . $title->escapeLocalUrl( $q ) . "\">{$next}</a>";
 549         }
 550         $nums = wfNumLink( $offset, 20, $title, $query ) . ' | ' .
 551           wfNumLink( $offset, 50, $title, $query ) . ' | ' .
 552           wfNumLink( $offset, 100, $title, $query ) . ' | ' .
 553           wfNumLink( $offset, 250, $title, $query ) . ' | ' .
 554           wfNumLink( $offset, 500, $title, $query );
 555
 556         return wfMsg( 'viewprevnext', $plink, $nlink, $nums );
 557 }
 558
 559 /**
 560  * @todo document
 561  */
 562 function wfNumLink( $offset, $limit, &$title, $query = '' ) {
 563         global $wgUser, $wgLang;
 564         if ( '' == $query ) { $q = ''; }
 565         else { $q = $query.'&'; }
 566         $q .= 'limit='.$limit.'&offset='.$offset;
 567
 568         $fmtLimit = $wgLang->formatNum( $limit );
 569         $s = '<a href="' . $title->escapeLocalUrl( $q ) . "\">{$fmtLimit}</a>";
 570         return $s;
 571 }
 572
 573 /**
 574  * @todo document
 575  * @todo FIXME: we may want to blacklist some broken browsers
 576  *
 577  * @return bool Whereas client accept gzip compression
 578  */
 579 function wfClientAcceptsGzip() {
 580         global $wgUseGzip;
 581         if( $wgUseGzip ) {
 582                 # FIXME: we may want to blacklist some broken browsers
 583                 if( preg_match(
 584                         '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
 585                         $_SERVER['HTTP_ACCEPT_ENCODING'],
 586                         $m ) ) {
 587                         if( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) return false;
 588                         wfDebug( " accepts gzip\n" );
 589                         return true;
 590                 }
 591         }
 592         return false;
 593 }
 594
 595 /**
 596  * Yay, more global functions!
 597  */
 598 function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
 599         global $wgRequest;
 600         return $wgRequest->getLimitOffset( $deflimit, $optionname );
 601 }
 602
 603 /**
 604  * Escapes the given text so that it may be output using addWikiText()
 605  * without any linking, formatting, etc. making its way through. This
 606  * is achieved by substituting certain characters with HTML entities.
 607  * As required by the callers, <nowiki> is not used. It currently does
 608  * not filter out characters which have special meaning only at the
 609  * start of a line, such as "*".
 610  *
 611  * @param string $text Text to be escaped
 612  */
 613 function wfEscapeWikiText( $text ) {
 614         $text = str_replace(
 615                 array( '[',             '|',      "'",     'ISBN '        , '://'         , "\n=", '{{' ),
 616                 array( '&#91;', '&#124;', '&#39;', 'ISBN&#32;', '&#58;//' , "\n&#61;", '&#123;&#123;' ),
 617                 htmlspecialchars($text) );
 618         return $text;
 619 }
 620
 621 /**
 622  * @todo document
 623  */
 624 function wfQuotedPrintable( $string, $charset = '' ) {
 625         # Probably incomplete; see RFC 2045
 626         if( empty( $charset ) ) {
 627                 global $wgInputEncoding;
 628                 $charset = $wgInputEncoding;
 629         }
 630         $charset = strtoupper( $charset );
 631         $charset = str_replace( 'ISO-8859', 'ISO8859', $charset ); // ?
 632
 633         $illegal = '\x00-\x08\x0b\x0c\x0e-\x1f\x7f-\xff=';
 634         $replace = $illegal . '\t ?_';
 635         if( !preg_match( "/[$illegal]/", $string ) ) return $string;
 636         $out = "=?$charset?Q?";
 637         $out .= preg_replace( "/([$replace])/e", 'sprintf("=%02X",ord("$1"))', $string );
 638         $out .= '?=';
 639         return $out;
 640 }
 641
 642 /**
 643  * @todo document
 644  * @return float
 645  */
 646 function wfTime() {
 647         $st = explode( ' ', microtime() );
 648         return (float)$st[0] + (float)$st[1];
 649 }
 650
 651 /**
 652  * Changes the first character to an HTML entity
 653  */
 654 function wfHtmlEscapeFirst( $text ) {
 655         $ord = ord($text);
 656         $newText = substr($text, 1);
 657         return "&#$ord;$newText";
 658 }
 659
 660 /**
 661  * Sets dest to source and returns the original value of dest
 662  * If source is NULL, it just returns the value, it doesn't set the variable
 663  */
 664 function wfSetVar( &$dest, $source ) {
 665         $temp = $dest;
 666         if ( !is_null( $source ) ) {
 667                 $dest = $source;
 668         }
 669         return $temp;
 670 }
 671
 672 /**
 673  * As for wfSetVar except setting a bit
 674  */
 675 function wfSetBit( &$dest, $bit, $state = true ) {
 676         $temp = (bool)($dest & $bit );
 677         if ( !is_null( $state ) ) {
 678                 if ( $state ) {
 679                         $dest |= $bit;
 680                 } else {
 681                         $dest &= ~$bit;
 682                 }
 683         }
 684         return $temp;
 685 }
 686
 687 /**
 688  * This function takes two arrays as input, and returns a CGI-style string, e.g.
 689  * "days=7&limit=100". Options in the first array override options in the second.
 690  * Options set to "" will not be output.
 691  */
 692 function wfArrayToCGI( $array1, $array2 = NULL )
 693 {
 694         if ( !is_null( $array2 ) ) {
 695                 $array1 = $array1 + $array2;
 696         }
 697
 698         $cgi = '';
 699         foreach ( $array1 as $key => $value ) {
 700                 if ( '' !== $value ) {
 701                         if ( '' != $cgi ) {
 702                                 $cgi .= '&';
 703                         }
 704                         $cgi .= urlencode( $key ) . '=' . urlencode( $value );
 705                 }
 706         }
 707         return $cgi;
 708 }
 709
 710 /**
 711  * This is obsolete, use SquidUpdate::purge()
 712  * @deprecated
 713  */
 714 function wfPurgeSquidServers ($urlArr) {
 715         SquidUpdate::purge( $urlArr );
 716 }
 717
 718 /**
 719  * Windows-compatible version of escapeshellarg()
 720  * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
 721  * function puts single quotes in regardless of OS
 722  */
 723 function wfEscapeShellArg( ) {
 724         $args = func_get_args();
 725         $first = true;
 726         $retVal = '';
 727         foreach ( $args as $arg ) {
 728                 if ( !$first ) {
 729                         $retVal .= ' ';
 730                 } else {
 731                         $first = false;
 732                 }
 733
 734                 if ( wfIsWindows() ) {
 735                         $retVal .= '"' . str_replace( '"','\"', $arg ) . '"';
 736                 } else {
 737                         $retVal .= escapeshellarg( $arg );
 738                 }
 739         }
 740         return $retVal;
 741 }
 742
 743 /**
 744  * wfMerge attempts to merge differences between three texts.
 745  * Returns true for a clean merge and false for failure or a conflict.
 746  */
 747 function wfMerge( $old, $mine, $yours, &$result ){
 748         global $wgDiff3;
 749
 750         # This check may also protect against code injection in
 751         # case of broken installations.
 752         if(! file_exists( $wgDiff3 ) ){
 753                 return false;
 754         }
 755
 756         # Make temporary files
 757         $td = '/tmp/';
 758         $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
 759         $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
 760         $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
 761
 762         fwrite( $oldtextFile, $old ); fclose( $oldtextFile );
 763         fwrite( $mytextFile, $mine ); fclose( $mytextFile );
 764         fwrite( $yourtextFile, $yours ); fclose( $yourtextFile );
 765
 766         # Check for a conflict
 767         $cmd = wfEscapeShellArg( $wgDiff3 ) . ' -a --overlap-only ' .
 768           wfEscapeShellArg( $mytextName ) . ' ' .
 769           wfEscapeShellArg( $oldtextName ) . ' ' .
 770           wfEscapeShellArg( $yourtextName );
 771         $handle = popen( $cmd, 'r' );
 772
 773         if( fgets( $handle ) ){
 774                 $conflict = true;
 775         } else {
 776                 $conflict = false;
 777         }
 778         pclose( $handle );
 779
 780         # Merge differences
 781         $cmd = wfEscapeShellArg( $wgDiff3 ) . ' -a -e --merge ' .
 782           wfEscapeShellArg( $mytextName, $oldtextName, $yourtextName );
 783         $handle = popen( $cmd, 'r' );
 784         $result = '';
 785         do {
 786                 $data = fread( $handle, 8192 );
 787                 if ( strlen( $data ) == 0 ) {
 788                         break;
 789                 }
 790                 $result .= $data;
 791         } while ( true );
 792         pclose( $handle );
 793         unlink( $mytextName ); unlink( $oldtextName ); unlink( $yourtextName );
 794         return ! $conflict;
 795 }
 796
 797 /**
 798  * @todo document
 799  */
 800 function wfVarDump( $var ) {
 801         global $wgOut;
 802         $s = str_replace("\n","<br>\n", var_export( $var, true ) . "\n");
 803         if ( headers_sent() || !@is_object( $wgOut ) ) {
 804                 print $s;
 805         } else {
 806                 $wgOut->addHTML( $s );
 807         }
 808 }
 809
 810 /**
 811  * Provide a simple HTTP error.
 812  */
 813 function wfHttpError( $code, $label, $desc ) {
 814         global $wgOut;
 815         $wgOut->disable();
 816         header( "HTTP/1.0 $code $label" );
 817         header( "Status: $code $label" );
 818         $wgOut->sendCacheControl();
 819
 820         # Don't send content if it's a HEAD request.
 821         if( $_SERVER['REQUEST_METHOD'] == 'HEAD' ) {
 822                 header( 'Content-type: text/plain' );
 823                 print "$desc\n";
 824         }
 825 }
 826
 827 /**
 828  * Converts an Accept-* header into an array mapping string values to quality
 829  * factors
 830  */
 831 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
 832         # No arg means accept anything (per HTTP spec)
 833         if( !$accept ) {
 834                 return array( $def => 1 );
 835         }
 836
 837         $prefs = array();
 838
 839         $parts = explode( ',', $accept );
 840
 841         foreach( $parts as $part ) {
 842                 # FIXME: doesn't deal with params like 'text/html; level=1'
 843                 @list( $value, $qpart ) = explode( ';', $part );
 844                 if( !isset( $qpart ) ) {
 845                         $prefs[$value] = 1;
 846                 } elseif( preg_match( '/q\s*=\s*(\d*\.\d+)/', $qpart, $match ) ) {
 847                         $prefs[$value] = $match[1];
 848                 }
 849         }
 850
 851         return $prefs;
 852 }
 853
 854 /**
 855  * Checks if a given MIME type matches any of the keys in the given
 856  * array. Basic wildcards are accepted in the array keys.
 857  *
 858  * Returns the matching MIME type (or wildcard) if a match, otherwise
 859  * NULL if no match.
 860  *
 861  * @param string $type
 862  * @param array $avail
 863  * @return string
 864  * @access private
 865  */
 866 function mimeTypeMatch( $type, $avail ) {
 867         if( array_key_exists($type, $avail) ) {
 868                 return $type;
 869         } else {
 870                 $parts = explode( '/', $type );
 871                 if( array_key_exists( $parts[0] . '/*', $avail ) ) {
 872                         return $parts[0] . '/*';
 873                 } elseif( array_key_exists( '*/*', $avail ) ) {
 874                         return '*/*';
 875                 } else {
 876                         return NULL;
 877                 }
 878         }
 879 }
 880
 881 /**
 882  * Returns the 'best' match between a client's requested internet media types
 883  * and the server's list of available types. Each list should be an associative
 884  * array of type to preference (preference is a float between 0.0 and 1.0).
 885  * Wildcards in the types are acceptable.
 886  *
 887  * @param array $cprefs Client's acceptable type list
 888  * @param array $sprefs Server's offered types
 889  * @return string
 890  *
 891  * @todo FIXME: doesn't handle params like 'text/plain; charset=UTF-8'
 892  * XXX: generalize to negotiate other stuff
 893  */
 894 function wfNegotiateType( $cprefs, $sprefs ) {
 895         $combine = array();
 896
 897         foreach( array_keys($sprefs) as $type ) {
 898                 $parts = explode( '/', $type );
 899                 if( $parts[1] != '*' ) {
 900                         $ckey = mimeTypeMatch( $type, $cprefs );
 901                         if( $ckey ) {
 902                                 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
 903                         }
 904                 }
 905         }
 906
 907         foreach( array_keys( $cprefs ) as $type ) {
 908                 $parts = explode( '/', $type );
 909                 if( $parts[1] != '*' && !array_key_exists( $type, $sprefs ) ) {
 910                         $skey = mimeTypeMatch( $type, $sprefs );
 911                         if( $skey ) {
 912                                 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
 913                         }
 914                 }
 915         }
 916
 917         $bestq = 0;
 918         $besttype = NULL;
 919
 920         foreach( array_keys( $combine ) as $type ) {
 921                 if( $combine[$type] > $bestq ) {
 922                         $besttype = $type;
 923                         $bestq = $combine[$type];
 924                 }
 925         }
 926
 927         return $besttype;
 928 }
 929
 930 /**
 931  * Array lookup
 932  * Returns an array where the values in the first array are replaced by the
 933  * values in the second array with the corresponding keys
 934  *
 935  * @return array
 936  */
 937 function wfArrayLookup( $a, $b ) {
 938         return array_flip( array_intersect( array_flip( $a ), array_keys( $b ) ) );
 939 }
 940
 941 /**
 942  * Convenience function; returns MediaWiki timestamp for the present time.
 943  * @return string
 944  */
 945 function wfTimestampNow() {
 946         # return NOW
 947         return wfTimestamp( TS_MW, time() );
 948 }
 949
 950 /**
 951  * Sorting hack for MySQL 3, which doesn't use index sorts for DESC
 952  */
 953 function wfInvertTimestamp( $ts ) {
 954         return strtr(
 955                 $ts,
 956                 '0123456789',
 957                 '9876543210'
 958         );
 959 }
 960
 961 /**
 962  * Reference-counted warning suppression
 963  */
 964 function wfSuppressWarnings( $end = false ) {
 965         static $suppressCount = 0;
 966         static $originalLevel = false;
 967
 968         if ( $end ) {
 969                 if ( $suppressCount ) {
 970                         $suppressCount --;
 971                         if ( !$suppressCount ) {
 972                                 error_reporting( $originalLevel );
 973                         }
 974                 }
 975         } else {
 976                 if ( !$suppressCount ) {
 977                         $originalLevel = error_reporting( E_ALL & ~( E_WARNING | E_NOTICE ) );
 978                 }
 979                 $suppressCount++;
 980         }
 981 }
 982
 983 /**
 984  * Restore error level to previous value
 985  */
 986 function wfRestoreWarnings() {
 987         wfSuppressWarnings( true );
 988 }
 989
 990 # Autodetect, convert and provide timestamps of various types
 991
 992 /** Standard unix timestamp (number of seconds since 1 Jan 1970) */
 993 define('TS_UNIX',0);
 994 /** MediaWiki concatenated string timestamp (yyyymmddhhmmss) */
 995 define('TS_MW',1);
 996 /** Standard database timestamp (yyyy-mm-dd hh:mm:ss) */
 997 define('TS_DB',2);
 998
 999 /**
1000  * @todo document
1001  */
1002 function wfTimestamp($outputtype=TS_UNIX,$ts=0) {
1003         if (preg_match("/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)$/",$ts,$da)) {
1004                 # TS_DB
1005                 $uts=gmmktime((int)$da[4],(int)$da[5],(int)$da[6],
1006                             (int)$da[2],(int)$da[3],(int)$da[1]);
1007         } elseif (preg_match("/^(\d{4})(\d\d)(\d\d)(\d\d)(\d\d)(\d\d)$/",$ts,$da)) {
1008                 # TS_MW
1009                 $uts=gmmktime((int)$da[4],(int)$da[5],(int)$da[6],
1010                             (int)$da[2],(int)$da[3],(int)$da[1]);
1011         } elseif (preg_match("/^(\d{1,13})$/",$ts,$datearray)) {
1012                 # TS_UNIX
1013                 $uts=$ts;
1014         }
1015
1016         if ($ts==0)
1017                 $uts=time();
1018         switch($outputtype) {
1019         case TS_UNIX:
1020                 return $uts;
1021                 break;
1022         case TS_MW:
1023                 return gmdate( 'YmdHis', $uts );
1024                 break;
1025         case TS_DB:
1026                 return gmdate( 'Y-m-d H:i:s', $uts );
1027                 break;
1028         default:
1029                 return;
1030         }
1031 }
1032
1033 /**
1034  * Check where as the operating system is Windows
1035  *
1036  * @todo document
1037  * @return bool True if it's windows, False otherwise.
1038  */
1039 function wfIsWindows() {
1040         if (substr(php_uname(), 0, 7) == 'Windows') {
1041                 return true;
1042         } else {
1043                 return false;
1044         }
1045 }
1046
1047 ?>