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 require_once( 'XmlFunctions.php' );
  34
  35 /**
  36  * Compatibility functions
  37  * PHP <4.3.x is not actively supported; 4.1.x and 4.2.x might or might not work.
  38  * <4.1.x will not work, as we use a number of features introduced in 4.1.0
  39  * such as the new autoglobals.
  40  */
  41 if( !function_exists('iconv') ) {
  42         # iconv support is not in the default configuration and so may not be present.
  43         # Assume will only ever use utf-8 and iso-8859-1.
  44         # This will *not* work in all circumstances.
  45         function iconv( $from, $to, $string ) {
  46                 if(strcasecmp( $from, $to ) == 0) return $string;
  47                 if(strcasecmp( $from, 'utf-8' ) == 0) return utf8_decode( $string );
  48                 if(strcasecmp( $to, 'utf-8' ) == 0) return utf8_encode( $string );
  49                 return $string;
  50         }
  51 }
  52
  53 if( !function_exists('file_get_contents') ) {
  54         # Exists in PHP 4.3.0+
  55         function file_get_contents( $filename ) {
  56                 return implode( '', file( $filename ) );
  57         }
  58 }
  59
  60 if( !function_exists('is_a') ) {
  61         # Exists in PHP 4.2.0+
  62         function is_a( $object, $class_name ) {
  63                 return
  64                         (strcasecmp( get_class( $object ), $class_name ) == 0) ||
  65                          is_subclass_of( $object, $class_name );
  66         }
  67 }
  68
  69 # UTF-8 substr function based on a PHP manual comment
  70 if ( !function_exists( 'mb_substr' ) ) {
  71         function mb_substr( $str, $start ) {
  72                 preg_match_all( '/./us', $str, $ar );
  73
  74                 if( func_num_args() >= 3 ) {
  75                         $end = func_get_arg( 2 );
  76                         return join( '', array_slice( $ar[0], $start, $end ) );
  77                 } else {
  78                         return join( '', array_slice( $ar[0], $start ) );
  79                 }
  80         }
  81 }
  82
  83 if( !function_exists( 'floatval' ) ) {
  84         /**
  85          * First defined in PHP 4.2.0
  86          * @param mixed $var;
  87          * @return float
  88          */
  89         function floatval( $var ) {
  90                 return (float)$var;
  91         }
  92 }
  93
  94 if ( !function_exists( 'array_diff_key' ) ) {
  95         /**
  96          * Exists in PHP 5.1.0+
  97          * Not quite compatible, two-argument version only
  98          * Null values will cause problems due to this use of isset()
  99          */
 100         function array_diff_key( $left, $right ) {
 101                 $result = $left;
 102                 foreach ( $left as $key => $value ) {
 103                         if ( isset( $right[$key] ) ) {
 104                                 unset( $result[$key] );
 105                         }
 106                 }
 107                 return $result;
 108         }
 109 }
 110
 111
 112 /**
 113  * Wrapper for clone() for PHP 4, for the moment.
 114  * PHP 5 won't let you declare a 'clone' function, even conditionally,
 115  * so it has to be a wrapper with a different name.
 116  */
 117 function wfClone( $object ) {
 118         // WARNING: clone() is not a function in PHP 5, so function_exists fails.
 119         if( version_compare( PHP_VERSION, '5.0' ) < 0 ) {
 120                 return $object;
 121         } else {
 122                 return clone( $object );
 123         }
 124 }
 125
 126 /**
 127  * Where as we got a random seed
 128  * @var bool $wgTotalViews
 129  */
 130 $wgRandomSeeded = false;
 131
 132 /**
 133  * Seed Mersenne Twister
 134  * Only necessary in PHP < 4.2.0
 135  *
 136  * @return bool
 137  */
 138 function wfSeedRandom() {
 139         global $wgRandomSeeded;
 140
 141         if ( ! $wgRandomSeeded && version_compare( phpversion(), '4.2.0' ) < 0 ) {
 142                 $seed = hexdec(substr(md5(microtime()),-8)) & 0x7fffffff;
 143                 mt_srand( $seed );
 144                 $wgRandomSeeded = true;
 145         }
 146 }
 147
 148 /**
 149  * Get a random decimal value between 0 and 1, in a way
 150  * not likely to give duplicate values for any realistic
 151  * number of articles.
 152  *
 153  * @return string
 154  */
 155 function wfRandom() {
 156         # The maximum random value is "only" 2^31-1, so get two random
 157         # values to reduce the chance of dupes
 158         $max = mt_getrandmax();
 159         $rand = number_format( (mt_rand() * $max + mt_rand())
 160                 / $max / $max, 12, '.', '' );
 161         return $rand;
 162 }
 163
 164 /**
 165  * We want / and : to be included as literal characters in our title URLs.
 166  * %2F in the page titles seems to fatally break for some reason.
 167  *
 168  * @param $s String:
 169  * @return string
 170 */
 171 function wfUrlencode ( $s ) {
 172         $s = urlencode( $s );
 173         $s = preg_replace( '/%3[Aa]/', ':', $s );
 174         $s = preg_replace( '/%2[Ff]/', '/', $s );
 175
 176         return $s;
 177 }
 178
 179 /**
 180  * Sends a line to the debug log if enabled or, optionally, to a comment in output.
 181  * In normal operation this is a NOP.
 182  *
 183  * Controlling globals:
 184  * $wgDebugLogFile - points to the log file
 185  * $wgProfileOnly - if set, normal debug messages will not be recorded.
 186  * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
 187  * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
 188  *
 189  * @param $text String
 190  * @param $logonly Bool: set true to avoid appearing in HTML when $wgDebugComments is set
 191  */
 192 function wfDebug( $text, $logonly = false ) {
 193         global $wgOut, $wgDebugLogFile, $wgDebugComments, $wgProfileOnly, $wgDebugRawPage;
 194
 195         # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
 196         if ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' && !$wgDebugRawPage ) {
 197                 return;
 198         }
 199
 200         if ( isset( $wgOut ) && $wgDebugComments && !$logonly ) {
 201                 $wgOut->debug( $text );
 202         }
 203         if ( '' != $wgDebugLogFile && !$wgProfileOnly ) {
 204                 # Strip unprintables; they can switch terminal modes when binary data
 205                 # gets dumped, which is pretty annoying.
 206                 $text = preg_replace( '![\x00-\x08\x0b\x0c\x0e-\x1f]!', ' ', $text );
 207                 @error_log( $text, 3, $wgDebugLogFile );
 208         }
 209 }
 210
 211 /**
 212  * Send a line to a supplementary debug log file, if configured, or main debug log if not.
 213  * $wgDebugLogGroups[$logGroup] should be set to a filename to send to a separate log.
 214  *
 215  * @param $logGroup String
 216  * @param $text String
 217  * @param $public Bool: whether to log the event in the public log if no private
 218  *                     log file is specified, (default true)
 219  */
 220 function wfDebugLog( $logGroup, $text, $public = true ) {
 221         global $wgDebugLogGroups, $wgDBname;
 222         if( $text{strlen( $text ) - 1} != "\n" ) $text .= "\n";
 223         if( isset( $wgDebugLogGroups[$logGroup] ) ) {
 224                 $time = wfTimestamp( TS_DB );
 225                 @error_log( "$time $wgDBname: $text", 3, $wgDebugLogGroups[$logGroup] );
 226         } else if ( $public === true ) {
 227                 wfDebug( $text, true );
 228         }
 229 }
 230
 231 /**
 232  * Log for database errors
 233  * @param $text String: database error message.
 234  */
 235 function wfLogDBError( $text ) {
 236         global $wgDBerrorLog;
 237         if ( $wgDBerrorLog ) {
 238                 $host = trim(`hostname`);
 239                 $text = date('D M j G:i:s T Y') . "\t$host\t".$text;
 240                 error_log( $text, 3, $wgDBerrorLog );
 241         }
 242 }
 243
 244 /**
 245  * @todo document
 246  */
 247 function logProfilingData() {
 248         global $wgRequestTime, $wgDebugLogFile, $wgDebugRawPage, $wgRequest;
 249         global $wgProfiling, $wgUser;
 250         $now = wfTime();
 251
 252         list( $usec, $sec ) = explode( ' ', $wgRequestTime );
 253         $start = (float)$sec + (float)$usec;
 254         $elapsed = $now - $start;
 255         if ( $wgProfiling ) {
 256                 $prof = wfGetProfilingOutput( $start, $elapsed );
 257                 $forward = '';
 258                 if( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) )
 259                         $forward = ' forwarded for ' . $_SERVER['HTTP_X_FORWARDED_FOR'];
 260                 if( !empty( $_SERVER['HTTP_CLIENT_IP'] ) )
 261                         $forward .= ' client IP ' . $_SERVER['HTTP_CLIENT_IP'];
 262                 if( !empty( $_SERVER['HTTP_FROM'] ) )
 263                         $forward .= ' from ' . $_SERVER['HTTP_FROM'];
 264                 if( $forward )
 265                         $forward = "\t(proxied via {$_SERVER['REMOTE_ADDR']}{$forward})";
 266                 if( is_object($wgUser) && $wgUser->isAnon() )
 267                         $forward .= ' anon';
 268                 $log = sprintf( "%s\t%04.3f\t%s\n",
 269                   gmdate( 'YmdHis' ), $elapsed,
 270                   urldecode( $_SERVER['REQUEST_URI'] . $forward ) );
 271                 if ( '' != $wgDebugLogFile && ( $wgRequest->getVal('action') != 'raw' || $wgDebugRawPage ) ) {
 272                         error_log( $log . $prof, 3, $wgDebugLogFile );
 273                 }
 274         }
 275 }
 276
 277 /**
 278  * Check if the wiki read-only lock file is present. This can be used to lock
 279  * off editing functions, but doesn't guarantee that the database will not be
 280  * modified.
 281  * @return bool
 282  */
 283 function wfReadOnly() {
 284         global $wgReadOnlyFile, $wgReadOnly;
 285
 286         if ( !is_null( $wgReadOnly ) ) {
 287                 return (bool)$wgReadOnly;
 288         }
 289         if ( '' == $wgReadOnlyFile ) {
 290                 return false;
 291         }
 292         // Set $wgReadOnly for faster access next time
 293         if ( is_file( $wgReadOnlyFile ) ) {
 294                 $wgReadOnly = file_get_contents( $wgReadOnlyFile );
 295         } else {
 296                 $wgReadOnly = false;
 297         }
 298         return (bool)$wgReadOnly;
 299 }
 300
 301
 302 /**
 303  * Get a message from anywhere, for the current user language.
 304  *
 305  * Use wfMsgForContent() instead if the message should NOT
 306  * change depending on the user preferences.
 307  *
 308  * Note that the message may contain HTML, and is therefore
 309  * not safe for insertion anywhere. Some functions such as
 310  * addWikiText will do the escaping for you. Use wfMsgHtml()
 311  * if you need an escaped message.
 312  *
 313  * @param $key String: lookup key for the message, usually
 314  *    defined in languages/Language.php
 315  */
 316 function wfMsg( $key ) {
 317         $args = func_get_args();
 318         array_shift( $args );
 319         return wfMsgReal( $key, $args, true );
 320 }
 321
 322 /**
 323  * Same as above except doesn't transform the message
 324  */
 325 function wfMsgNoTrans( $key ) {
 326         $args = func_get_args();
 327         array_shift( $args );
 328         return wfMsgReal( $key, $args, true, false );
 329 }
 330
 331 /**
 332  * Get a message from anywhere, for the current global language
 333  * set with $wgLanguageCode.
 334  *
 335  * Use this if the message should NOT change  dependent on the
 336  * language set in the user's preferences. This is the case for
 337  * most text written into logs, as well as link targets (such as
 338  * the name of the copyright policy page). Link titles, on the
 339  * other hand, should be shown in the UI language.
 340  *
 341  * Note that MediaWiki allows users to change the user interface
 342  * language in their preferences, but a single installation
 343  * typically only contains content in one language.
 344  *
 345  * Be wary of this distinction: If you use wfMsg() where you should
 346  * use wfMsgForContent(), a user of the software may have to
 347  * customize over 70 messages in order to, e.g., fix a link in every
 348  * possible language.
 349  *
 350  * @param $key String: lookup key for the message, usually
 351  *    defined in languages/Language.php
 352  */
 353 function wfMsgForContent( $key ) {
 354         global $wgForceUIMsgAsContentMsg;
 355         $args = func_get_args();
 356         array_shift( $args );
 357         $forcontent = true;
 358         if( is_array( $wgForceUIMsgAsContentMsg ) &&
 359                 in_array( $key, $wgForceUIMsgAsContentMsg ) )
 360                 $forcontent = false;
 361         return wfMsgReal( $key, $args, true, $forcontent );
 362 }
 363
 364 /**
 365  * Same as above except doesn't transform the message
 366  */
 367 function wfMsgForContentNoTrans( $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, true, $forcontent, false );
 376 }
 377
 378 /**
 379  * Get a message from the language file, for the UI elements
 380  */
 381 function wfMsgNoDB( $key ) {
 382         $args = func_get_args();
 383         array_shift( $args );
 384         return wfMsgReal( $key, $args, false );
 385 }
 386
 387 /**
 388  * Get a message from the language file, for the content
 389  */
 390 function wfMsgNoDBForContent( $key ) {
 391         global $wgForceUIMsgAsContentMsg;
 392         $args = func_get_args();
 393         array_shift( $args );
 394         $forcontent = true;
 395         if( is_array( $wgForceUIMsgAsContentMsg ) &&
 396                 in_array( $key, $wgForceUIMsgAsContentMsg ) )
 397                 $forcontent = false;
 398         return wfMsgReal( $key, $args, false, $forcontent );
 399 }
 400
 401
 402 /**
 403  * Really get a message
 404  * @return $key String: key to get.
 405  * @return $args
 406  * @return $useDB Boolean
 407  * @return String: the requested message.
 408  */
 409 function wfMsgReal( $key, $args, $useDB, $forContent=false, $transform = true ) {
 410         $fname = 'wfMsgReal';
 411
 412         $message = wfMsgGetKey( $key, $useDB, $forContent, $transform );
 413         $message = wfMsgReplaceArgs( $message, $args );
 414         return $message;
 415 }
 416
 417 /**
 418  * This function provides the message source for messages to be edited which are *not* stored in the database.
 419  * @param $key String:
 420  */
 421 function wfMsgWeirdKey ( $key ) {
 422         $subsource = str_replace ( ' ' , '_' , $key ) ;
 423         $source = wfMsg ( $subsource ) ;
 424         if ( $source == "&lt;{$subsource}&gt;" ) {
 425                 # Try again with first char lower case
 426                 $subsource = strtolower ( substr ( $subsource , 0 , 1 ) ) . substr ( $subsource , 1 ) ;
 427                 $source = wfMsg ( $subsource ) ;
 428         }
 429         if ( $source == "&lt;{$subsource}&gt;" ) {
 430                 # Didn't work either, return blank text
 431                 $source = "" ;
 432         }
 433         return $source ;
 434 }
 435
 436 /**
 437  * Fetch a message string value, but don't replace any keys yet.
 438  * @param string $key
 439  * @param bool $useDB
 440  * @param bool $forContent
 441  * @return string
 442  * @private
 443  */
 444 function wfMsgGetKey( $key, $useDB, $forContent = false, $transform = true ) {
 445         global $wgParser, $wgMsgParserOptions, $wgContLang, $wgMessageCache, $wgLang;
 446
 447         if ( is_object( $wgMessageCache ) )
 448                 $transstat = $wgMessageCache->getTransform();
 449
 450         if( is_object( $wgMessageCache ) ) {
 451                 if ( ! $transform )
 452                         $wgMessageCache->disableTransform();
 453                 $message = $wgMessageCache->get( $key, $useDB, $forContent );
 454         } else {
 455                 if( $forContent ) {
 456                         $lang = &$wgContLang;
 457                 } else {
 458                         $lang = &$wgLang;
 459                 }
 460
 461                 wfSuppressWarnings();
 462
 463                 if( is_object( $lang ) ) {
 464                         $message = $lang->getMessage( $key );
 465                 } else {
 466                         $message = false;
 467                 }
 468                 wfRestoreWarnings();
 469                 if($message === false)
 470                         $message = Language::getMessage($key);
 471                 if ( $transform && strstr( $message, '{{' ) !== false ) {
 472                         $message = $wgParser->transformMsg($message, $wgMsgParserOptions);
 473                 }
 474         }
 475
 476         if ( is_object( $wgMessageCache ) && ! $transform )
 477                 $wgMessageCache->setTransform( $transstat );
 478
 479         return $message;
 480 }
 481
 482 /**
 483  * Replace message parameter keys on the given formatted output.
 484  *
 485  * @param string $message
 486  * @param array $args
 487  * @return string
 488  * @private
 489  */
 490 function wfMsgReplaceArgs( $message, $args ) {
 491         # Fix windows line-endings
 492         # Some messages are split with explode("\n", $msg)
 493         $message = str_replace( "\r", '', $message );
 494
 495         // Replace arguments
 496         if ( count( $args ) ) {
 497                 if ( is_array( $args[0] ) ) {
 498                         foreach ( $args[0] as $key => $val ) {
 499                                 $message = str_replace( '$' . $key, $val, $message );
 500                         }
 501                 } else {
 502                         foreach( $args as $n => $param ) {
 503                                 $replacementKeys['$' . ($n + 1)] = $param;
 504                         }
 505                         $message = strtr( $message, $replacementKeys );
 506                 }
 507         }
 508
 509         return $message;
 510 }
 511
 512 /**
 513  * Return an HTML-escaped version of a message.
 514  * Parameter replacements, if any, are done *after* the HTML-escaping,
 515  * so parameters may contain HTML (eg links or form controls). Be sure
 516  * to pre-escape them if you really do want plaintext, or just wrap
 517  * the whole thing in htmlspecialchars().
 518  *
 519  * @param string $key
 520  * @param string ... parameters
 521  * @return string
 522  */
 523 function wfMsgHtml( $key ) {
 524         $args = func_get_args();
 525         array_shift( $args );
 526         return wfMsgReplaceArgs( htmlspecialchars( wfMsgGetKey( $key, true ) ), $args );
 527 }
 528
 529 /**
 530  * Return an HTML version of message
 531  * Parameter replacements, if any, are done *after* parsing the wiki-text message,
 532  * so parameters may contain HTML (eg links or form controls). Be sure
 533  * to pre-escape them if you really do want plaintext, or just wrap
 534  * the whole thing in htmlspecialchars().
 535  *
 536  * @param string $key
 537  * @param string ... parameters
 538  * @return string
 539  */
 540 function wfMsgWikiHtml( $key ) {
 541         global $wgOut;
 542         $args = func_get_args();
 543         array_shift( $args );
 544         return wfMsgReplaceArgs( $wgOut->parse( wfMsgGetKey( $key, true ), /* can't be set to false */ true ), $args );
 545 }
 546
 547 /**
 548  * Returns message in the requested format
 549  * @param string $key Key of the message
 550  * @param array $options Processing rules:
 551  *  <i>parse<i>: parses wikitext to html
 552  *  <i>parseinline<i>: parses wikitext to html and removes the surrounding p's added by parser or tidy
 553  *  <i>escape<i>: filters message trough htmlspecialchars
 554  *  <i>replaceafter<i>: parameters are substituted after parsing or escaping
 555  */
 556 function wfMsgExt( $key, $options ) {
 557         global $wgOut;
 558
 559         $args = func_get_args();
 560         array_shift( $args );
 561         array_shift( $args );
 562
 563         if( !is_array($options) ) {
 564                 $options = array($options);
 565         }
 566
 567         $string = wfMsgGetKey( $key, true, false, false );
 568
 569         if( !in_array('replaceafter', $options) ) {
 570                 $string = wfMsgReplaceArgs( $string, $args );
 571         }
 572
 573         if( in_array('parse', $options) ) {
 574                 $string = $wgOut->parse( $string, true, true );
 575         } elseif ( in_array('parseinline', $options) ) {
 576                 $string = $wgOut->parse( $string, true, true );
 577                 $m = array();
 578                 if( preg_match( "~^<p>(.*)\n?</p>$~", $string, $m ) ) {
 579                         $string = $m[1];
 580                 }
 581         } elseif ( in_array('escape', $options) ) {
 582                 $string = htmlspecialchars ( $string );
 583         }
 584
 585         if( in_array('replaceafter', $options) ) {
 586                 $string = wfMsgReplaceArgs( $string, $args );
 587         }
 588
 589         return $string;
 590 }
 591
 592
 593 /**
 594  * Just like exit() but makes a note of it.
 595  * Commits open transactions except if the error parameter is set
 596  */
 597 function wfAbruptExit( $error = false ){
 598         global $wgLoadBalancer;
 599         static $called = false;
 600         if ( $called ){
 601                 exit( -1 );
 602         }
 603         $called = true;
 604
 605         if( function_exists( 'debug_backtrace' ) ){ // PHP >= 4.3
 606                 $bt = debug_backtrace();
 607                 for($i = 0; $i < count($bt) ; $i++){
 608                         $file = isset($bt[$i]['file']) ? $bt[$i]['file'] : "unknown";
 609                         $line = isset($bt[$i]['line']) ? $bt[$i]['line'] : "unknown";
 610                         wfDebug("WARNING: Abrupt exit in $file at line $line\n");
 611                 }
 612         } else {
 613                 wfDebug('WARNING: Abrupt exit\n');
 614         }
 615
 616         wfProfileClose();
 617         logProfilingData();
 618
 619         if ( !$error ) {
 620                 $wgLoadBalancer->closeAll();
 621         }
 622         exit( -1 );
 623 }
 624
 625 /**
 626  * @todo document
 627  */
 628 function wfErrorExit() {
 629         wfAbruptExit( true );
 630 }
 631
 632 /**
 633  * Print a simple message and die, returning nonzero to the shell if any.
 634  * Plain die() fails to return nonzero to the shell if you pass a string.
 635  * @param string $msg
 636  */
 637 function wfDie( $msg='' ) {
 638         echo $msg;
 639         die( -1 );
 640 }
 641
 642 /**
 643  * Die with a backtrace
 644  * This is meant as a debugging aid to track down where bad data comes from.
 645  * Shouldn't be used in production code except maybe in "shouldn't happen" areas.
 646  *
 647  * @param string $msg Message shown when dieing.
 648  */
 649 function wfDebugDieBacktrace( $msg = '' ) {
 650         global $wgCommandLineMode;
 651
 652         $backtrace = wfBacktrace();
 653         if ( $backtrace !== false ) {
 654                 if ( $wgCommandLineMode ) {
 655                         $msg .= "\nBacktrace:\n$backtrace";
 656                 } else {
 657                         $msg .= "\n<p>Backtrace:</p>\n$backtrace";
 658                 }
 659         }
 660         echo $msg;
 661         echo wfReportTime()."\n";
 662         die( -1 );
 663 }
 664
 665         /**
 666          * Returns a HTML comment with the elapsed time since request.
 667          * This method has no side effects.
 668          * @return string
 669          */
 670         function wfReportTime() {
 671                 global $wgRequestTime;
 672
 673                 $now = wfTime();
 674                 list( $usec, $sec ) = explode( ' ', $wgRequestTime );
 675                 $start = (float)$sec + (float)$usec;
 676                 $elapsed = $now - $start;
 677
 678                 # Use real server name if available, so we know which machine
 679                 # in a server farm generated the current page.
 680                 if ( function_exists( 'posix_uname' ) ) {
 681                         $uname = @posix_uname();
 682                 } else {
 683                         $uname = false;
 684                 }
 685                 if( is_array( $uname ) && isset( $uname['nodename'] ) ) {
 686                         $hostname = $uname['nodename'];
 687                 } else {
 688                         # This may be a virtual server.
 689                         $hostname = $_SERVER['SERVER_NAME'];
 690                 }
 691                 $com = sprintf( "<!-- Served by %s in %01.3f secs. -->",
 692                   $hostname, $elapsed );
 693                 return $com;
 694         }
 695
 696 function wfBacktrace() {
 697         global $wgCommandLineMode;
 698         if ( !function_exists( 'debug_backtrace' ) ) {
 699                 return false;
 700         }
 701
 702         if ( $wgCommandLineMode ) {
 703                 $msg = '';
 704         } else {
 705                 $msg = "<ul>\n";
 706         }
 707         $backtrace = debug_backtrace();
 708         foreach( $backtrace as $call ) {
 709                 if( isset( $call['file'] ) ) {
 710                         $f = explode( DIRECTORY_SEPARATOR, $call['file'] );
 711                         $file = $f[count($f)-1];
 712                 } else {
 713                         $file = '-';
 714                 }
 715                 if( isset( $call['line'] ) ) {
 716                         $line = $call['line'];
 717                 } else {
 718                         $line = '-';
 719                 }
 720                 if ( $wgCommandLineMode ) {
 721                         $msg .= "$file line $line calls ";
 722                 } else {
 723                         $msg .= '<li>' . $file . ' line ' . $line . ' calls ';
 724                 }
 725                 if( !empty( $call['class'] ) ) $msg .= $call['class'] . '::';
 726                 $msg .= $call['function'] . '()';
 727
 728                 if ( $wgCommandLineMode ) {
 729                         $msg .= "\n";
 730                 } else {
 731                         $msg .= "</li>\n";
 732                 }
 733         }
 734         if ( $wgCommandLineMode ) {
 735                 $msg .= "\n";
 736         } else {
 737                 $msg .= "</ul>\n";
 738         }
 739
 740         return $msg;
 741 }
 742
 743
 744 /* Some generic result counters, pulled out of SearchEngine */
 745
 746
 747 /**
 748  * @todo document
 749  */
 750 function wfShowingResults( $offset, $limit ) {
 751         global $wgLang;
 752         return wfMsg( 'showingresults', $wgLang->formatNum( $limit ), $wgLang->formatNum( $offset+1 ) );
 753 }
 754
 755 /**
 756  * @todo document
 757  */
 758 function wfShowingResultsNum( $offset, $limit, $num ) {
 759         global $wgLang;
 760         return wfMsg( 'showingresultsnum', $wgLang->formatNum( $limit ), $wgLang->formatNum( $offset+1 ), $wgLang->formatNum( $num ) );
 761 }
 762
 763 /**
 764  * @todo document
 765  */
 766 function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) {
 767         global $wgLang;
 768         $fmtLimit = $wgLang->formatNum( $limit );
 769         $prev = wfMsg( 'prevn', $fmtLimit );
 770         $next = wfMsg( 'nextn', $fmtLimit );
 771
 772         if( is_object( $link ) ) {
 773                 $title =& $link;
 774         } else {
 775                 $title = Title::newFromText( $link );
 776                 if( is_null( $title ) ) {
 777                         return false;
 778                 }
 779         }
 780
 781         if ( 0 != $offset ) {
 782                 $po = $offset - $limit;
 783                 if ( $po < 0 ) { $po = 0; }
 784                 $q = "limit={$limit}&offset={$po}";
 785                 if ( '' != $query ) { $q .= '&'.$query; }
 786                 $plink = '<a href="' . $title->escapeLocalUrl( $q ) . "\">{$prev}</a>";
 787         } else { $plink = $prev; }
 788
 789         $no = $offset + $limit;
 790         $q = 'limit='.$limit.'&offset='.$no;
 791         if ( '' != $query ) { $q .= '&'.$query; }
 792
 793         if ( $atend ) {
 794                 $nlink = $next;
 795         } else {
 796                 $nlink = '<a href="' . $title->escapeLocalUrl( $q ) . "\">{$next}</a>";
 797         }
 798         $nums = wfNumLink( $offset, 20, $title, $query ) . ' | ' .
 799           wfNumLink( $offset, 50, $title, $query ) . ' | ' .
 800           wfNumLink( $offset, 100, $title, $query ) . ' | ' .
 801           wfNumLink( $offset, 250, $title, $query ) . ' | ' .
 802           wfNumLink( $offset, 500, $title, $query );
 803
 804         return wfMsg( 'viewprevnext', $plink, $nlink, $nums );
 805 }
 806
 807 /**
 808  * @todo document
 809  */
 810 function wfNumLink( $offset, $limit, &$title, $query = '' ) {
 811         global $wgLang;
 812         if ( '' == $query ) { $q = ''; }
 813         else { $q = $query.'&'; }
 814         $q .= 'limit='.$limit.'&offset='.$offset;
 815
 816         $fmtLimit = $wgLang->formatNum( $limit );
 817         $s = '<a href="' . $title->escapeLocalUrl( $q ) . "\">{$fmtLimit}</a>";
 818         return $s;
 819 }
 820
 821 /**
 822  * @todo document
 823  * @todo FIXME: we may want to blacklist some broken browsers
 824  *
 825  * @return bool Whereas client accept gzip compression
 826  */
 827 function wfClientAcceptsGzip() {
 828         global $wgUseGzip;
 829         if( $wgUseGzip ) {
 830                 # FIXME: we may want to blacklist some broken browsers
 831                 if( preg_match(
 832                         '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
 833                         $_SERVER['HTTP_ACCEPT_ENCODING'],
 834                         $m ) ) {
 835                         if( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) return false;
 836                         wfDebug( " accepts gzip\n" );
 837                         return true;
 838                 }
 839         }
 840         return false;
 841 }
 842
 843 /**
 844  * Obtain the offset and limit values from the request string;
 845  * used in special pages
 846  *
 847  * @param $deflimit Default limit if none supplied
 848  * @param $optionname Name of a user preference to check against
 849  * @return array
 850  *
 851  */
 852 function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
 853         global $wgRequest;
 854         return $wgRequest->getLimitOffset( $deflimit, $optionname );
 855 }
 856
 857 /**
 858  * Escapes the given text so that it may be output using addWikiText()
 859  * without any linking, formatting, etc. making its way through. This
 860  * is achieved by substituting certain characters with HTML entities.
 861  * As required by the callers, <nowiki> is not used. It currently does
 862  * not filter out characters which have special meaning only at the
 863  * start of a line, such as "*".
 864  *
 865  * @param string $text Text to be escaped
 866  */
 867 function wfEscapeWikiText( $text ) {
 868         $text = str_replace(
 869                 array( '[',             '|',      '\'',    'ISBN '        , '://'         , "\n=", '{{' ),
 870                 array( '&#91;', '&#124;', '&#39;', 'ISBN&#32;', '&#58;//' , "\n&#61;", '&#123;&#123;' ),
 871                 htmlspecialchars($text) );
 872         return $text;
 873 }
 874
 875 /**
 876  * @todo document
 877  */
 878 function wfQuotedPrintable( $string, $charset = '' ) {
 879         # Probably incomplete; see RFC 2045
 880         if( empty( $charset ) ) {
 881                 global $wgInputEncoding;
 882                 $charset = $wgInputEncoding;
 883         }
 884         $charset = strtoupper( $charset );
 885         $charset = str_replace( 'ISO-8859', 'ISO8859', $charset ); // ?
 886
 887         $illegal = '\x00-\x08\x0b\x0c\x0e-\x1f\x7f-\xff=';
 888         $replace = $illegal . '\t ?_';
 889         if( !preg_match( "/[$illegal]/", $string ) ) return $string;
 890         $out = "=?$charset?Q?";
 891         $out .= preg_replace( "/([$replace])/e", 'sprintf("=%02X",ord("$1"))', $string );
 892         $out .= '?=';
 893         return $out;
 894 }
 895
 896
 897 /**
 898  * @todo document
 899  * @return float
 900  */
 901 function wfTime() {
 902         $st = explode( ' ', microtime() );
 903         return (float)$st[0] + (float)$st[1];
 904 }
 905
 906 /**
 907  * Sets dest to source and returns the original value of dest
 908  * If source is NULL, it just returns the value, it doesn't set the variable
 909  */
 910 function wfSetVar( &$dest, $source ) {
 911         $temp = $dest;
 912         if ( !is_null( $source ) ) {
 913                 $dest = $source;
 914         }
 915         return $temp;
 916 }
 917
 918 /**
 919  * As for wfSetVar except setting a bit
 920  */
 921 function wfSetBit( &$dest, $bit, $state = true ) {
 922         $temp = (bool)($dest & $bit );
 923         if ( !is_null( $state ) ) {
 924                 if ( $state ) {
 925                         $dest |= $bit;
 926                 } else {
 927                         $dest &= ~$bit;
 928                 }
 929         }
 930         return $temp;
 931 }
 932
 933 /**
 934  * This function takes two arrays as input, and returns a CGI-style string, e.g.
 935  * "days=7&limit=100". Options in the first array override options in the second.
 936  * Options set to "" will not be output.
 937  */
 938 function wfArrayToCGI( $array1, $array2 = NULL )
 939 {
 940         if ( !is_null( $array2 ) ) {
 941                 $array1 = $array1 + $array2;
 942         }
 943
 944         $cgi = '';
 945         foreach ( $array1 as $key => $value ) {
 946                 if ( '' !== $value ) {
 947                         if ( '' != $cgi ) {
 948                                 $cgi .= '&';
 949                         }
 950                         $cgi .= urlencode( $key ) . '=' . urlencode( $value );
 951                 }
 952         }
 953         return $cgi;
 954 }
 955
 956 /**
 957  * This is obsolete, use SquidUpdate::purge()
 958  * @deprecated
 959  */
 960 function wfPurgeSquidServers ($urlArr) {
 961         SquidUpdate::purge( $urlArr );
 962 }
 963
 964 /**
 965  * Windows-compatible version of escapeshellarg()
 966  * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
 967  * function puts single quotes in regardless of OS
 968  */
 969 function wfEscapeShellArg( ) {
 970         $args = func_get_args();
 971         $first = true;
 972         $retVal = '';
 973         foreach ( $args as $arg ) {
 974                 if ( !$first ) {
 975                         $retVal .= ' ';
 976                 } else {
 977                         $first = false;
 978                 }
 979
 980                 if ( wfIsWindows() ) {
 981                         // Escaping for an MSVC-style command line parser
 982                         // Ref: http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
 983                         // Double the backslashes before any double quotes. Escape the double quotes.
 984                         $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE );
 985                         $arg = '';
 986                         $delim = false;
 987                         foreach ( $tokens as $token ) {
 988                                 if ( $delim ) {
 989                                         $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
 990                                 } else {
 991                                         $arg .= $token;
 992                                 }
 993                                 $delim = !$delim;
 994                         }
 995                         // Double the backslashes before the end of the string, because
 996                         // we will soon add a quote
 997                         if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
 998                                 $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
 999                         }
1000
1001                         // Add surrounding quotes
1002                         $retVal .= '"' . $arg . '"';
1003                 } else {
1004                         $retVal .= escapeshellarg( $arg );
1005                 }
1006         }
1007         return $retVal;
1008 }
1009
1010 /**
1011  * wfMerge attempts to merge differences between three texts.
1012  * Returns true for a clean merge and false for failure or a conflict.
1013  */
1014 function wfMerge( $old, $mine, $yours, &$result ){
1015         global $wgDiff3;
1016
1017         # This check may also protect against code injection in
1018         # case of broken installations.
1019         if(! file_exists( $wgDiff3 ) ){
1020                 wfDebug( "diff3 not found\n" );
1021                 return false;
1022         }
1023
1024         # Make temporary files
1025         $td = wfTempDir();
1026         $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
1027         $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
1028         $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
1029
1030         fwrite( $oldtextFile, $old ); fclose( $oldtextFile );
1031         fwrite( $mytextFile, $mine ); fclose( $mytextFile );
1032         fwrite( $yourtextFile, $yours ); fclose( $yourtextFile );
1033
1034         # Check for a conflict
1035         $cmd = $wgDiff3 . ' -a --overlap-only ' .
1036           wfEscapeShellArg( $mytextName ) . ' ' .
1037           wfEscapeShellArg( $oldtextName ) . ' ' .
1038           wfEscapeShellArg( $yourtextName );
1039         $handle = popen( $cmd, 'r' );
1040
1041         if( fgets( $handle, 1024 ) ){
1042                 $conflict = true;
1043         } else {
1044                 $conflict = false;
1045         }
1046         pclose( $handle );
1047
1048         # Merge differences
1049         $cmd = $wgDiff3 . ' -a -e --merge ' .
1050           wfEscapeShellArg( $mytextName, $oldtextName, $yourtextName );
1051         $handle = popen( $cmd, 'r' );
1052         $result = '';
1053         do {
1054                 $data = fread( $handle, 8192 );
1055                 if ( strlen( $data ) == 0 ) {
1056                         break;
1057                 }
1058                 $result .= $data;
1059         } while ( true );
1060         pclose( $handle );
1061         unlink( $mytextName ); unlink( $oldtextName ); unlink( $yourtextName );
1062
1063         if ( $result === '' && $old !== '' && $conflict == false ) {
1064                 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
1065                 $conflict = true;
1066         }
1067         return ! $conflict;
1068 }
1069
1070 /**
1071  * @todo document
1072  */
1073 function wfVarDump( $var ) {
1074         global $wgOut;
1075         $s = str_replace("\n","<br />\n", var_export( $var, true ) . "\n");
1076         if ( headers_sent() || !@is_object( $wgOut ) ) {
1077                 print $s;
1078         } else {
1079                 $wgOut->addHTML( $s );
1080         }
1081 }
1082
1083 /**
1084  * Provide a simple HTTP error.
1085  */
1086 function wfHttpError( $code, $label, $desc ) {
1087         global $wgOut;
1088         $wgOut->disable();
1089         header( "HTTP/1.0 $code $label" );
1090         header( "Status: $code $label" );
1091         $wgOut->sendCacheControl();
1092
1093         header( 'Content-type: text/html' );
1094         print "<html><head><title>" .
1095                 htmlspecialchars( $label ) .
1096                 "</title></head><body><h1>" .
1097                 htmlspecialchars( $label ) .
1098                 "</h1><p>" .
1099                 htmlspecialchars( $desc ) .
1100                 "</p></body></html>\n";
1101 }
1102
1103 /**
1104  * Converts an Accept-* header into an array mapping string values to quality
1105  * factors
1106  */
1107 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
1108         # No arg means accept anything (per HTTP spec)
1109         if( !$accept ) {
1110                 return array( $def => 1 );
1111         }
1112
1113         $prefs = array();
1114
1115         $parts = explode( ',', $accept );
1116
1117         foreach( $parts as $part ) {
1118                 # FIXME: doesn't deal with params like 'text/html; level=1'
1119                 @list( $value, $qpart ) = explode( ';', $part );
1120                 if( !isset( $qpart ) ) {
1121                         $prefs[$value] = 1;
1122                 } elseif( preg_match( '/q\s*=\s*(\d*\.\d+)/', $qpart, $match ) ) {
1123                         $prefs[$value] = $match[1];
1124                 }
1125         }
1126
1127         return $prefs;
1128 }
1129
1130 /**
1131  * Checks if a given MIME type matches any of the keys in the given
1132  * array. Basic wildcards are accepted in the array keys.
1133  *
1134  * Returns the matching MIME type (or wildcard) if a match, otherwise
1135  * NULL if no match.
1136  *
1137  * @param string $type
1138  * @param array $avail
1139  * @return string
1140  * @private
1141  */
1142 function mimeTypeMatch( $type, $avail ) {
1143         if( array_key_exists($type, $avail) ) {
1144                 return $type;
1145         } else {
1146                 $parts = explode( '/', $type );
1147                 if( array_key_exists( $parts[0] . '/*', $avail ) ) {
1148                         return $parts[0] . '/*';
1149                 } elseif( array_key_exists( '*/*', $avail ) ) {
1150                         return '*/*';
1151                 } else {
1152                         return NULL;
1153                 }
1154         }
1155 }
1156
1157 /**
1158  * Returns the 'best' match between a client's requested internet media types
1159  * and the server's list of available types. Each list should be an associative
1160  * array of type to preference (preference is a float between 0.0 and 1.0).
1161  * Wildcards in the types are acceptable.
1162  *
1163  * @param array $cprefs Client's acceptable type list
1164  * @param array $sprefs Server's offered types
1165  * @return string
1166  *
1167  * @todo FIXME: doesn't handle params like 'text/plain; charset=UTF-8'
1168  * XXX: generalize to negotiate other stuff
1169  */
1170 function wfNegotiateType( $cprefs, $sprefs ) {
1171         $combine = array();
1172
1173         foreach( array_keys($sprefs) as $type ) {
1174                 $parts = explode( '/', $type );
1175                 if( $parts[1] != '*' ) {
1176                         $ckey = mimeTypeMatch( $type, $cprefs );
1177                         if( $ckey ) {
1178                                 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1179                         }
1180                 }
1181         }
1182
1183         foreach( array_keys( $cprefs ) as $type ) {
1184                 $parts = explode( '/', $type );
1185                 if( $parts[1] != '*' && !array_key_exists( $type, $sprefs ) ) {
1186                         $skey = mimeTypeMatch( $type, $sprefs );
1187                         if( $skey ) {
1188                                 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1189                         }
1190                 }
1191         }
1192
1193         $bestq = 0;
1194         $besttype = NULL;
1195
1196         foreach( array_keys( $combine ) as $type ) {
1197                 if( $combine[$type] > $bestq ) {
1198                         $besttype = $type;
1199                         $bestq = $combine[$type];
1200                 }
1201         }
1202
1203         return $besttype;
1204 }
1205
1206 /**
1207  * Array lookup
1208  * Returns an array where the values in the first array are replaced by the
1209  * values in the second array with the corresponding keys
1210  *
1211  * @return array
1212  */
1213 function wfArrayLookup( $a, $b ) {
1214         return array_flip( array_intersect( array_flip( $a ), array_keys( $b ) ) );
1215 }
1216
1217 /**
1218  * Convenience function; returns MediaWiki timestamp for the present time.
1219  * @return string
1220  */
1221 function wfTimestampNow() {
1222         # return NOW
1223         return wfTimestamp( TS_MW, time() );
1224 }
1225
1226 /**
1227  * Reference-counted warning suppression
1228  */
1229 function wfSuppressWarnings( $end = false ) {
1230         static $suppressCount = 0;
1231         static $originalLevel = false;
1232
1233         if ( $end ) {
1234                 if ( $suppressCount ) {
1235                         --$suppressCount;
1236                         if ( !$suppressCount ) {
1237                                 error_reporting( $originalLevel );
1238                         }
1239                 }
1240         } else {
1241                 if ( !$suppressCount ) {
1242                         $originalLevel = error_reporting( E_ALL & ~( E_WARNING | E_NOTICE ) );
1243                 }
1244                 ++$suppressCount;
1245         }
1246 }
1247
1248 /**
1249  * Restore error level to previous value
1250  */
1251 function wfRestoreWarnings() {
1252         wfSuppressWarnings( true );
1253 }
1254
1255 # Autodetect, convert and provide timestamps of various types
1256
1257 /**
1258  * Unix time - the number of seconds since 1970-01-01 00:00:00 UTC
1259  */
1260 define('TS_UNIX', 0);
1261
1262 /**
1263  * MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
1264  */
1265 define('TS_MW', 1);
1266
1267 /**
1268  * MySQL DATETIME (YYYY-MM-DD HH:MM:SS)
1269  */
1270 define('TS_DB', 2);
1271
1272 /**
1273  * RFC 2822 format, for E-mail and HTTP headers
1274  */
1275 define('TS_RFC2822', 3);
1276
1277 /**
1278  * ISO 8601 format with no timezone: 1986-02-09T20:00:00Z
1279  *
1280  * This is used by Special:Export
1281  */
1282 define('TS_ISO_8601', 4);
1283
1284 /**
1285  * An Exif timestamp (YYYY:MM:DD HH:MM:SS)
1286  *
1287  * @url http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the
1288  *       DateTime tag and page 36 for the DateTimeOriginal and
1289  *       DateTimeDigitized tags.
1290  */
1291 define('TS_EXIF', 5);
1292
1293 /**
1294  * Oracle format time.
1295  */
1296 define('TS_ORACLE', 6);
1297
1298 /**
1299  * @param mixed $outputtype A timestamp in one of the supported formats, the
1300  *                          function will autodetect which format is supplied
1301  *                          and act accordingly.
1302  * @return string Time in the format specified in $outputtype
1303  */
1304 function wfTimestamp($outputtype=TS_UNIX,$ts=0) {
1305         $uts = 0;
1306         $da = array();
1307         if ($ts==0) {
1308                 $uts=time();
1309         } elseif (preg_match("/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)$/",$ts,$da)) {
1310                 # TS_DB
1311                 $uts=gmmktime((int)$da[4],(int)$da[5],(int)$da[6],
1312                             (int)$da[2],(int)$da[3],(int)$da[1]);
1313         } elseif (preg_match("/^(\d{4}):(\d\d):(\d\d) (\d\d):(\d\d):(\d\d)$/",$ts,$da)) {
1314                 # TS_EXIF
1315                 $uts=gmmktime((int)$da[4],(int)$da[5],(int)$da[6],
1316                         (int)$da[2],(int)$da[3],(int)$da[1]);
1317         } elseif (preg_match("/^(\d{4})(\d\d)(\d\d)(\d\d)(\d\d)(\d\d)$/",$ts,$da)) {
1318                 # TS_MW
1319                 $uts=gmmktime((int)$da[4],(int)$da[5],(int)$da[6],
1320                             (int)$da[2],(int)$da[3],(int)$da[1]);
1321         } elseif (preg_match("/^(\d{1,13})$/",$ts,$datearray)) {
1322                 # TS_UNIX
1323                 $uts=$ts;
1324         } elseif (preg_match('/^(\d{1,2})-(...)-(\d\d(\d\d)?) (\d\d)\.(\d\d)\.(\d\d)/', $ts, $da)) {
1325                 # TS_ORACLE
1326                 $uts = strtotime(preg_replace('/(\d\d)\.(\d\d)\.(\d\d)(\.(\d+))?/', "$1:$2:$3",
1327                                 str_replace("+00:00", "UTC", $ts)));
1328         } elseif (preg_match('/^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})Z$/', $ts, $da)) {
1329                 # TS_ISO_8601
1330                 $uts=gmmktime((int)$da[4],(int)$da[5],(int)$da[6],
1331                         (int)$da[2],(int)$da[3],(int)$da[1]);
1332         } else {
1333                 # Bogus value; fall back to the epoch...
1334                 wfDebug("wfTimestamp() fed bogus time value: $outputtype; $ts\n");
1335                 $uts = 0;
1336         }
1337
1338
1339         switch($outputtype) {
1340                 case TS_UNIX:
1341                         return $uts;
1342                 case TS_MW:
1343                         return gmdate( 'YmdHis', $uts );
1344                 case TS_DB:
1345                         return gmdate( 'Y-m-d H:i:s', $uts );
1346                 case TS_ISO_8601:
1347                         return gmdate( 'Y-m-d\TH:i:s\Z', $uts );
1348                 // This shouldn't ever be used, but is included for completeness
1349                 case TS_EXIF:
1350                         return gmdate(  'Y:m:d H:i:s', $uts );
1351                 case TS_RFC2822:
1352                         return gmdate( 'D, d M Y H:i:s', $uts ) . ' GMT';
1353                 case TS_ORACLE:
1354                         return gmdate( 'd-M-y h.i.s A', $uts) . ' +00:00';
1355                 default:
1356                         wfDebugDieBacktrace( 'wfTimestamp() called with illegal output type.');
1357         }
1358 }
1359
1360 /**
1361  * Return a formatted timestamp, or null if input is null.
1362  * For dealing with nullable timestamp columns in the database.
1363  * @param int $outputtype
1364  * @param string $ts
1365  * @return string
1366  */
1367 function wfTimestampOrNull( $outputtype = TS_UNIX, $ts = null ) {
1368         if( is_null( $ts ) ) {
1369                 return null;
1370         } else {
1371                 return wfTimestamp( $outputtype, $ts );
1372         }
1373 }
1374
1375 /**
1376  * Check if the operating system is Windows
1377  *
1378  * @return bool True if it's Windows, False otherwise.
1379  */
1380 function wfIsWindows() {
1381         if (substr(php_uname(), 0, 7) == 'Windows') {
1382                 return true;
1383         } else {
1384                 return false;
1385         }
1386 }
1387
1388 /**
1389  * Swap two variables
1390  */
1391 function swap( &$x, &$y ) {
1392         $z = $x;
1393         $x = $y;
1394         $y = $z;
1395 }
1396
1397 function wfGetCachedNotice( $name ) {
1398         global $wgOut, $parserMemc, $wgDBname;
1399         $fname = 'wfGetCachedNotice';
1400         wfProfileIn( $fname );
1401
1402         $needParse = false;
1403         $notice = wfMsgForContent( $name );
1404         if( $notice == '&lt;'. $name . ';&gt' || $notice == '-' ) {
1405                 wfProfileOut( $fname );
1406                 return( false );
1407         }
1408
1409         $cachedNotice = $parserMemc->get( $wgDBname . ':' . $name );
1410         if( is_array( $cachedNotice ) ) {
1411                 if( md5( $notice ) == $cachedNotice['hash'] ) {
1412                         $notice = $cachedNotice['html'];
1413                 } else {
1414                         $needParse = true;
1415                 }
1416         } else {
1417                 $needParse = true;
1418         }
1419
1420         if( $needParse ) {
1421                 if( is_object( $wgOut ) ) {
1422                         $parsed = $wgOut->parse( $notice );
1423                         $parserMemc->set( $wgDBname . ':' . $name, array( 'html' => $parsed, 'hash' => md5( $notice ) ), 600 );
1424                         $notice = $parsed;
1425                 } else {
1426                         wfDebug( 'wfGetCachedNotice called for ' . $name . ' with no $wgOut available' );
1427                         $notice = '';
1428                 }
1429         }
1430
1431         wfProfileOut( $fname );
1432         return $notice;
1433 }
1434
1435 function wfGetNamespaceNotice() {
1436         global $wgTitle;
1437
1438         # Paranoia
1439         if ( !isset( $wgTitle ) || !is_object( $wgTitle ) )
1440                 return "";
1441
1442         $fname = 'wfGetNamespaceNotice';
1443         wfProfileIn( $fname );
1444
1445         $key = "namespacenotice-" . $wgTitle->getNsText();
1446         $namespaceNotice = wfGetCachedNotice( $key );
1447         if ( $namespaceNotice && substr ( $namespaceNotice , 0 ,7 ) != "<p>&lt;" ) {
1448                  $namespaceNotice = '<div id="namespacebanner">' . $namespaceNotice . "</div>";
1449         } else {
1450                 $namespaceNotice = "";
1451         }
1452
1453         wfProfileOut( $fname );
1454         return $namespaceNotice;
1455 }
1456
1457 function wfGetSiteNotice() {
1458         global $wgUser, $wgSiteNotice;
1459         $fname = 'wfGetSiteNotice';
1460         wfProfileIn( $fname );
1461
1462         if( is_object( $wgUser ) && $wgUser->isLoggedIn() ) {
1463                 $siteNotice = wfGetCachedNotice( 'sitenotice' );
1464                 $siteNotice = !$siteNotice ? $wgSiteNotice : $siteNotice;
1465         } else {
1466                 $anonNotice = wfGetCachedNotice( 'anonnotice' );
1467                 if( !$anonNotice ) {
1468                         $siteNotice = wfGetCachedNotice( 'sitenotice' );
1469                         $siteNotice = !$siteNotice ? $wgSiteNotice : $siteNotice;
1470                 } else {
1471                         $siteNotice = $anonNotice;
1472                 }
1473         }
1474
1475         wfProfileOut( $fname );
1476         return( $siteNotice );
1477 }
1478
1479 /** Global singleton instance of MimeMagic. This is initialized on demand,
1480 * please always use the wfGetMimeMagic() function to get the instance.
1481 *
1482 * @private
1483 */
1484 $wgMimeMagic= NULL;
1485
1486 /** Factory functions for the global MimeMagic object.
1487 * This function always returns the same singleton instance of MimeMagic.
1488 * That objects will be instantiated on the first call to this function.
1489 * If needed, the MimeMagic.php file is automatically included by this function.
1490 * @return MimeMagic the global MimeMagic objects.
1491 */
1492 function &wfGetMimeMagic() {
1493         global $wgMimeMagic;
1494
1495         if (!is_null($wgMimeMagic)) {
1496                 return $wgMimeMagic;
1497         }
1498
1499         if (!class_exists("MimeMagic")) {
1500                 #include on demand
1501                 require_once("MimeMagic.php");
1502         }
1503
1504         $wgMimeMagic= new MimeMagic();
1505
1506         return $wgMimeMagic;
1507 }
1508
1509
1510 /**
1511  * Tries to get the system directory for temporary files.
1512  * The TMPDIR, TMP, and TEMP environment variables are checked in sequence,
1513  * and if none are set /tmp is returned as the generic Unix default.
1514  *
1515  * NOTE: When possible, use the tempfile() function to create temporary
1516  * files to avoid race conditions on file creation, etc.
1517  *
1518  * @return string
1519  */
1520 function wfTempDir() {
1521         foreach( array( 'TMPDIR', 'TMP', 'TEMP' ) as $var ) {
1522                 $tmp = getenv( $var );
1523                 if( $tmp && file_exists( $tmp ) && is_dir( $tmp ) && is_writable( $tmp ) ) {
1524                         return $tmp;
1525                 }
1526         }
1527         # Hope this is Unix of some kind!
1528         return '/tmp';
1529 }
1530
1531 /**
1532  * Make directory, and make all parent directories if they don't exist
1533  */
1534 function wfMkdirParents( $fullDir, $mode ) {
1535         $parts = explode( '/', $fullDir );
1536         $path = '';
1537
1538         foreach ( $parts as $dir ) {
1539                 $path .= $dir . '/';
1540                 if ( !is_dir( $path ) ) {
1541                         if ( !mkdir( $path, $mode ) ) {
1542                                 return false;
1543                         }
1544                 }
1545         }
1546         return true;
1547 }
1548
1549 /**
1550  * Increment a statistics counter
1551  */
1552  function wfIncrStats( $key ) {
1553          global $wgDBname, $wgMemc;
1554          $key = "$wgDBname:stats:$key";
1555          if ( is_null( $wgMemc->incr( $key ) ) ) {
1556                  $wgMemc->add( $key, 1 );
1557          }
1558  }
1559
1560 /**
1561  * @param mixed $nr The number to format
1562  * @param int $acc The number of digits after the decimal point, default 2
1563  * @param bool $round Whether or not to round the value, default true
1564  * @return float
1565  */
1566 function wfPercent( $nr, $acc = 2, $round = true ) {
1567         $ret = sprintf( "%.${acc}f", $nr );
1568         return $round ? round( $ret, $acc ) . '%' : "$ret%";
1569 }
1570
1571 /**
1572  * Encrypt a username/password.
1573  *
1574  * @param string $userid ID of the user
1575  * @param string $password Password of the user
1576  * @return string Hashed password
1577  */
1578 function wfEncryptPassword( $userid, $password ) {
1579         global $wgPasswordSalt;
1580         $p = md5( $password);
1581
1582         if($wgPasswordSalt)
1583                 return md5( "{$userid}-{$p}" );
1584         else
1585                 return $p;
1586 }
1587
1588 /**
1589  * Appends to second array if $value differs from that in $default
1590  */
1591 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
1592         if ( is_null( $changed ) ) {
1593                 wfDebugDieBacktrace('GlobalFunctions::wfAppendToArrayIfNotDefault got null');
1594         }
1595         if ( $default[$key] !== $value ) {
1596                 $changed[$key] = $value;
1597         }
1598 }
1599
1600 /**
1601  * Since wfMsg() and co suck, they don't return false if the message key they
1602  * looked up didn't exist but a XHTML string, this function checks for the
1603  * nonexistance of messages by looking at wfMsg() output
1604  *
1605  * @param $msg      The message key looked up
1606  * @param $wfMsgOut The output of wfMsg*()
1607  * @return bool
1608  */
1609 function wfEmptyMsg( $msg, $wfMsgOut ) {
1610         return $wfMsgOut === "&lt;$msg&gt;";
1611 }
1612
1613 /**
1614  * Find out whether or not a mixed variable exists in a string
1615  *
1616  * @param mixed  needle
1617  * @param string haystack
1618  * @return bool
1619  */
1620 function in_string( $needle, $str ) {
1621         return strpos( $str, $needle ) !== false;
1622 }
1623
1624 /**
1625  * Returns a regular expression of url protocols
1626  *
1627  * @return string
1628  */
1629 function wfUrlProtocols() {
1630         global $wgUrlProtocols;
1631
1632         // Support old-style $wgUrlProtocols strings, for backwards compatibility
1633         // with LocalSettings files from 1.5
1634         if ( is_array( $wgUrlProtocols ) ) {
1635                 $protocols = array();
1636                 foreach ($wgUrlProtocols as $protocol)
1637                         $protocols[] = preg_quote( $protocol, '/' );
1638
1639                 return implode( '|', $protocols );
1640         } else {
1641                 return $wgUrlProtocols;
1642         }
1643 }
1644
1645 /**
1646  * shell_exec() with time and memory limits mirrored from the PHP configuration,
1647  * if supported.
1648  */
1649 function wfShellExec( $cmd )
1650 {
1651         global $IP;
1652
1653         if ( php_uname( 's' ) == 'Linux' ) {
1654                 $time = ini_get( 'max_execution_time' );
1655                 $mem = ini_get( 'memory_limit' );
1656                 if( preg_match( '/^([0-9]+)[Mm]$/', trim( $mem ), $m ) ) {
1657                         $mem = intval( $m[1] * (1024*1024) );
1658                 }
1659                 if ( $time > 0 && $mem > 0 ) {
1660                         $script = "$IP/bin/ulimit.sh";
1661                         if ( is_executable( $script ) ) {
1662                                 $memKB = intval( $mem / 1024 );
1663                                 $cmd = escapeshellarg( $script ) . " $time $memKB $cmd";
1664                         }
1665                 }
1666         } elseif ( php_uname( 's' ) == 'Windows NT' ) {
1667                 # This is a hack to work around PHP's flawed invocation of cmd.exe
1668                 # http://news.php.net/php.internals/21796
1669                 $cmd = '"' . $cmd . '"';
1670         }
1671         wfDebug( "wfShellExec: $cmd\n" );
1672         return shell_exec( $cmd );
1673 }
1674
1675 /**
1676  * This function works like "use VERSION" in Perl, the program will die with a
1677  * backtrace if the current version of PHP is less than the version provided
1678  *
1679  * This is useful for extensions which due to their nature are not kept in sync
1680  * with releases, and might depend on other versions of PHP than the main code
1681  *
1682  * Note: PHP might die due to parsing errors in some cases before it ever
1683  *       manages to call this function, such is life
1684  *
1685  * @see perldoc -f use
1686  *
1687  * @param mixed $version The version to check, can be a string, an integer, or
1688  *                       a float
1689  */
1690 function wfUsePHP( $req_ver ) {
1691         $php_ver = PHP_VERSION;
1692
1693         if ( version_compare( $php_ver, (string)$req_ver, '<' ) )
1694                  wfDebugDieBacktrace( "PHP $req_ver required--this is only $php_ver" );
1695 }
1696
1697 /**
1698  * This function works like "use VERSION" in Perl except it checks the version
1699  * of MediaWiki, the program will die with a backtrace if the current version
1700  * of MediaWiki is less than the version provided.
1701  *
1702  * This is useful for extensions which due to their nature are not kept in sync
1703  * with releases
1704  *
1705  * @see perldoc -f use
1706  *
1707  * @param mixed $version The version to check, can be a string, an integer, or
1708  *                       a float
1709  */
1710 function wfUseMW( $req_ver ) {
1711         global $wgVersion;
1712
1713         if ( version_compare( $wgVersion, (string)$req_ver, '<' ) )
1714                 wfDebugDieBacktrace( "MediaWiki $req_ver required--this is only $wgVersion" );
1715 }
1716
1717 /**
1718  * Escape a string to make it suitable for inclusion in a preg_replace()
1719  * replacement parameter.
1720  *
1721  * @param string $string
1722  * @return string
1723  */
1724 function wfRegexReplacement( $string ) {
1725         $string = str_replace( '\\', '\\\\', $string );
1726         $string = str_replace( '$', '\\$', $string );
1727         return $string;
1728 }
1729
1730 /**
1731  * Return the final portion of a pathname.
1732  * Reimplemented because PHP5's basename() is buggy with multibyte text.
1733  * http://bugs.php.net/bug.php?id=33898
1734  *
1735  * PHP's basename() only considers '\' a pathchar on Windows and Netware.
1736  * We'll consider it so always, as we don't want \s in our Unix paths either.
1737  *
1738  * @param string $path
1739  * @return string
1740  */
1741 function wfBaseName( $path ) {
1742         if( preg_match( '#([^/\\\\]*)[/\\\\]*$#', $path, $matches ) ) {
1743                 return $matches[1];
1744         } else {
1745                 return '';
1746         }
1747 }
1748
1749 /**
1750  * Make a URL index, appropriate for the el_index field of externallinks.
1751  */
1752 function wfMakeUrlIndex( $url ) {
1753         wfSuppressWarnings();
1754         $bits = parse_url( $url );
1755         wfRestoreWarnings();
1756         if ( !$bits || $bits['scheme'] !== 'http' ) {
1757                 return false;
1758         }
1759         // Reverse the labels in the hostname, convert to lower case
1760         $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) );
1761         // Add an extra dot to the end
1762         if ( substr( $reversedHost, -1, 1 ) !== '.' ) {
1763                 $reversedHost .= '.';
1764         }
1765         // Reconstruct the pseudo-URL
1766         $index = "http://$reversedHost";
1767         // Leave out user and password. Add the port, path, query and fragment
1768         if ( isset( $bits['port'] ) )      $index .= ':' . $bits['port'];
1769         if ( isset( $bits['path'] ) ) {
1770                 $index .= $bits['path'];
1771         } else {
1772                 $index .= '/';
1773         }
1774         if ( isset( $bits['query'] ) )     $index .= '?' . $bits['query'];
1775         if ( isset( $bits['fragment'] ) )  $index .= '#' . $bits['fragment'];
1776         return $index;
1777 }
1778
1779 /**
1780  * Do any deferred updates and clear the list
1781  * TODO: This could be in Wiki.php if that class made any sense at all
1782  */
1783 function wfDoUpdates()
1784 {
1785         global $wgPostCommitUpdateList, $wgDeferredUpdateList;
1786         foreach ( $wgDeferredUpdateList as $update ) {
1787                 $update->doUpdate();
1788         }
1789         foreach ( $wgPostCommitUpdateList as $update ) {
1790                 $update->doUpdate();
1791         }
1792         $wgDeferredUpdateList = array();
1793         $wgPostCommitUpdateList = array();
1794 }
1795
1796 /**
1797  * More or less "markup-safe" explode()
1798  * Ignores any instances of the separator inside <...>
1799  * @param string $separator
1800  * @param string $text
1801  * @return array
1802  */
1803 function wfExplodeMarkup( $separator, $text ) {
1804         $placeholder = "\x00";
1805
1806         // Just in case...
1807         $text = str_replace( $placeholder, '', $text );
1808
1809         // Trim stuff
1810         $replacer = new ReplacerCallback( $separator, $placeholder );
1811         $cleaned = preg_replace_callback( '/(<.*?>)/', array( $replacer, 'go' ), $text );
1812
1813         $items = explode( $separator, $cleaned );
1814         foreach( $items as $i => $str ) {
1815                 $items[$i] = str_replace( $placeholder, $separator, $str );
1816         }
1817
1818         return $items;
1819 }
1820
1821 class ReplacerCallback {
1822         function ReplacerCallback( $from, $to ) {
1823                 $this->from = $from;
1824                 $this->to = $to;
1825         }
1826
1827         function go( $matches ) {
1828                 return str_replace( $this->from, $this->to, $matches[1] );
1829         }
1830 }
1831
1832 ?>