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