includes/GlobalFunctions.php

   1 <?php
   2
   3 if ( !defined( 'MEDIAWIKI' ) ) {
   4         die( "This file is part of MediaWiki, it is not a valid entry point" );
   5 }
   6
   7 /**
   8  * Global functions used everywhere
   9  */
  10
  11 require_once dirname(__FILE__) . '/LogPage.php';
  12 require_once dirname(__FILE__) . '/normal/UtfNormalUtil.php';
  13 require_once dirname(__FILE__) . '/XmlFunctions.php';
  14
  15 /**
  16  * Compatibility functions
  17  *
  18  * We more or less support PHP 5.0.x and up.
  19  * Re-implementations of newer functions or functions in non-standard
  20  * PHP extensions may be included here.
  21  */
  22 if( !function_exists('iconv') ) {
  23         # iconv support is not in the default configuration and so may not be present.
  24         # Assume will only ever use utf-8 and iso-8859-1.
  25         # This will *not* work in all circumstances.
  26         function iconv( $from, $to, $string ) {
  27                 if(strcasecmp( $from, $to ) == 0) return $string;
  28                 if(strcasecmp( $from, 'utf-8' ) == 0) return utf8_decode( $string );
  29                 if(strcasecmp( $to, 'utf-8' ) == 0) return utf8_encode( $string );
  30                 return $string;
  31         }
  32 }
  33
  34 # UTF-8 substr function based on a PHP manual comment
  35 if ( !function_exists( 'mb_substr' ) ) {
  36         function mb_substr( $str, $start ) {
  37                 $ar = array();
  38                 preg_match_all( '/./us', $str, $ar );
  39
  40                 if( func_num_args() >= 3 ) {
  41                         $end = func_get_arg( 2 );
  42                         return join( '', array_slice( $ar[0], $start, $end ) );
  43                 } else {
  44                         return join( '', array_slice( $ar[0], $start ) );
  45                 }
  46         }
  47 }
  48
  49 if ( !function_exists( 'mb_strlen' ) ) {
  50         /**
  51          * Fallback implementation of mb_strlen, hardcoded to UTF-8.
  52          * @param string $str
  53          * @param string $enc optional encoding; ignored
  54          * @return int
  55          */
  56         function mb_strlen( $str, $enc="" ) {
  57                 $counts = count_chars( $str );
  58                 $total = 0;
  59
  60                 // Count ASCII bytes
  61                 for( $i = 0; $i < 0x80; $i++ ) {
  62                         $total += $counts[$i];
  63                 }
  64
  65                 // Count multibyte sequence heads
  66                 for( $i = 0xc0; $i < 0xff; $i++ ) {
  67                         $total += $counts[$i];
  68                 }
  69                 return $total;
  70         }
  71 }
  72
  73 if ( !function_exists( 'array_diff_key' ) ) {
  74         /**
  75          * Exists in PHP 5.1.0+
  76          * Not quite compatible, two-argument version only
  77          * Null values will cause problems due to this use of isset()
  78          */
  79         function array_diff_key( $left, $right ) {
  80                 $result = $left;
  81                 foreach ( $left as $key => $unused ) {
  82                         if ( isset( $right[$key] ) ) {
  83                                 unset( $result[$key] );
  84                         }
  85                 }
  86                 return $result;
  87         }
  88 }
  89
  90 /**
  91  * Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
  92  */
  93 function wfArrayDiff2( $a, $b ) {
  94         return array_udiff( $a, $b, 'wfArrayDiff2_cmp' );
  95 }
  96 function wfArrayDiff2_cmp( $a, $b ) {
  97         if ( !is_array( $a ) ) {
  98                 return strcmp( $a, $b );
  99         } elseif ( count( $a ) !== count( $b ) ) {
 100                 return count( $a ) < count( $b ) ? -1 : 1;
 101         } else {
 102                 reset( $a );
 103                 reset( $b );
 104                 while( ( list( $keyA, $valueA ) = each( $a ) ) && ( list( $keyB, $valueB ) = each( $b ) ) ) {
 105                         $cmp = strcmp( $valueA, $valueB );
 106                         if ( $cmp !== 0 ) {
 107                                 return $cmp;
 108                         }
 109                 }
 110                 return 0;
 111         }
 112 }
 113
 114 /**
 115  * Wrapper for clone(), for compatibility with PHP4-friendly extensions.
 116  * PHP 5 won't let you declare a 'clone' function, even conditionally,
 117  * so it has to be a wrapper with a different name.
 118  */
 119 function wfClone( $object ) {
 120         return clone( $object );
 121 }
 122
 123 /**
 124  * Seed Mersenne Twister
 125  * No-op for compatibility; only necessary in PHP < 4.2.0
 126  */
 127 function wfSeedRandom() {
 128         /* No-op */
 129 }
 130
 131 /**
 132  * Get a random decimal value between 0 and 1, in a way
 133  * not likely to give duplicate values for any realistic
 134  * number of articles.
 135  *
 136  * @return string
 137  */
 138 function wfRandom() {
 139         # The maximum random value is "only" 2^31-1, so get two random
 140         # values to reduce the chance of dupes
 141         $max = mt_getrandmax() + 1;
 142         $rand = number_format( (mt_rand() * $max + mt_rand())
 143                 / $max / $max, 12, '.', '' );
 144         return $rand;
 145 }
 146
 147 /**
 148  * We want / and : to be included as literal characters in our title URLs.
 149  * %2F in the page titles seems to fatally break for some reason.
 150  *
 151  * @param $s String:
 152  * @return string
 153 */
 154 function wfUrlencode ( $s ) {
 155         $s = urlencode( $s );
 156         $s = preg_replace( '/%3[Aa]/', ':', $s );
 157         $s = preg_replace( '/%2[Ff]/', '/', $s );
 158
 159         return $s;
 160 }
 161
 162 /**
 163  * Sends a line to the debug log if enabled or, optionally, to a comment in output.
 164  * In normal operation this is a NOP.
 165  *
 166  * Controlling globals:
 167  * $wgDebugLogFile - points to the log file
 168  * $wgProfileOnly - if set, normal debug messages will not be recorded.
 169  * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
 170  * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
 171  *
 172  * @param $text String
 173  * @param $logonly Bool: set true to avoid appearing in HTML when $wgDebugComments is set
 174  */
 175 function wfDebug( $text, $logonly = false ) {
 176         global $wgOut, $wgDebugLogFile, $wgDebugComments, $wgProfileOnly, $wgDebugRawPage;
 177         static $recursion = 0;
 178
 179         static $cache = array(); // Cache of unoutputted messages
 180
 181         # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
 182         if ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' && !$wgDebugRawPage ) {
 183                 return;
 184         }
 185
 186         if ( $wgDebugComments && !$logonly ) {
 187                 $cache[] = $text;
 188
 189                 if ( !isset( $wgOut ) ) {
 190                         return;
 191                 }
 192                 if ( !StubObject::isRealObject( $wgOut ) ) {
 193                         if ( $recursion ) {
 194                                 return;
 195                         }
 196                         $recursion++;
 197                         $wgOut->_unstub();
 198                         $recursion--;
 199                 }
 200
 201                 // add the message and possible cached ones to the output
 202                 array_map( array( $wgOut, 'debug' ), $cache );
 203                 $cache = array();
 204         }
 205         if ( '' != $wgDebugLogFile && !$wgProfileOnly ) {
 206                 # Strip unprintables; they can switch terminal modes when binary data
 207                 # gets dumped, which is pretty annoying.
 208                 $text = preg_replace( '![\x00-\x08\x0b\x0c\x0e-\x1f]!', ' ', $text );
 209                 wfErrorLog( $text, $wgDebugLogFile );
 210         }
 211 }
 212
 213 /**
 214  * Send a line to a supplementary debug log file, if configured, or main debug log if not.
 215  * $wgDebugLogGroups[$logGroup] should be set to a filename to send to a separate log.
 216  *
 217  * @param $logGroup String
 218  * @param $text String
 219  * @param $public Bool: whether to log the event in the public log if no private
 220  *                     log file is specified, (default true)
 221  */
 222 function wfDebugLog( $logGroup, $text, $public = true ) {
 223         global $wgDebugLogGroups;
 224         if( $text{strlen( $text ) - 1} != "\n" ) $text .= "\n";
 225         if( isset( $wgDebugLogGroups[$logGroup] ) ) {
 226                 $time = wfTimestamp( TS_DB );
 227                 $wiki = wfWikiID();
 228                 wfErrorLog( "$time $wiki: $text", $wgDebugLogGroups[$logGroup] );
 229         } else if ( $public === true ) {
 230                 wfDebug( $text, true );
 231         }
 232 }
 233
 234 /**
 235  * Log for database errors
 236  * @param $text String: database error message.
 237  */
 238 function wfLogDBError( $text ) {
 239         global $wgDBerrorLog, $wgDBname;
 240         if ( $wgDBerrorLog ) {
 241                 $host = trim(`hostname`);
 242                 $text = date('D M j G:i:s T Y') . "\t$host\t$wgDBname\t$text";
 243                 wfErrorLog( $text, $wgDBerrorLog );
 244         }
 245 }
 246
 247 /**
 248  * Log to a file without getting "file size exceeded" signals
 249  */
 250 function wfErrorLog( $text, $file ) {
 251         wfSuppressWarnings();
 252         $exists = file_exists( $file );
 253         $size = $exists ? filesize( $file ) : false;
 254         if ( !$exists || ( $size !== false && $size + strlen( $text ) < 0x7fffffff ) ) {
 255                 error_log( $text, 3, $file );
 256         }
 257         wfRestoreWarnings();
 258 }
 259
 260 /**
 261  * @todo document
 262  */
 263 function wfLogProfilingData() {
 264         global $wgRequestTime, $wgDebugLogFile, $wgDebugRawPage, $wgRequest;
 265         global $wgProfiler, $wgUser;
 266         if ( !isset( $wgProfiler ) )
 267                 return;
 268
 269         $now = wfTime();
 270         $elapsed = $now - $wgRequestTime;
 271         $prof = wfGetProfilingOutput( $wgRequestTime, $elapsed );
 272         $forward = '';
 273         if( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) )
 274                 $forward = ' forwarded for ' . $_SERVER['HTTP_X_FORWARDED_FOR'];
 275         if( !empty( $_SERVER['HTTP_CLIENT_IP'] ) )
 276                 $forward .= ' client IP ' . $_SERVER['HTTP_CLIENT_IP'];
 277         if( !empty( $_SERVER['HTTP_FROM'] ) )
 278                 $forward .= ' from ' . $_SERVER['HTTP_FROM'];
 279         if( $forward )
 280                 $forward = "\t(proxied via {$_SERVER['REMOTE_ADDR']}{$forward})";
 281         // Don't unstub $wgUser at this late stage just for statistics purposes
 282         if( StubObject::isRealObject($wgUser) && $wgUser->isAnon() )
 283                 $forward .= ' anon';
 284         $log = sprintf( "%s\t%04.3f\t%s\n",
 285           gmdate( 'YmdHis' ), $elapsed,
 286           urldecode( $wgRequest->getRequestURL() . $forward ) );
 287         if ( '' != $wgDebugLogFile && ( $wgRequest->getVal('action') != 'raw' || $wgDebugRawPage ) ) {
 288                 wfErrorLog( $log . $prof, $wgDebugLogFile );
 289         }
 290 }
 291
 292 /**
 293  * Check if the wiki read-only lock file is present. This can be used to lock
 294  * off editing functions, but doesn't guarantee that the database will not be
 295  * modified.
 296  * @return bool
 297  */
 298 function wfReadOnly() {
 299         global $wgReadOnlyFile, $wgReadOnly;
 300
 301         if ( !is_null( $wgReadOnly ) ) {
 302                 return (bool)$wgReadOnly;
 303         }
 304         if ( '' == $wgReadOnlyFile ) {
 305                 return false;
 306         }
 307         // Set $wgReadOnly for faster access next time
 308         if ( is_file( $wgReadOnlyFile ) ) {
 309                 $wgReadOnly = file_get_contents( $wgReadOnlyFile );
 310         } else {
 311                 $wgReadOnly = false;
 312         }
 313         return (bool)$wgReadOnly;
 314 }
 315
 316 function wfReadOnlyReason() {
 317         global $wgReadOnly;
 318         wfReadOnly();
 319         return $wgReadOnly;
 320 }
 321
 322 /**
 323  * Get a message from anywhere, for the current user language.
 324  *
 325  * Use wfMsgForContent() instead if the message should NOT
 326  * change depending on the user preferences.
 327  *
 328  * @param $key String: lookup key for the message, usually
 329  *    defined in languages/Language.php
 330  *
 331  * This function also takes extra optional parameters (not
 332  * shown in the function definition), which can by used to
 333  * insert variable text into the predefined message.
 334  */
 335 function wfMsg( $key ) {
 336         $args = func_get_args();
 337         array_shift( $args );
 338         return wfMsgReal( $key, $args, true );
 339 }
 340
 341 /**
 342  * Same as above except doesn't transform the message
 343  */
 344 function wfMsgNoTrans( $key ) {
 345         $args = func_get_args();
 346         array_shift( $args );
 347         return wfMsgReal( $key, $args, true, false, false );
 348 }
 349
 350 /**
 351  * Get a message from anywhere, for the current global language
 352  * set with $wgLanguageCode.
 353  *
 354  * Use this if the message should NOT change  dependent on the
 355  * language set in the user's preferences. This is the case for
 356  * most text written into logs, as well as link targets (such as
 357  * the name of the copyright policy page). Link titles, on the
 358  * other hand, should be shown in the UI language.
 359  *
 360  * Note that MediaWiki allows users to change the user interface
 361  * language in their preferences, but a single installation
 362  * typically only contains content in one language.
 363  *
 364  * Be wary of this distinction: If you use wfMsg() where you should
 365  * use wfMsgForContent(), a user of the software may have to
 366  * customize over 70 messages in order to, e.g., fix a link in every
 367  * possible language.
 368  *
 369  * @param $key String: lookup key for the message, usually
 370  *    defined in languages/Language.php
 371  */
 372 function wfMsgForContent( $key ) {
 373         global $wgForceUIMsgAsContentMsg;
 374         $args = func_get_args();
 375         array_shift( $args );
 376         $forcontent = true;
 377         if( is_array( $wgForceUIMsgAsContentMsg ) &&
 378                 in_array( $key, $wgForceUIMsgAsContentMsg ) )
 379                 $forcontent = false;
 380         return wfMsgReal( $key, $args, true, $forcontent );
 381 }
 382
 383 /**
 384  * Same as above except doesn't transform the message
 385  */
 386 function wfMsgForContentNoTrans( $key ) {
 387         global $wgForceUIMsgAsContentMsg;
 388         $args = func_get_args();
 389         array_shift( $args );
 390         $forcontent = true;
 391         if( is_array( $wgForceUIMsgAsContentMsg ) &&
 392                 in_array( $key, $wgForceUIMsgAsContentMsg ) )
 393                 $forcontent = false;
 394         return wfMsgReal( $key, $args, true, $forcontent, false );
 395 }
 396
 397 /**
 398  * Get a message from the language file, for the UI elements
 399  */
 400 function wfMsgNoDB( $key ) {
 401         $args = func_get_args();
 402         array_shift( $args );
 403         return wfMsgReal( $key, $args, false );
 404 }
 405
 406 /**
 407  * Get a message from the language file, for the content
 408  */
 409 function wfMsgNoDBForContent( $key ) {
 410         global $wgForceUIMsgAsContentMsg;
 411         $args = func_get_args();
 412         array_shift( $args );
 413         $forcontent = true;
 414         if( is_array( $wgForceUIMsgAsContentMsg ) &&
 415                 in_array( $key, $wgForceUIMsgAsContentMsg ) )
 416                 $forcontent = false;
 417         return wfMsgReal( $key, $args, false, $forcontent );
 418 }
 419
 420
 421 /**
 422  * Really get a message
 423  * @param $key String: key to get.
 424  * @param $args
 425  * @param $useDB Boolean
 426  * @param $transform Boolean: Whether or not to transform the message.
 427  * @param $forContent Boolean
 428  * @return String: the requested message.
 429  */
 430 function wfMsgReal( $key, $args, $useDB = true, $forContent=false, $transform = true ) {
 431         wfProfileIn( __METHOD__ );
 432         $message = wfMsgGetKey( $key, $useDB, $forContent, $transform );
 433         $message = wfMsgReplaceArgs( $message, $args );
 434         wfProfileOut( __METHOD__ );
 435         return $message;
 436 }
 437
 438 /**
 439  * This function provides the message source for messages to be edited which are *not* stored in the database.
 440  * @param $key String:
 441  */
 442 function wfMsgWeirdKey ( $key ) {
 443         $source = wfMsgGetKey( $key, false, true, false );
 444         if ( wfEmptyMsg( $key, $source ) )
 445                 return "";
 446         else
 447                 return $source;
 448 }
 449
 450 /**
 451  * Fetch a message string value, but don't replace any keys yet.
 452  * @param string $key
 453  * @param bool $useDB
 454  * @param string $langcode Code of the language to get the message for, or
 455  *                         behaves as a content language switch if it is a
 456  *                         boolean.
 457  * @return string
 458  * @private
 459  */
 460 function wfMsgGetKey( $key, $useDB, $langCode = false, $transform = true ) {
 461         global $wgParser, $wgContLang, $wgMessageCache, $wgLang;
 462
 463         wfRunHooks('NormalizeMessageKey', array(&$key, &$useDB, &$langCode, &$transform));
 464
 465         # If $wgMessageCache isn't initialised yet, try to return something sensible.
 466         if( is_object( $wgMessageCache ) ) {
 467                 $message = $wgMessageCache->get( $key, $useDB, $langCode );
 468                 if ( $transform ) {
 469                         $message = $wgMessageCache->transform( $message );
 470                 }
 471         } else {
 472                 if( $langCode === true ) {
 473                         $lang = &$wgContLang;
 474                 } elseif( $langCode === false ) {
 475                         $lang = &$wgLang;
 476                 } else {
 477                         $validCodes = array_keys( Language::getLanguageNames() );
 478                         if( in_array( $langCode, $validCodes ) ) {
 479                                 # $langcode corresponds to a valid language.
 480                                 $lang = Language::factory( $langCode );
 481                         } else {
 482                                 # $langcode is a string, but not a valid language code; use content language.
 483                                 $lang =& $wgContLang;
 484                                 wfDebug( 'Invalid language code passed to wfMsgGetKey, falling back to content language.' );
 485                         }
 486                 }
 487
 488                 # MessageCache::get() does this already, Language::getMessage() doesn't
 489                 # ISSUE: Should we try to handle "message/lang" here too?
 490                 $key = str_replace( ' ' , '_' , $wgContLang->lcfirst( $key ) );
 491
 492                 if( is_object( $lang ) ) {
 493                         $message = $lang->getMessage( $key );
 494                 } else {
 495                         $message = false;
 496                 }
 497         }
 498
 499         return $message;
 500 }
 501
 502 /**
 503  * Replace message parameter keys on the given formatted output.
 504  *
 505  * @param string $message
 506  * @param array $args
 507  * @return string
 508  * @private
 509  */
 510 function wfMsgReplaceArgs( $message, $args ) {
 511         # Fix windows line-endings
 512         # Some messages are split with explode("\n", $msg)
 513         $message = str_replace( "\r", '', $message );
 514
 515         // Replace arguments
 516         if ( count( $args ) ) {
 517                 if ( is_array( $args[0] ) ) {
 518                         $args = array_values( $args[0] );
 519                 }
 520                 $replacementKeys = array();
 521                 foreach( $args as $n => $param ) {
 522                         $replacementKeys['$' . ($n + 1)] = $param;
 523                 }
 524                 $message = strtr( $message, $replacementKeys );
 525         }
 526
 527         return $message;
 528 }
 529
 530 /**
 531  * Return an HTML-escaped version of a message.
 532  * Parameter replacements, if any, are done *after* the HTML-escaping,
 533  * so parameters may contain HTML (eg links or form controls). Be sure
 534  * to pre-escape them if you really do want plaintext, or just wrap
 535  * the whole thing in htmlspecialchars().
 536  *
 537  * @param string $key
 538  * @param string ... parameters
 539  * @return string
 540  */
 541 function wfMsgHtml( $key ) {
 542         $args = func_get_args();
 543         array_shift( $args );
 544         return wfMsgReplaceArgs( htmlspecialchars( wfMsgGetKey( $key, true ) ), $args );
 545 }
 546
 547 /**
 548  * Return an HTML version of message
 549  * Parameter replacements, if any, are done *after* parsing the wiki-text message,
 550  * so parameters may contain HTML (eg links or form controls). Be sure
 551  * to pre-escape them if you really do want plaintext, or just wrap
 552  * the whole thing in htmlspecialchars().
 553  *
 554  * @param string $key
 555  * @param string ... parameters
 556  * @return string
 557  */
 558 function wfMsgWikiHtml( $key ) {
 559         global $wgOut;
 560         $args = func_get_args();
 561         array_shift( $args );
 562         return wfMsgReplaceArgs( $wgOut->parse( wfMsgGetKey( $key, true ), /* can't be set to false */ true ), $args );
 563 }
 564
 565 /**
 566  * Returns message in the requested format
 567  * @param string $key Key of the message
 568  * @param array $options Processing rules:
 569  *  <i>parse</i>: parses wikitext to html
 570  *  <i>parseinline</i>: parses wikitext to html and removes the surrounding p's added by parser or tidy
 571  *  <i>escape</i>: filters message through htmlspecialchars
 572  *  <i>escapenoentities</i>: same, but allows entity references like &nbsp; through
 573  *  <i>replaceafter</i>: parameters are substituted after parsing or escaping
 574  *  <i>parsemag</i>: transform the message using magic phrases
 575  *  <i>content</i>: fetch message for content language instead of interface
 576  *  <i>language</i>: language code to fetch message for (overriden by <i>content</i>), its behaviour
 577  *                   with parser, parseinline and parsemag is undefined.
 578  * Behavior for conflicting options (e.g., parse+parseinline) is undefined.
 579  */
 580 function wfMsgExt( $key, $options ) {
 581         global $wgOut, $wgParser;
 582
 583         $args = func_get_args();
 584         array_shift( $args );
 585         array_shift( $args );
 586
 587         if( !is_array($options) ) {
 588                 $options = array($options);
 589         }
 590
 591         if( in_array('content', $options) ) {
 592                 $forContent = true;
 593                 $langCode = true;
 594         } elseif( array_key_exists('language', $options) ) {
 595                 $forContent = false;
 596                 $langCode = $options['language'];
 597                 $validCodes = array_keys( Language::getLanguageNames() );
 598                 if( !in_array($options['language'], $validCodes) ) {
 599                         # Fallback to en, instead of whatever interface language we might have
 600                         $langCode = 'en';
 601                 }
 602         } else {
 603                 $forContent = false;
 604                 $langCode = false;
 605         }
 606
 607         $string = wfMsgGetKey( $key, /*DB*/true, $langCode, /*Transform*/false );
 608
 609         if( !in_array('replaceafter', $options) ) {
 610                 $string = wfMsgReplaceArgs( $string, $args );
 611         }
 612
 613         if( in_array('parse', $options) ) {
 614                 $string = $wgOut->parse( $string, true, !$forContent );
 615         } elseif ( in_array('parseinline', $options) ) {
 616                 $string = $wgOut->parse( $string, true, !$forContent );
 617                 $m = array();
 618                 if( preg_match( '/^<p>(.*)\n?<\/p>\n?$/sU', $string, $m ) ) {
 619                         $string = $m[1];
 620                 }
 621         } elseif ( in_array('parsemag', $options) ) {
 622                 global $wgMessageCache;
 623                 if ( isset( $wgMessageCache ) ) {
 624                         $string = $wgMessageCache->transform( $string, !$forContent );
 625                 }
 626         }
 627
 628         if ( in_array('escape', $options) ) {
 629                 $string = htmlspecialchars ( $string );
 630         } elseif ( in_array( 'escapenoentities', $options ) ) {
 631                 $string = htmlspecialchars( $string );
 632                 $string = str_replace( '&amp;', '&', $string );
 633                 $string = Sanitizer::normalizeCharReferences( $string );
 634         }
 635
 636         if( in_array('replaceafter', $options) ) {
 637                 $string = wfMsgReplaceArgs( $string, $args );
 638         }
 639
 640         return $string;
 641 }
 642
 643
 644 /**
 645  * Just like exit() but makes a note of it.
 646  * Commits open transactions except if the error parameter is set
 647  *
 648  * @deprecated Please return control to the caller or throw an exception
 649  */
 650 function wfAbruptExit( $error = false ){
 651         static $called = false;
 652         if ( $called ){
 653                 exit( -1 );
 654         }
 655         $called = true;
 656
 657         $bt = wfDebugBacktrace();
 658         if( $bt ) {
 659                 for($i = 0; $i < count($bt) ; $i++){
 660                         $file = isset($bt[$i]['file']) ? $bt[$i]['file'] : "unknown";
 661                         $line = isset($bt[$i]['line']) ? $bt[$i]['line'] : "unknown";
 662                         wfDebug("WARNING: Abrupt exit in $file at line $line\n");
 663                 }
 664         } else {
 665                 wfDebug('WARNING: Abrupt exit\n');
 666         }
 667
 668         wfLogProfilingData();
 669
 670         if ( !$error ) {
 671                 wfGetLB()->closeAll();
 672         }
 673         exit( -1 );
 674 }
 675
 676 /**
 677  * @deprecated Please return control the caller or throw an exception
 678  */
 679 function wfErrorExit() {
 680         wfAbruptExit( true );
 681 }
 682
 683 /**
 684  * Print a simple message and die, returning nonzero to the shell if any.
 685  * Plain die() fails to return nonzero to the shell if you pass a string.
 686  * @param string $msg
 687  */
 688 function wfDie( $msg='' ) {
 689         echo $msg;
 690         die( 1 );
 691 }
 692
 693 /**
 694  * Throw a debugging exception. This function previously once exited the process,
 695  * but now throws an exception instead, with similar results.
 696  *
 697  * @param string $msg Message shown when dieing.
 698  */
 699 function wfDebugDieBacktrace( $msg = '' ) {
 700         throw new MWException( $msg );
 701 }
 702
 703 /**
 704  * Fetch server name for use in error reporting etc.
 705  * Use real server name if available, so we know which machine
 706  * in a server farm generated the current page.
 707  * @return string
 708  */
 709 function wfHostname() {
 710         if ( function_exists( 'posix_uname' ) ) {
 711                 // This function not present on Windows
 712                 $uname = @posix_uname();
 713         } else {
 714                 $uname = false;
 715         }
 716         if( is_array( $uname ) && isset( $uname['nodename'] ) ) {
 717                 return $uname['nodename'];
 718         } else {
 719                 # This may be a virtual server.
 720                 return $_SERVER['SERVER_NAME'];
 721         }
 722 }
 723
 724         /**
 725          * Returns a HTML comment with the elapsed time since request.
 726          * This method has no side effects.
 727          * @return string
 728          */
 729         function wfReportTime() {
 730                 global $wgRequestTime, $wgShowHostnames;
 731
 732                 $now = wfTime();
 733                 $elapsed = $now - $wgRequestTime;
 734
 735                 return $wgShowHostnames
 736                         ? sprintf( "<!-- Served by %s in %01.3f secs. -->", wfHostname(), $elapsed )
 737                         : sprintf( "<!-- Served in %01.3f secs. -->", $elapsed );
 738         }
 739
 740 /**
 741  * Safety wrapper for debug_backtrace().
 742  *
 743  * With Zend Optimizer 3.2.0 loaded, this causes segfaults under somewhat
 744  * murky circumstances, which may be triggered in part by stub objects
 745  * or other fancy talkin'.
 746  *
 747  * Will return an empty array if Zend Optimizer is detected, otherwise
 748  * the output from debug_backtrace() (trimmed).
 749  *
 750  * @return array of backtrace information
 751  */
 752 function wfDebugBacktrace() {
 753         if( extension_loaded( 'Zend Optimizer' ) ) {
 754                 wfDebug( "Zend Optimizer detected; skipping debug_backtrace for safety.\n" );
 755                 return array();
 756         } else {
 757                 return array_slice( debug_backtrace(), 1 );
 758         }
 759 }
 760
 761 function wfBacktrace() {
 762         global $wgCommandLineMode;
 763
 764         if ( $wgCommandLineMode ) {
 765                 $msg = '';
 766         } else {
 767                 $msg = "<ul>\n";
 768         }
 769         $backtrace = wfDebugBacktrace();
 770         foreach( $backtrace as $call ) {
 771                 if( isset( $call['file'] ) ) {
 772                         $f = explode( DIRECTORY_SEPARATOR, $call['file'] );
 773                         $file = $f[count($f)-1];
 774                 } else {
 775                         $file = '-';
 776                 }
 777                 if( isset( $call['line'] ) ) {
 778                         $line = $call['line'];
 779                 } else {
 780                         $line = '-';
 781                 }
 782                 if ( $wgCommandLineMode ) {
 783                         $msg .= "$file line $line calls ";
 784                 } else {
 785                         $msg .= '<li>' . $file . ' line ' . $line . ' calls ';
 786                 }
 787                 if( !empty( $call['class'] ) ) $msg .= $call['class'] . '::';
 788                 $msg .= $call['function'] . '()';
 789
 790                 if ( $wgCommandLineMode ) {
 791                         $msg .= "\n";
 792                 } else {
 793                         $msg .= "</li>\n";
 794                 }
 795         }
 796         if ( $wgCommandLineMode ) {
 797                 $msg .= "\n";
 798         } else {
 799                 $msg .= "</ul>\n";
 800         }
 801
 802         return $msg;
 803 }
 804
 805
 806 /* Some generic result counters, pulled out of SearchEngine */
 807
 808
 809 /**
 810  * @todo document
 811  */
 812 function wfShowingResults( $offset, $limit ) {
 813         global $wgLang;
 814         return wfMsgExt( 'showingresults', array( 'parseinline' ), $wgLang->formatNum( $limit ), $wgLang->formatNum( $offset+1 ) );
 815 }
 816
 817 /**
 818  * @todo document
 819  */
 820 function wfShowingResultsNum( $offset, $limit, $num ) {
 821         global $wgLang;
 822         return wfMsgExt( 'showingresultsnum', array( 'parseinline' ), $wgLang->formatNum( $limit ), $wgLang->formatNum( $offset+1 ), $wgLang->formatNum( $num ) );
 823 }
 824
 825 /**
 826  * @todo document
 827  */
 828 function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) {
 829         global $wgLang;
 830         $fmtLimit = $wgLang->formatNum( $limit );
 831         $prev = wfMsg( 'prevn', $fmtLimit );
 832         $next = wfMsg( 'nextn', $fmtLimit );
 833
 834         if( is_object( $link ) ) {
 835                 $title =& $link;
 836         } else {
 837                 $title = Title::newFromText( $link );
 838                 if( is_null( $title ) ) {
 839                         return false;
 840                 }
 841         }
 842
 843         if ( 0 != $offset ) {
 844                 $po = $offset - $limit;
 845                 if ( $po < 0 ) { $po = 0; }
 846                 $q = "limit={$limit}&offset={$po}";
 847                 if ( '' != $query ) { $q .= '&'.$query; }
 848                 $plink = '<a href="' . $title->escapeLocalUrl( $q ) . "\" class=\"mw-prevlink\">{$prev}</a>";
 849         } else { $plink = $prev; }
 850
 851         $no = $offset + $limit;
 852         $q = 'limit='.$limit.'&offset='.$no;
 853         if ( '' != $query ) { $q .= '&'.$query; }
 854
 855         if ( $atend ) {
 856                 $nlink = $next;
 857         } else {
 858                 $nlink = '<a href="' . $title->escapeLocalUrl( $q ) . "\" class=\"mw-nextlink\">{$next}</a>";
 859         }
 860         $nums = wfNumLink( $offset, 20, $title, $query ) . ' | ' .
 861           wfNumLink( $offset, 50, $title, $query ) . ' | ' .
 862           wfNumLink( $offset, 100, $title, $query ) . ' | ' .
 863           wfNumLink( $offset, 250, $title, $query ) . ' | ' .
 864           wfNumLink( $offset, 500, $title, $query );
 865
 866         return wfMsg( 'viewprevnext', $plink, $nlink, $nums );
 867 }
 868
 869 /**
 870  * @todo document
 871  */
 872 function wfNumLink( $offset, $limit, &$title, $query = '' ) {
 873         global $wgLang;
 874         if ( '' == $query ) { $q = ''; }
 875         else { $q = $query.'&'; }
 876         $q .= 'limit='.$limit.'&offset='.$offset;
 877
 878         $fmtLimit = $wgLang->formatNum( $limit );
 879         $s = '<a href="' . $title->escapeLocalUrl( $q ) . "\" class=\"mw-numlink\">{$fmtLimit}</a>";
 880         return $s;
 881 }
 882
 883 /**
 884  * @todo document
 885  * @todo FIXME: we may want to blacklist some broken browsers
 886  *
 887  * @return bool Whereas client accept gzip compression
 888  */
 889 function wfClientAcceptsGzip() {
 890         global $wgUseGzip;
 891         if( $wgUseGzip ) {
 892                 # FIXME: we may want to blacklist some broken browsers
 893                 $m = array();
 894                 if( preg_match(
 895                         '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
 896                         $_SERVER['HTTP_ACCEPT_ENCODING'],
 897                         $m ) ) {
 898                         if( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) return false;
 899                         wfDebug( " accepts gzip\n" );
 900                         return true;
 901                 }
 902         }
 903         return false;
 904 }
 905
 906 /**
 907  * Obtain the offset and limit values from the request string;
 908  * used in special pages
 909  *
 910  * @param $deflimit Default limit if none supplied
 911  * @param $optionname Name of a user preference to check against
 912  * @return array
 913  *
 914  */
 915 function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
 916         global $wgRequest;
 917         return $wgRequest->getLimitOffset( $deflimit, $optionname );
 918 }
 919
 920 /**
 921  * Escapes the given text so that it may be output using addWikiText()
 922  * without any linking, formatting, etc. making its way through. This
 923  * is achieved by substituting certain characters with HTML entities.
 924  * As required by the callers, <nowiki> is not used. It currently does
 925  * not filter out characters which have special meaning only at the
 926  * start of a line, such as "*".
 927  *
 928  * @param string $text Text to be escaped
 929  */
 930 function wfEscapeWikiText( $text ) {
 931         $text = str_replace(
 932                 array( '[',     '|',      ']',     '\'',    'ISBN ',     'RFC ',     '://',     "\n=",     '{{' ),
 933                 array( '&#91;', '&#124;', '&#93;', '&#39;', 'ISBN&#32;', 'RFC&#32;', '&#58;//', "\n&#61;", '&#123;&#123;' ),
 934                 htmlspecialchars($text) );
 935         return $text;
 936 }
 937
 938 /**
 939  * @todo document
 940  */
 941 function wfQuotedPrintable( $string, $charset = '' ) {
 942         # Probably incomplete; see RFC 2045
 943         if( empty( $charset ) ) {
 944                 global $wgInputEncoding;
 945                 $charset = $wgInputEncoding;
 946         }
 947         $charset = strtoupper( $charset );
 948         $charset = str_replace( 'ISO-8859', 'ISO8859', $charset ); // ?
 949
 950         $illegal = '\x00-\x08\x0b\x0c\x0e-\x1f\x7f-\xff=';
 951         $replace = $illegal . '\t ?_';
 952         if( !preg_match( "/[$illegal]/", $string ) ) return $string;
 953         $out = "=?$charset?Q?";
 954         $out .= preg_replace( "/([$replace])/e", 'sprintf("=%02X",ord("$1"))', $string );
 955         $out .= '?=';
 956         return $out;
 957 }
 958
 959
 960 /**
 961  * @todo document
 962  * @return float
 963  */
 964 function wfTime() {
 965         return microtime(true);
 966 }
 967
 968 /**
 969  * Sets dest to source and returns the original value of dest
 970  * If source is NULL, it just returns the value, it doesn't set the variable
 971  */
 972 function wfSetVar( &$dest, $source ) {
 973         $temp = $dest;
 974         if ( !is_null( $source ) ) {
 975                 $dest = $source;
 976         }
 977         return $temp;
 978 }
 979
 980 /**
 981  * As for wfSetVar except setting a bit
 982  */
 983 function wfSetBit( &$dest, $bit, $state = true ) {
 984         $temp = (bool)($dest & $bit );
 985         if ( !is_null( $state ) ) {
 986                 if ( $state ) {
 987                         $dest |= $bit;
 988                 } else {
 989                         $dest &= ~$bit;
 990                 }
 991         }
 992         return $temp;
 993 }
 994
 995 /**
 996  * This function takes two arrays as input, and returns a CGI-style string, e.g.
 997  * "days=7&limit=100". Options in the first array override options in the second.
 998  * Options set to "" will not be output.
 999  */
1000 function wfArrayToCGI( $array1, $array2 = NULL )
1001 {
1002         if ( !is_null( $array2 ) ) {
1003                 $array1 = $array1 + $array2;
1004         }
1005
1006         $cgi = '';
1007         foreach ( $array1 as $key => $value ) {
1008                 if ( '' !== $value ) {
1009                         if ( '' != $cgi ) {
1010                                 $cgi .= '&';
1011                         }
1012                         if(is_array($value))
1013                         {
1014                                 $firstTime = true;
1015                                 foreach($value as $v)
1016                                 {
1017                                         $cgi .= ($firstTime ? '' : '&') .
1018                                                 urlencode( $key . '[]' ) . '=' .
1019                                                 urlencode( $v );
1020                                         $firstTime = false;
1021                                 }
1022                         }
1023                         else
1024                                 $cgi .= urlencode( $key ) . '=' .
1025                                         urlencode( $value );
1026                 }
1027         }
1028         return $cgi;
1029 }
1030
1031 /**
1032  * Append a query string to an existing URL, which may or may not already
1033  * have query string parameters already. If so, they will be combined.
1034  *
1035  * @param string $url
1036  * @param string $query
1037  * @return string
1038  */
1039 function wfAppendQuery( $url, $query ) {
1040         if( $query != '' ) {
1041                 if( false === strpos( $url, '?' ) ) {
1042                         $url .= '?';
1043                 } else {
1044                         $url .= '&';
1045                 }
1046                 $url .= $query;
1047         }
1048         return $url;
1049 }
1050
1051 /**
1052  * Expand a potentially local URL to a fully-qualified URL.
1053  * Assumes $wgServer is correct. :)
1054  * @param string $url, either fully-qualified or a local path + query
1055  * @return string Fully-qualified URL
1056  */
1057 function wfExpandUrl( $url ) {
1058         if( substr( $url, 0, 1 ) == '/' ) {
1059                 global $wgServer;
1060                 return $wgServer . $url;
1061         } else {
1062                 return $url;
1063         }
1064 }
1065
1066 /**
1067  * This is obsolete, use SquidUpdate::purge()
1068  * @deprecated
1069  */
1070 function wfPurgeSquidServers ($urlArr) {
1071         SquidUpdate::purge( $urlArr );
1072 }
1073
1074 /**
1075  * Windows-compatible version of escapeshellarg()
1076  * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
1077  * function puts single quotes in regardless of OS
1078  */
1079 function wfEscapeShellArg( ) {
1080         $args = func_get_args();
1081         $first = true;
1082         $retVal = '';
1083         foreach ( $args as $arg ) {
1084                 if ( !$first ) {
1085                         $retVal .= ' ';
1086                 } else {
1087                         $first = false;
1088                 }
1089
1090                 if ( wfIsWindows() ) {
1091                         // Escaping for an MSVC-style command line parser
1092                         // Ref: http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
1093                         // Double the backslashes before any double quotes. Escape the double quotes.
1094                         $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE );
1095                         $arg = '';
1096                         $delim = false;
1097                         foreach ( $tokens as $token ) {
1098                                 if ( $delim ) {
1099                                         $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
1100                                 } else {
1101                                         $arg .= $token;
1102                                 }
1103                                 $delim = !$delim;
1104                         }
1105                         // Double the backslashes before the end of the string, because
1106                         // we will soon add a quote
1107                         $m = array();
1108                         if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
1109                                 $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
1110                         }
1111
1112                         // Add surrounding quotes
1113                         $retVal .= '"' . $arg . '"';
1114                 } else {
1115                         $retVal .= escapeshellarg( $arg );
1116                 }
1117         }
1118         return $retVal;
1119 }
1120
1121 /**
1122  * wfMerge attempts to merge differences between three texts.
1123  * Returns true for a clean merge and false for failure or a conflict.
1124  */
1125 function wfMerge( $old, $mine, $yours, &$result ){
1126         global $wgDiff3;
1127
1128         # This check may also protect against code injection in
1129         # case of broken installations.
1130         if(! file_exists( $wgDiff3 ) ){
1131                 wfDebug( "diff3 not found\n" );
1132                 return false;
1133         }
1134
1135         # Make temporary files
1136         $td = wfTempDir();
1137         $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
1138         $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
1139         $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
1140
1141         fwrite( $oldtextFile, $old ); fclose( $oldtextFile );
1142         fwrite( $mytextFile, $mine ); fclose( $mytextFile );
1143         fwrite( $yourtextFile, $yours ); fclose( $yourtextFile );
1144
1145         # Check for a conflict
1146         $cmd = $wgDiff3 . ' -a --overlap-only ' .
1147           wfEscapeShellArg( $mytextName ) . ' ' .
1148           wfEscapeShellArg( $oldtextName ) . ' ' .
1149           wfEscapeShellArg( $yourtextName );
1150         $handle = popen( $cmd, 'r' );
1151
1152         if( fgets( $handle, 1024 ) ){
1153                 $conflict = true;
1154         } else {
1155                 $conflict = false;
1156         }
1157         pclose( $handle );
1158
1159         # Merge differences
1160         $cmd = $wgDiff3 . ' -a -e --merge ' .
1161           wfEscapeShellArg( $mytextName, $oldtextName, $yourtextName );
1162         $handle = popen( $cmd, 'r' );
1163         $result = '';
1164         do {
1165                 $data = fread( $handle, 8192 );
1166                 if ( strlen( $data ) == 0 ) {
1167                         break;
1168                 }
1169                 $result .= $data;
1170         } while ( true );
1171         pclose( $handle );
1172         unlink( $mytextName ); unlink( $oldtextName ); unlink( $yourtextName );
1173
1174         if ( $result === '' && $old !== '' && $conflict == false ) {
1175                 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
1176                 $conflict = true;
1177         }
1178         return ! $conflict;
1179 }
1180
1181 /**
1182  * @todo document
1183  */
1184 function wfVarDump( $var ) {
1185         global $wgOut;
1186         $s = str_replace("\n","<br />\n", var_export( $var, true ) . "\n");
1187         if ( headers_sent() || !@is_object( $wgOut ) ) {
1188                 print $s;
1189         } else {
1190                 $wgOut->addHTML( $s );
1191         }
1192 }
1193
1194 /**
1195  * Provide a simple HTTP error.
1196  */
1197 function wfHttpError( $code, $label, $desc ) {
1198         global $wgOut;
1199         $wgOut->disable();
1200         header( "HTTP/1.0 $code $label" );
1201         header( "Status: $code $label" );
1202         $wgOut->sendCacheControl();
1203
1204         header( 'Content-type: text/html; charset=utf-8' );
1205         print "<!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML 2.0//EN\">".
1206                 "<html><head><title>" .
1207                 htmlspecialchars( $label ) .
1208                 "</title></head><body><h1>" .
1209                 htmlspecialchars( $label ) .
1210                 "</h1><p>" .
1211                 nl2br( htmlspecialchars( $desc ) ) .
1212                 "</p></body></html>\n";
1213 }
1214
1215 /**
1216  * Clear away any user-level output buffers, discarding contents.
1217  *
1218  * Suitable for 'starting afresh', for instance when streaming
1219  * relatively large amounts of data without buffering, or wanting to
1220  * output image files without ob_gzhandler's compression.
1221  *
1222  * The optional $resetGzipEncoding parameter controls suppression of
1223  * the Content-Encoding header sent by ob_gzhandler; by default it
1224  * is left. See comments for wfClearOutputBuffers() for why it would
1225  * be used.
1226  *
1227  * Note that some PHP configuration options may add output buffer
1228  * layers which cannot be removed; these are left in place.
1229  *
1230  * @param bool $resetGzipEncoding
1231  */
1232 function wfResetOutputBuffers( $resetGzipEncoding=true ) {
1233         if( $resetGzipEncoding ) {
1234                 // Suppress Content-Encoding and Content-Length
1235                 // headers from 1.10+s wfOutputHandler
1236                 global $wgDisableOutputCompression;
1237                 $wgDisableOutputCompression = true;
1238         }
1239         while( $status = ob_get_status() ) {
1240                 if( $status['type'] == 0 /* PHP_OUTPUT_HANDLER_INTERNAL */ ) {
1241                         // Probably from zlib.output_compression or other
1242                         // PHP-internal setting which can't be removed.
1243                         //
1244                         // Give up, and hope the result doesn't break
1245                         // output behavior.
1246                         break;
1247                 }
1248                 if( !ob_end_clean() ) {
1249                         // Could not remove output buffer handler; abort now
1250                         // to avoid getting in some kind of infinite loop.
1251                         break;
1252                 }
1253                 if( $resetGzipEncoding ) {
1254                         if( $status['name'] == 'ob_gzhandler' ) {
1255                                 // Reset the 'Content-Encoding' field set by this handler
1256                                 // so we can start fresh.
1257                                 header( 'Content-Encoding:' );
1258                         }
1259                 }
1260         }
1261 }
1262
1263 /**
1264  * More legible than passing a 'false' parameter to wfResetOutputBuffers():
1265  *
1266  * Clear away output buffers, but keep the Content-Encoding header
1267  * produced by ob_gzhandler, if any.
1268  *
1269  * This should be used for HTTP 304 responses, where you need to
1270  * preserve the Content-Encoding header of the real result, but
1271  * also need to suppress the output of ob_gzhandler to keep to spec
1272  * and avoid breaking Firefox in rare cases where the headers and
1273  * body are broken over two packets.
1274  */
1275 function wfClearOutputBuffers() {
1276         wfResetOutputBuffers( false );
1277 }
1278
1279 /**
1280  * Converts an Accept-* header into an array mapping string values to quality
1281  * factors
1282  */
1283 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
1284         # No arg means accept anything (per HTTP spec)
1285         if( !$accept ) {
1286                 return array( $def => 1.0 );
1287         }
1288
1289         $prefs = array();
1290
1291         $parts = explode( ',', $accept );
1292
1293         foreach( $parts as $part ) {
1294                 # FIXME: doesn't deal with params like 'text/html; level=1'
1295                 @list( $value, $qpart ) = explode( ';', trim( $part ) );
1296                 $match = array();
1297                 if( !isset( $qpart ) ) {
1298                         $prefs[$value] = 1.0;
1299                 } elseif( preg_match( '/q\s*=\s*(\d*\.\d+)/', $qpart, $match ) ) {
1300                         $prefs[$value] = floatval($match[1]);
1301                 }
1302         }
1303
1304         return $prefs;
1305 }
1306
1307 /**
1308  * Checks if a given MIME type matches any of the keys in the given
1309  * array. Basic wildcards are accepted in the array keys.
1310  *
1311  * Returns the matching MIME type (or wildcard) if a match, otherwise
1312  * NULL if no match.
1313  *
1314  * @param string $type
1315  * @param array $avail
1316  * @return string
1317  * @private
1318  */
1319 function mimeTypeMatch( $type, $avail ) {
1320         if( array_key_exists($type, $avail) ) {
1321                 return $type;
1322         } else {
1323                 $parts = explode( '/', $type );
1324                 if( array_key_exists( $parts[0] . '/*', $avail ) ) {
1325                         return $parts[0] . '/*';
1326                 } elseif( array_key_exists( '*/*', $avail ) ) {
1327                         return '*/*';
1328                 } else {
1329                         return NULL;
1330                 }
1331         }
1332 }
1333
1334 /**
1335  * Returns the 'best' match between a client's requested internet media types
1336  * and the server's list of available types. Each list should be an associative
1337  * array of type to preference (preference is a float between 0.0 and 1.0).
1338  * Wildcards in the types are acceptable.
1339  *
1340  * @param array $cprefs Client's acceptable type list
1341  * @param array $sprefs Server's offered types
1342  * @return string
1343  *
1344  * @todo FIXME: doesn't handle params like 'text/plain; charset=UTF-8'
1345  * XXX: generalize to negotiate other stuff
1346  */
1347 function wfNegotiateType( $cprefs, $sprefs ) {
1348         $combine = array();
1349
1350         foreach( array_keys($sprefs) as $type ) {
1351                 $parts = explode( '/', $type );
1352                 if( $parts[1] != '*' ) {
1353                         $ckey = mimeTypeMatch( $type, $cprefs );
1354                         if( $ckey ) {
1355                                 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1356                         }
1357                 }
1358         }
1359
1360         foreach( array_keys( $cprefs ) as $type ) {
1361                 $parts = explode( '/', $type );
1362                 if( $parts[1] != '*' && !array_key_exists( $type, $sprefs ) ) {
1363                         $skey = mimeTypeMatch( $type, $sprefs );
1364                         if( $skey ) {
1365                                 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1366                         }
1367                 }
1368         }
1369
1370         $bestq = 0;
1371         $besttype = NULL;
1372
1373         foreach( array_keys( $combine ) as $type ) {
1374                 if( $combine[$type] > $bestq ) {
1375                         $besttype = $type;
1376                         $bestq = $combine[$type];
1377                 }
1378         }
1379
1380         return $besttype;
1381 }
1382
1383 /**
1384  * Array lookup
1385  * Returns an array where the values in the first array are replaced by the
1386  * values in the second array with the corresponding keys
1387  *
1388  * @return array
1389  */
1390 function wfArrayLookup( $a, $b ) {
1391         return array_flip( array_intersect( array_flip( $a ), array_keys( $b ) ) );
1392 }
1393
1394 /**
1395  * Convenience function; returns MediaWiki timestamp for the present time.
1396  * @return string
1397  */
1398 function wfTimestampNow() {
1399         # return NOW
1400         return wfTimestamp( TS_MW, time() );
1401 }
1402
1403 /**
1404  * Reference-counted warning suppression
1405  */
1406 function wfSuppressWarnings( $end = false ) {
1407         static $suppressCount = 0;
1408         static $originalLevel = false;
1409
1410         if ( $end ) {
1411                 if ( $suppressCount ) {
1412                         --$suppressCount;
1413                         if ( !$suppressCount ) {
1414                                 error_reporting( $originalLevel );
1415                         }
1416                 }
1417         } else {
1418                 if ( !$suppressCount ) {
1419                         $originalLevel = error_reporting( E_ALL & ~( E_WARNING | E_NOTICE ) );
1420                 }
1421                 ++$suppressCount;
1422         }
1423 }
1424
1425 /**
1426  * Restore error level to previous value
1427  */
1428 function wfRestoreWarnings() {
1429         wfSuppressWarnings( true );
1430 }
1431
1432 # Autodetect, convert and provide timestamps of various types
1433
1434 /**
1435  * Unix time - the number of seconds since 1970-01-01 00:00:00 UTC
1436  */
1437 define('TS_UNIX', 0);
1438
1439 /**
1440  * MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
1441  */
1442 define('TS_MW', 1);
1443
1444 /**
1445  * MySQL DATETIME (YYYY-MM-DD HH:MM:SS)
1446  */
1447 define('TS_DB', 2);
1448
1449 /**
1450  * RFC 2822 format, for E-mail and HTTP headers
1451  */
1452 define('TS_RFC2822', 3);
1453
1454 /**
1455  * ISO 8601 format with no timezone: 1986-02-09T20:00:00Z
1456  *
1457  * This is used by Special:Export
1458  */
1459 define('TS_ISO_8601', 4);
1460
1461 /**
1462  * An Exif timestamp (YYYY:MM:DD HH:MM:SS)
1463  *
1464  * @see http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the
1465  *       DateTime tag and page 36 for the DateTimeOriginal and
1466  *       DateTimeDigitized tags.
1467  */
1468 define('TS_EXIF', 5);
1469
1470 /**
1471  * Oracle format time.
1472  */
1473 define('TS_ORACLE', 6);
1474
1475 /**
1476  * Postgres format time.
1477  */
1478 define('TS_POSTGRES', 7);
1479
1480 /**
1481  * @param mixed $outputtype A timestamp in one of the supported formats, the
1482  *                          function will autodetect which format is supplied
1483  *                          and act accordingly.
1484  * @return string Time in the format specified in $outputtype
1485  */
1486 function wfTimestamp($outputtype=TS_UNIX,$ts=0) {
1487         $uts = 0;
1488         $da = array();
1489         if ($ts==0) {
1490                 $uts=time();
1491         } elseif (preg_match('/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)$/D',$ts,$da)) {
1492                 # TS_DB
1493         } elseif (preg_match('/^(\d{4}):(\d\d):(\d\d) (\d\d):(\d\d):(\d\d)$/D',$ts,$da)) {
1494                 # TS_EXIF
1495         } elseif (preg_match('/^(\d{4})(\d\d)(\d\d)(\d\d)(\d\d)(\d\d)$/D',$ts,$da)) {
1496                 # TS_MW
1497         } elseif (preg_match('/^\d{1,13}$/D',$ts)) {
1498                 # TS_UNIX
1499                 $uts = $ts;
1500         } elseif (preg_match('/^\d{1,2}-...-\d\d(?:\d\d)? \d\d\.\d\d\.\d\d/', $ts)) {
1501                 # TS_ORACLE
1502                 $uts = strtotime(preg_replace('/(\d\d)\.(\d\d)\.(\d\d)(\.(\d+))?/', "$1:$2:$3",
1503                                 str_replace("+00:00", "UTC", $ts)));
1504         } elseif (preg_match('/^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})Z$/', $ts, $da)) {
1505                 # TS_ISO_8601
1506         } elseif (preg_match('/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)[\+\- ](\d\d)$/',$ts,$da)) {
1507                 # TS_POSTGRES
1508         } elseif (preg_match('/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d) GMT$/',$ts,$da)) {
1509                 # TS_POSTGRES
1510         } else {
1511                 # Bogus value; fall back to the epoch...
1512                 wfDebug("wfTimestamp() fed bogus time value: $outputtype; $ts\n");
1513                 $uts = 0;
1514         }
1515
1516         if (count( $da ) ) {
1517                 // Warning! gmmktime() acts oddly if the month or day is set to 0
1518                 // We may want to handle that explicitly at some point
1519                 $uts=gmmktime((int)$da[4],(int)$da[5],(int)$da[6],
1520                         (int)$da[2],(int)$da[3],(int)$da[1]);
1521         }
1522
1523         switch($outputtype) {
1524                 case TS_UNIX:
1525                         return $uts;
1526                 case TS_MW:
1527                         return gmdate( 'YmdHis', $uts );
1528                 case TS_DB:
1529                         return gmdate( 'Y-m-d H:i:s', $uts );
1530                 case TS_ISO_8601:
1531                         return gmdate( 'Y-m-d\TH:i:s\Z', $uts );
1532                 // This shouldn't ever be used, but is included for completeness
1533                 case TS_EXIF:
1534                         return gmdate(  'Y:m:d H:i:s', $uts );
1535                 case TS_RFC2822:
1536                         return gmdate( 'D, d M Y H:i:s', $uts ) . ' GMT';
1537                 case TS_ORACLE:
1538                         return gmdate( 'd-M-y h.i.s A', $uts) . ' +00:00';
1539                 case TS_POSTGRES:
1540                         return gmdate( 'Y-m-d H:i:s', $uts) . ' GMT';
1541                 default:
1542                         throw new MWException( 'wfTimestamp() called with illegal output type.');
1543         }
1544 }
1545
1546 /**
1547  * Return a formatted timestamp, or null if input is null.
1548  * For dealing with nullable timestamp columns in the database.
1549  * @param int $outputtype
1550  * @param string $ts
1551  * @return string
1552  */
1553 function wfTimestampOrNull( $outputtype = TS_UNIX, $ts = null ) {
1554         if( is_null( $ts ) ) {
1555                 return null;
1556         } else {
1557                 return wfTimestamp( $outputtype, $ts );
1558         }
1559 }
1560
1561 /**
1562  * Check if the operating system is Windows
1563  *
1564  * @return bool True if it's Windows, False otherwise.
1565  */
1566 function wfIsWindows() {
1567         if (substr(php_uname(), 0, 7) == 'Windows') {
1568                 return true;
1569         } else {
1570                 return false;
1571         }
1572 }
1573
1574 /**
1575  * Swap two variables
1576  */
1577 function swap( &$x, &$y ) {
1578         $z = $x;
1579         $x = $y;
1580         $y = $z;
1581 }
1582
1583 function wfGetCachedNotice( $name ) {
1584         global $wgOut, $parserMemc;
1585         $fname = 'wfGetCachedNotice';
1586         wfProfileIn( $fname );
1587
1588         $needParse = false;
1589
1590         if( $name === 'default' ) {
1591                 // special case
1592                 global $wgSiteNotice;
1593                 $notice = $wgSiteNotice;
1594                 if( empty( $notice ) ) {
1595                         wfProfileOut( $fname );
1596                         return false;
1597                 }
1598         } else {
1599                 $notice = wfMsgForContentNoTrans( $name );
1600                 if( wfEmptyMsg( $name, $notice ) || $notice == '-' ) {
1601                         wfProfileOut( $fname );
1602                         return( false );
1603                 }
1604         }
1605
1606         $cachedNotice = $parserMemc->get( wfMemcKey( $name ) );
1607         if( is_array( $cachedNotice ) ) {
1608                 if( md5( $notice ) == $cachedNotice['hash'] ) {
1609                         $notice = $cachedNotice['html'];
1610                 } else {
1611                         $needParse = true;
1612                 }
1613         } else {
1614                 $needParse = true;
1615         }
1616
1617         if( $needParse ) {
1618                 if( is_object( $wgOut ) ) {
1619                         $parsed = $wgOut->parse( $notice );
1620                         $parserMemc->set( wfMemcKey( $name ), array( 'html' => $parsed, 'hash' => md5( $notice ) ), 600 );
1621                         $notice = $parsed;
1622                 } else {
1623                         wfDebug( 'wfGetCachedNotice called for ' . $name . ' with no $wgOut available' );
1624                         $notice = '';
1625                 }
1626         }
1627
1628         wfProfileOut( $fname );
1629         return $notice;
1630 }
1631
1632 function wfGetNamespaceNotice() {
1633         global $wgTitle;
1634
1635         # Paranoia
1636         if ( !isset( $wgTitle ) || !is_object( $wgTitle ) )
1637                 return "";
1638
1639         $fname = 'wfGetNamespaceNotice';
1640         wfProfileIn( $fname );
1641
1642         $key = "namespacenotice-" . $wgTitle->getNsText();
1643         $namespaceNotice = wfGetCachedNotice( $key );
1644         if ( $namespaceNotice && substr ( $namespaceNotice , 0 ,7 ) != "<p>&lt;" ) {
1645                  $namespaceNotice = '<div id="namespacebanner">' . $namespaceNotice . "</div>";
1646         } else {
1647                 $namespaceNotice = "";
1648         }
1649
1650         wfProfileOut( $fname );
1651         return $namespaceNotice;
1652 }
1653
1654 function wfGetSiteNotice() {
1655         global $wgUser, $wgSiteNotice;
1656         $fname = 'wfGetSiteNotice';
1657         wfProfileIn( $fname );
1658         $siteNotice = '';
1659
1660         if( wfRunHooks( 'SiteNoticeBefore', array( &$siteNotice ) ) ) {
1661                 if( is_object( $wgUser ) && $wgUser->isLoggedIn() ) {
1662                         $siteNotice = wfGetCachedNotice( 'sitenotice' );
1663                 } else {
1664                         $anonNotice = wfGetCachedNotice( 'anonnotice' );
1665                         if( !$anonNotice ) {
1666                                 $siteNotice = wfGetCachedNotice( 'sitenotice' );
1667                         } else {
1668                                 $siteNotice = $anonNotice;
1669                         }
1670                 }
1671                 if( !$siteNotice ) {
1672                         $siteNotice = wfGetCachedNotice( 'default' );
1673                 }
1674         }
1675
1676         wfRunHooks( 'SiteNoticeAfter', array( &$siteNotice ) );
1677         wfProfileOut( $fname );
1678         return $siteNotice;
1679 }
1680
1681 /**
1682  * BC wrapper for MimeMagic::singleton()
1683  * @deprecated
1684  */
1685 function &wfGetMimeMagic() {
1686         return MimeMagic::singleton();
1687 }
1688
1689 /**
1690  * Tries to get the system directory for temporary files.
1691  * The TMPDIR, TMP, and TEMP environment variables are checked in sequence,
1692  * and if none are set /tmp is returned as the generic Unix default.
1693  *
1694  * NOTE: When possible, use the tempfile() function to create temporary
1695  * files to avoid race conditions on file creation, etc.
1696  *
1697  * @return string
1698  */
1699 function wfTempDir() {
1700         foreach( array( 'TMPDIR', 'TMP', 'TEMP' ) as $var ) {
1701                 $tmp = getenv( $var );
1702                 if( $tmp && file_exists( $tmp ) && is_dir( $tmp ) && is_writable( $tmp ) ) {
1703                         return $tmp;
1704                 }
1705         }
1706         # Hope this is Unix of some kind!
1707         return '/tmp';
1708 }
1709
1710 /**
1711  * Make directory, and make all parent directories if they don't exist
1712  */
1713 function wfMkdirParents( $fullDir, $mode = 0777 ) {
1714         if( strval( $fullDir ) === '' )
1715                 return true;
1716         if( file_exists( $fullDir ) )
1717                 return true;
1718
1719         # Go back through the paths to find the first directory that exists
1720         $currentDir = $fullDir;
1721         $createList = array();
1722         while ( strval( $currentDir ) !== '' && !file_exists( $currentDir ) ) {
1723                 # Strip trailing slashes
1724                 $currentDir = rtrim( $currentDir, '/\\' );
1725
1726                 # Add to create list
1727                 $createList[] = $currentDir;
1728
1729                 # Find next delimiter searching from the end
1730                 $p = max( strrpos( $currentDir, '/' ), strrpos( $currentDir, '\\' ) );
1731                 if ( $p === false ) {
1732                         $currentDir = false;
1733                 } else {
1734                         $currentDir = substr( $currentDir, 0, $p );
1735                 }
1736         }
1737
1738         if ( count( $createList ) == 0 ) {
1739                 # Directory specified already exists
1740                 return true;
1741         } elseif ( $currentDir === false ) {
1742                 # Went all the way back to root and it apparently doesn't exist
1743                 wfDebugLog( 'mkdir', "Root doesn't exist?\n" );
1744                 return false;
1745         }
1746         # Now go forward creating directories
1747         $createList = array_reverse( $createList );
1748
1749         # Is the parent directory writable?
1750         if ( $currentDir === '' ) {
1751                 $currentDir = '/';
1752         }
1753         if ( !is_writable( $currentDir ) ) {
1754                 wfDebugLog( 'mkdir', "Not writable: $currentDir\n" );
1755                 return false;
1756         }
1757
1758         foreach ( $createList as $dir ) {
1759                 # use chmod to override the umask, as suggested by the PHP manual
1760                 if ( !mkdir( $dir, $mode ) || !chmod( $dir, $mode ) ) {
1761                         wfDebugLog( 'mkdir', "Unable to create directory $dir\n" );
1762                         return false;
1763                 }
1764         }
1765         return true;
1766 }
1767
1768 /**
1769  * Increment a statistics counter
1770  */
1771 function wfIncrStats( $key ) {
1772         global $wgStatsMethod;
1773
1774         if( $wgStatsMethod == 'udp' ) {
1775                 global $wgUDPProfilerHost, $wgUDPProfilerPort, $wgDBname;
1776                 static $socket;
1777                 if (!$socket) {
1778                         $socket=socket_create(AF_INET, SOCK_DGRAM, SOL_UDP);
1779                         $statline="stats/{$wgDBname} - 1 1 1 1 1 -total\n";
1780                         socket_sendto($socket,$statline,strlen($statline),0,$wgUDPProfilerHost,$wgUDPProfilerPort);
1781                 }
1782                 $statline="stats/{$wgDBname} - 1 1 1 1 1 {$key}\n";
1783                 @socket_sendto($socket,$statline,strlen($statline),0,$wgUDPProfilerHost,$wgUDPProfilerPort);
1784         } elseif( $wgStatsMethod == 'cache' ) {
1785                 global $wgMemc;
1786                 $key = wfMemcKey( 'stats', $key );
1787                 if ( is_null( $wgMemc->incr( $key ) ) ) {
1788                         $wgMemc->add( $key, 1 );
1789                 }
1790         } else {
1791                 // Disabled
1792         }
1793 }
1794
1795 /**
1796  * @param mixed $nr The number to format
1797  * @param int $acc The number of digits after the decimal point, default 2
1798  * @param bool $round Whether or not to round the value, default true
1799  * @return float
1800  */
1801 function wfPercent( $nr, $acc = 2, $round = true ) {
1802         $ret = sprintf( "%.${acc}f", $nr );
1803         return $round ? round( $ret, $acc ) . '%' : "$ret%";
1804 }
1805
1806 /**
1807  * Encrypt a username/password.
1808  *
1809  * @param string $userid ID of the user
1810  * @param string $password Password of the user
1811  * @return string Hashed password
1812  * @deprecated Use User::crypt() or User::oldCrypt() instead
1813  */
1814 function wfEncryptPassword( $userid, $password ) {
1815         wfDeprecated(__FUNCTION__);
1816         # Just wrap around User::oldCrypt()
1817         return User::oldCrypt($password, $userid);
1818 }
1819
1820 /**
1821  * Appends to second array if $value differs from that in $default
1822  */
1823 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
1824         if ( is_null( $changed ) ) {
1825                 throw new MWException('GlobalFunctions::wfAppendToArrayIfNotDefault got null');
1826         }
1827         if ( $default[$key] !== $value ) {
1828                 $changed[$key] = $value;
1829         }
1830 }
1831
1832 /**
1833  * Since wfMsg() and co suck, they don't return false if the message key they
1834  * looked up didn't exist but a XHTML string, this function checks for the
1835  * nonexistance of messages by looking at wfMsg() output
1836  *
1837  * @param $msg      The message key looked up
1838  * @param $wfMsgOut The output of wfMsg*()
1839  * @return bool
1840  */
1841 function wfEmptyMsg( $msg, $wfMsgOut ) {
1842         return $wfMsgOut === htmlspecialchars( "<$msg>" );
1843 }
1844
1845 /**
1846  * Find out whether or not a mixed variable exists in a string
1847  *
1848  * @param mixed  needle
1849  * @param string haystack
1850  * @return bool
1851  */
1852 function in_string( $needle, $str ) {
1853         return strpos( $str, $needle ) !== false;
1854 }
1855
1856 function wfSpecialList( $page, $details ) {
1857         global $wgContLang;
1858         $details = $details ? ' ' . $wgContLang->getDirMark() . "($details)" : "";
1859         return $page . $details;
1860 }
1861
1862 /**
1863  * Returns a regular expression of url protocols
1864  *
1865  * @return string
1866  */
1867 function wfUrlProtocols() {
1868         global $wgUrlProtocols;
1869
1870         // Support old-style $wgUrlProtocols strings, for backwards compatibility
1871         // with LocalSettings files from 1.5
1872         if ( is_array( $wgUrlProtocols ) ) {
1873                 $protocols = array();
1874                 foreach ($wgUrlProtocols as $protocol)
1875                         $protocols[] = preg_quote( $protocol, '/' );
1876
1877                 return implode( '|', $protocols );
1878         } else {
1879                 return $wgUrlProtocols;
1880         }
1881 }
1882
1883 /**
1884  * Safety wrapper around ini_get() for boolean settings.
1885  * The values returned from ini_get() are pre-normalized for settings
1886  * set via php.ini or php_flag/php_admin_flag... but *not*
1887  * for those set via php_value/php_admin_value.
1888  *
1889  * It's fairly common for people to use php_value instead of php_flag,
1890  * which can leave you with an 'off' setting giving a false positive
1891  * for code that just takes the ini_get() return value as a boolean.
1892  *
1893  * To make things extra interesting, setting via php_value accepts
1894  * "true" and "yes" as true, but php.ini and php_flag consider them false. :)
1895  * Unrecognized values go false... again opposite PHP's own coercion
1896  * from string to bool.
1897  *
1898  * Luckily, 'properly' set settings will always come back as '0' or '1',
1899  * so we only have to worry about them and the 'improper' settings.
1900  *
1901  * I frickin' hate PHP... :P
1902  *
1903  * @param string $setting
1904  * @return bool
1905  */
1906 function wfIniGetBool( $setting ) {
1907         $val = ini_get( $setting );
1908         // 'on' and 'true' can't have whitespace around them, but '1' can.
1909         return strtolower( $val ) == 'on'
1910                 || strtolower( $val ) == 'true'
1911                 || strtolower( $val ) == 'yes'
1912                 || preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
1913 }
1914
1915 /**
1916  * Execute a shell command, with time and memory limits mirrored from the PHP
1917  * configuration if supported.
1918  * @param $cmd Command line, properly escaped for shell.
1919  * @param &$retval optional, will receive the program's exit code.
1920  *                 (non-zero is usually failure)
1921  * @return collected stdout as a string (trailing newlines stripped)
1922  */
1923 function wfShellExec( $cmd, &$retval=null ) {
1924         global $IP, $wgMaxShellMemory, $wgMaxShellFileSize;
1925
1926         if( wfIniGetBool( 'safe_mode' ) ) {
1927                 wfDebug( "wfShellExec can't run in safe_mode, PHP's exec functions are too broken.\n" );
1928                 $retval = 1;
1929                 return "Unable to run external programs in safe mode.";
1930         }
1931
1932         if ( php_uname( 's' ) == 'Linux' ) {
1933                 $time = intval( ini_get( 'max_execution_time' ) );
1934                 $mem = intval( $wgMaxShellMemory );
1935                 $filesize = intval( $wgMaxShellFileSize );
1936
1937                 if ( $time > 0 && $mem > 0 ) {
1938                         $script = "$IP/bin/ulimit4.sh";
1939                         if ( is_executable( $script ) ) {
1940                                 $cmd = escapeshellarg( $script ) . " $time $mem $filesize " . escapeshellarg( $cmd );
1941                         }
1942                 }
1943         } elseif ( php_uname( 's' ) == 'Windows NT' ) {
1944                 # This is a hack to work around PHP's flawed invocation of cmd.exe
1945                 # http://news.php.net/php.internals/21796
1946                 $cmd = '"' . $cmd . '"';
1947         }
1948         wfDebug( "wfShellExec: $cmd\n" );
1949
1950         $retval = 1; // error by default?
1951         ob_start();
1952         passthru( $cmd, $retval );
1953         $output = ob_get_contents();
1954         ob_end_clean();
1955         return $output;
1956
1957 }
1958
1959 /**
1960  * This function works like "use VERSION" in Perl, the program will die with a
1961  * backtrace if the current version of PHP is less than the version provided
1962  *
1963  * This is useful for extensions which due to their nature are not kept in sync
1964  * with releases, and might depend on other versions of PHP than the main code
1965  *
1966  * Note: PHP might die due to parsing errors in some cases before it ever
1967  *       manages to call this function, such is life
1968  *
1969  * @see perldoc -f use
1970  *
1971  * @param mixed $version The version to check, can be a string, an integer, or
1972  *                       a float
1973  */
1974 function wfUsePHP( $req_ver ) {
1975         $php_ver = PHP_VERSION;
1976
1977         if ( version_compare( $php_ver, (string)$req_ver, '<' ) )
1978                  throw new MWException( "PHP $req_ver required--this is only $php_ver" );
1979 }
1980
1981 /**
1982  * This function works like "use VERSION" in Perl except it checks the version
1983  * of MediaWiki, the program will die with a backtrace if the current version
1984  * of MediaWiki is less than the version provided.
1985  *
1986  * This is useful for extensions which due to their nature are not kept in sync
1987  * with releases
1988  *
1989  * @see perldoc -f use
1990  *
1991  * @param mixed $version The version to check, can be a string, an integer, or
1992  *                       a float
1993  */
1994 function wfUseMW( $req_ver ) {
1995         global $wgVersion;
1996
1997         if ( version_compare( $wgVersion, (string)$req_ver, '<' ) )
1998                 throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
1999 }
2000
2001 /**
2002  * @deprecated use StringUtils::escapeRegexReplacement
2003  */
2004 function wfRegexReplacement( $string ) {
2005         return StringUtils::escapeRegexReplacement( $string );
2006 }
2007
2008 /**
2009  * Return the final portion of a pathname.
2010  * Reimplemented because PHP5's basename() is buggy with multibyte text.
2011  * http://bugs.php.net/bug.php?id=33898
2012  *
2013  * PHP's basename() only considers '\' a pathchar on Windows and Netware.
2014  * We'll consider it so always, as we don't want \s in our Unix paths either.
2015  *
2016  * @param string $path
2017  * @param string $suffix to remove if present
2018  * @return string
2019  */
2020 function wfBaseName( $path, $suffix='' ) {
2021         $encSuffix = ($suffix == '')
2022                 ? ''
2023                 : ( '(?:' . preg_quote( $suffix, '#' ) . ')?' );
2024         $matches = array();
2025         if( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
2026                 return $matches[1];
2027         } else {
2028                 return '';
2029         }
2030 }
2031
2032 /**
2033  * Generate a relative path name to the given file.
2034  * May explode on non-matching case-insensitive paths,
2035  * funky symlinks, etc.
2036  *
2037  * @param string $path Absolute destination path including target filename
2038  * @param string $from Absolute source path, directory only
2039  * @return string
2040  */
2041 function wfRelativePath( $path, $from ) {
2042         // Normalize mixed input on Windows...
2043         $path = str_replace( '/', DIRECTORY_SEPARATOR, $path );
2044         $from = str_replace( '/', DIRECTORY_SEPARATOR, $from );
2045
2046         // Trim trailing slashes -- fix for drive root
2047         $path = rtrim( $path, DIRECTORY_SEPARATOR );
2048         $from = rtrim( $from, DIRECTORY_SEPARATOR );
2049
2050         $pieces  = explode( DIRECTORY_SEPARATOR, dirname( $path ) );
2051         $against = explode( DIRECTORY_SEPARATOR, $from );
2052
2053         if( $pieces[0] !== $against[0] ) {
2054                 // Non-matching Windows drive letters?
2055                 // Return a full path.
2056                 return $path;
2057         }
2058
2059         // Trim off common prefix
2060         while( count( $pieces ) && count( $against )
2061                 && $pieces[0] == $against[0] ) {
2062                 array_shift( $pieces );
2063                 array_shift( $against );
2064         }
2065
2066         // relative dots to bump us to the parent
2067         while( count( $against ) ) {
2068                 array_unshift( $pieces, '..' );
2069                 array_shift( $against );
2070         }
2071
2072         array_push( $pieces, wfBaseName( $path ) );
2073
2074         return implode( DIRECTORY_SEPARATOR, $pieces );
2075 }
2076
2077 /**
2078  * array_merge() does awful things with "numeric" indexes, including
2079  * string indexes when happen to look like integers. When we want
2080  * to merge arrays with arbitrary string indexes, we don't want our
2081  * arrays to be randomly corrupted just because some of them consist
2082  * of numbers.
2083  *
2084  * Fuck you, PHP. Fuck you in the ear!
2085  *
2086  * @param array $array1, [$array2, [...]]
2087  * @return array
2088  */
2089 function wfArrayMerge( $array1/* ... */ ) {
2090         $out = $array1;
2091         for( $i = 1; $i < func_num_args(); $i++ ) {
2092                 foreach( func_get_arg( $i ) as $key => $value ) {
2093                         $out[$key] = $value;
2094                 }
2095         }
2096         return $out;
2097 }
2098
2099 /**
2100  * Make a URL index, appropriate for the el_index field of externallinks.
2101  */
2102 function wfMakeUrlIndex( $url ) {
2103         global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
2104         wfSuppressWarnings();
2105         $bits = parse_url( $url );
2106         wfRestoreWarnings();
2107         if ( !$bits ) {
2108                 return false;
2109         }
2110         // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
2111         $delimiter = '';
2112         if ( in_array( $bits['scheme'] . '://' , $wgUrlProtocols ) ) {
2113                 $delimiter = '://';
2114         } elseif ( in_array( $bits['scheme'] .':' , $wgUrlProtocols ) ) {
2115                 $delimiter = ':';
2116                 // parse_url detects for news: and mailto: the host part of an url as path
2117                 // We have to correct this wrong detection
2118                 if ( isset ( $bits['path'] ) ) {
2119                         $bits['host'] = $bits['path'];
2120                         $bits['path'] = '';
2121                 }
2122         } else {
2123                 return false;
2124         }
2125
2126         // Reverse the labels in the hostname, convert to lower case
2127         // For emails reverse domainpart only
2128         if ( $bits['scheme'] == 'mailto' ) {
2129                 $mailparts = explode( '@', $bits['host'], 2 );
2130                 if ( count($mailparts) === 2 ) {
2131                         $domainpart = strtolower( implode( '.', array_reverse( explode( '.', $mailparts[1] ) ) ) );
2132                 } else {
2133                         // No domain specified, don't mangle it
2134                         $domainpart = '';
2135                 }
2136                 $reversedHost = $domainpart . '@' . $mailparts[0];
2137         } else {
2138                 $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) );
2139         }
2140         // Add an extra dot to the end
2141         // Why? Is it in wrong place in mailto links?
2142         if ( substr( $reversedHost, -1, 1 ) !== '.' ) {
2143                 $reversedHost .= '.';
2144         }
2145         // Reconstruct the pseudo-URL
2146         $prot = $bits['scheme'];
2147         $index = "$prot$delimiter$reversedHost";
2148         // Leave out user and password. Add the port, path, query and fragment
2149         if ( isset( $bits['port'] ) )      $index .= ':' . $bits['port'];
2150         if ( isset( $bits['path'] ) ) {
2151                 $index .= $bits['path'];
2152         } else {
2153                 $index .= '/';
2154         }
2155         if ( isset( $bits['query'] ) )     $index .= '?' . $bits['query'];
2156         if ( isset( $bits['fragment'] ) )  $index .= '#' . $bits['fragment'];
2157         return $index;
2158 }
2159
2160 /**
2161  * Do any deferred updates and clear the list
2162  * TODO: This could be in Wiki.php if that class made any sense at all
2163  */
2164 function wfDoUpdates()
2165 {
2166         global $wgPostCommitUpdateList, $wgDeferredUpdateList;
2167         foreach ( $wgDeferredUpdateList as $update ) {
2168                 $update->doUpdate();
2169         }
2170         foreach ( $wgPostCommitUpdateList as $update ) {
2171                 $update->doUpdate();
2172         }
2173         $wgDeferredUpdateList = array();
2174         $wgPostCommitUpdateList = array();
2175 }
2176
2177 /**
2178  * @deprecated use StringUtils::explodeMarkup
2179  */
2180 function wfExplodeMarkup( $separator, $text ) {
2181         return StringUtils::explodeMarkup( $separator, $text );
2182 }
2183
2184 /**
2185  * Convert an arbitrarily-long digit string from one numeric base
2186  * to another, optionally zero-padding to a minimum column width.
2187  *
2188  * Supports base 2 through 36; digit values 10-36 are represented
2189  * as lowercase letters a-z. Input is case-insensitive.
2190  *
2191  * @param $input string of digits
2192  * @param $sourceBase int 2-36
2193  * @param $destBase int 2-36
2194  * @param $pad int 1 or greater
2195  * @param $lowercase bool
2196  * @return string or false on invalid input
2197  */
2198 function wfBaseConvert( $input, $sourceBase, $destBase, $pad=1, $lowercase=true ) {
2199         $input = strval( $input );
2200         if( $sourceBase < 2 ||
2201                 $sourceBase > 36 ||
2202                 $destBase < 2 ||
2203                 $destBase > 36 ||
2204                 $pad < 1 ||
2205                 $sourceBase != intval( $sourceBase ) ||
2206                 $destBase != intval( $destBase ) ||
2207                 $pad != intval( $pad ) ||
2208                 !is_string( $input ) ||
2209                 $input == '' ) {
2210                 return false;
2211         }
2212         $digitChars = ( $lowercase ) ?  '0123456789abcdefghijklmnopqrstuvwxyz' : '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ';
2213         $inDigits = array();
2214         $outChars = '';
2215
2216         // Decode and validate input string
2217         $input = strtolower( $input );
2218         for( $i = 0; $i < strlen( $input ); $i++ ) {
2219                 $n = strpos( $digitChars, $input{$i} );
2220                 if( $n === false || $n > $sourceBase ) {
2221                         return false;
2222                 }
2223                 $inDigits[] = $n;
2224         }
2225
2226         // Iterate over the input, modulo-ing out an output digit
2227         // at a time until input is gone.
2228         while( count( $inDigits ) ) {
2229                 $work = 0;
2230                 $workDigits = array();
2231
2232                 // Long division...
2233                 foreach( $inDigits as $digit ) {
2234                         $work *= $sourceBase;
2235                         $work += $digit;
2236
2237                         if( $work < $destBase ) {
2238                                 // Gonna need to pull another digit.
2239                                 if( count( $workDigits ) ) {
2240                                         // Avoid zero-padding; this lets us find
2241                                         // the end of the input very easily when
2242                                         // length drops to zero.
2243                                         $workDigits[] = 0;
2244                                 }
2245                         } else {
2246                                 // Finally! Actual division!
2247                                 $workDigits[] = intval( $work / $destBase );
2248
2249                                 // Isn't it annoying that most programming languages
2250                                 // don't have a single divide-and-remainder operator,
2251                                 // even though the CPU implements it that way?
2252                                 $work = $work % $destBase;
2253                         }
2254                 }
2255
2256                 // All that division leaves us with a remainder,
2257                 // which is conveniently our next output digit.
2258                 $outChars .= $digitChars[$work];
2259
2260                 // And we continue!
2261                 $inDigits = $workDigits;
2262         }
2263
2264         while( strlen( $outChars ) < $pad ) {
2265                 $outChars .= '0';
2266         }
2267
2268         return strrev( $outChars );
2269 }
2270
2271 /**
2272  * Create an object with a given name and an array of construct parameters
2273  * @param string $name
2274  * @param array $p parameters
2275  */
2276 function wfCreateObject( $name, $p ){
2277         $p = array_values( $p );
2278         switch ( count( $p ) ) {
2279                 case 0:
2280                         return new $name;
2281                 case 1:
2282                         return new $name( $p[0] );
2283                 case 2:
2284                         return new $name( $p[0], $p[1] );
2285                 case 3:
2286                         return new $name( $p[0], $p[1], $p[2] );
2287                 case 4:
2288                         return new $name( $p[0], $p[1], $p[2], $p[3] );
2289                 case 5:
2290                         return new $name( $p[0], $p[1], $p[2], $p[3], $p[4] );
2291                 case 6:
2292                         return new $name( $p[0], $p[1], $p[2], $p[3], $p[4], $p[5] );
2293                 default:
2294                         throw new MWException( "Too many arguments to construtor in wfCreateObject" );
2295         }
2296 }
2297
2298 /**
2299  * Alias for modularized function
2300  * @deprecated Use Http::get() instead
2301  */
2302 function wfGetHTTP( $url, $timeout = 'default' ) {
2303         wfDeprecated(__FUNCTION__);
2304         return Http::get( $url, $timeout );
2305 }
2306
2307 /**
2308  * Alias for modularized function
2309  * @deprecated Use Http::isLocalURL() instead
2310  */
2311 function wfIsLocalURL( $url ) {
2312         wfDeprecated(__FUNCTION__);
2313         return Http::isLocalURL( $url );
2314 }
2315
2316 function wfHttpOnlySafe() {
2317         global $wgHttpOnlyBlacklist;
2318         if( !version_compare("5.2", PHP_VERSION, "<") )
2319                 return false;
2320
2321         if( isset( $_SERVER['HTTP_USER_AGENT'] ) ) {
2322                 foreach( $wgHttpOnlyBlacklist as $regex ) {
2323                         if( preg_match( $regex, $_SERVER['HTTP_USER_AGENT'] ) ) {
2324                                 return false;
2325                         }
2326                 }
2327         }
2328
2329         return true;
2330 }
2331
2332 /**
2333  * Initialise php session
2334  */
2335 function wfSetupSession() {
2336         global $wgSessionsInMemcached, $wgCookiePath, $wgCookieDomain, $wgCookieSecure, $wgCookieHttpOnly;
2337         if( $wgSessionsInMemcached ) {
2338                 require_once( 'MemcachedSessions.php' );
2339         } elseif( 'files' != ini_get( 'session.save_handler' ) ) {
2340                 # If it's left on 'user' or another setting from another
2341                 # application, it will end up failing. Try to recover.
2342                 ini_set ( 'session.save_handler', 'files' );
2343         }
2344         $httpOnlySafe = wfHttpOnlySafe();
2345         wfDebugLog( 'cookie',
2346                 'session_set_cookie_params: "' . implode( '", "',
2347                         array(
2348                                 0,
2349                                 $wgCookiePath,
2350                                 $wgCookieDomain,
2351                                 $wgCookieSecure,
2352                                 $httpOnlySafe && $wgCookieHttpOnly ) ) . '"' );
2353         if( $httpOnlySafe && $wgCookieHttpOnly ) {
2354                 session_set_cookie_params( 0, $wgCookiePath, $wgCookieDomain, $wgCookieSecure, $wgCookieHttpOnly );
2355         } else {
2356                 // PHP 5.1 throws warnings if you pass the HttpOnly parameter for 5.2.
2357                 session_set_cookie_params( 0, $wgCookiePath, $wgCookieDomain, $wgCookieSecure );
2358         }
2359         session_cache_limiter( 'private, must-revalidate' );
2360         wfSuppressWarnings();
2361         session_start();
2362         wfRestoreWarnings();
2363 }
2364
2365 /**
2366  * Get an object from the precompiled serialized directory
2367  *
2368  * @return mixed The variable on success, false on failure
2369  */
2370 function wfGetPrecompiledData( $name ) {
2371         global $IP;
2372
2373         $file = "$IP/serialized/$name";
2374         if ( file_exists( $file ) ) {
2375                 $blob = file_get_contents( $file );
2376                 if ( $blob ) {
2377                         return unserialize( $blob );
2378                 }
2379         }
2380         return false;
2381 }
2382
2383 function wfGetCaller( $level = 2 ) {
2384         $backtrace = wfDebugBacktrace();
2385         if ( isset( $backtrace[$level] ) ) {
2386                 return wfFormatStackFrame($backtrace[$level]);
2387         } else {
2388                 $caller = 'unknown';
2389         }
2390         return $caller;
2391 }
2392
2393 /** Return a string consisting all callers in stack, somewhat useful sometimes for profiling specific points */
2394 function wfGetAllCallers() {
2395         return implode('/', array_map('wfFormatStackFrame',array_reverse(wfDebugBacktrace())));
2396 }
2397
2398 /** Return a string representation of frame */
2399 function wfFormatStackFrame($frame) {
2400         return isset( $frame["class"] )?
2401                 $frame["class"]."::".$frame["function"]:
2402                 $frame["function"];
2403 }
2404
2405 /**
2406  * Get a cache key
2407  */
2408 function wfMemcKey( /*... */ ) {
2409         $args = func_get_args();
2410         $key = wfWikiID() . ':' . implode( ':', $args );
2411         return $key;
2412 }
2413
2414 /**
2415  * Get a cache key for a foreign DB
2416  */
2417 function wfForeignMemcKey( $db, $prefix /*, ... */ ) {
2418         $args = array_slice( func_get_args(), 2 );
2419         if ( $prefix ) {
2420                 $key = "$db-$prefix:" . implode( ':', $args );
2421         } else {
2422                 $key = $db . ':' . implode( ':', $args );
2423         }
2424         return $key;
2425 }
2426
2427 /**
2428  * Get an ASCII string identifying this wiki
2429  * This is used as a prefix in memcached keys
2430  */
2431 function wfWikiID( $db = null ) {
2432         if( $db instanceof Database ) {
2433                 return $db->getWikiID();
2434         } else {
2435         global $wgDBprefix, $wgDBname;
2436                 if ( $wgDBprefix ) {
2437                         return "$wgDBname-$wgDBprefix";
2438                 } else {
2439                         return $wgDBname;
2440                 }
2441         }
2442 }
2443
2444 /**
2445  * Split a wiki ID into DB name and table prefix
2446  */
2447 function wfSplitWikiID( $wiki ) {
2448         $bits = explode( '-', $wiki, 2 );
2449         if ( count( $bits ) < 2 ) {
2450                 $bits[] = '';
2451         }
2452         return $bits;
2453 }
2454
2455 /*
2456  * Get a Database object.
2457  * @param integer $db Index of the connection to get. May be DB_MASTER for the
2458  *                master (for write queries), DB_SLAVE for potentially lagged
2459  *                read queries, or an integer >= 0 for a particular server.
2460  *
2461  * @param mixed $groups Query groups. An array of group names that this query
2462  *              belongs to. May contain a single string if the query is only
2463  *              in one group.
2464  *
2465  * @param string $wiki The wiki ID, or false for the current wiki
2466  *
2467  * Note: multiple calls to wfGetDB(DB_SLAVE) during the course of one request
2468  * will always return the same object, unless the underlying connection or load
2469  * balancer is manually destroyed.
2470  */
2471 function &wfGetDB( $db = DB_LAST, $groups = array(), $wiki = false ) {
2472         return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
2473 }
2474
2475 /**
2476  * Get a load balancer object.
2477  *
2478  * @param array $groups List of query groups
2479  * @param string $wiki Wiki ID, or false for the current wiki
2480  * @return LoadBalancer
2481  */
2482 function wfGetLB( $wiki = false ) {
2483         return wfGetLBFactory()->getMainLB( $wiki );
2484 }
2485
2486 /**
2487  * Get the load balancer factory object
2488  */
2489 function &wfGetLBFactory() {
2490         return LBFactory::singleton();
2491 }
2492
2493 /**
2494  * Find a file.
2495  * Shortcut for RepoGroup::singleton()->findFile()
2496  * @param mixed $title Title object or string. May be interwiki.
2497  * @param mixed $time Requested time for an archived image, or false for the
2498  *                    current version. An image object will be returned which
2499  *                    was created at the specified time.
2500  * @param mixed $flags FileRepo::FIND_ flags
2501  * @return File, or false if the file does not exist
2502  */
2503 function wfFindFile( $title, $time = false, $flags = 0 ) {
2504         return RepoGroup::singleton()->findFile( $title, $time, $flags );
2505 }
2506
2507 /**
2508  * Get an object referring to a locally registered file.
2509  * Returns a valid placeholder object if the file does not exist.
2510  */
2511 function wfLocalFile( $title ) {
2512         return RepoGroup::singleton()->getLocalRepo()->newFile( $title );
2513 }
2514
2515 /**
2516  * Should low-performance queries be disabled?
2517  *
2518  * @return bool
2519  */
2520 function wfQueriesMustScale() {
2521         global $wgMiserMode;
2522         return $wgMiserMode
2523                 || ( SiteStats::pages() > 100000
2524                 && SiteStats::edits() > 1000000
2525                 && SiteStats::users() > 10000 );
2526 }
2527
2528 /**
2529  * Get the path to a specified script file, respecting file
2530  * extensions; this is a wrapper around $wgScriptExtension etc.
2531  *
2532  * @param string $script Script filename, sans extension
2533  * @return string
2534  */
2535 function wfScript( $script = 'index' ) {
2536         global $wgScriptPath, $wgScriptExtension;
2537         return "{$wgScriptPath}/{$script}{$wgScriptExtension}";
2538 }
2539
2540 /**
2541  * Convenience function converts boolean values into "true"
2542  * or "false" (string) values
2543  *
2544  * @param bool $value
2545  * @return string
2546  */
2547 function wfBoolToStr( $value ) {
2548         return $value ? 'true' : 'false';
2549 }
2550
2551 /**
2552  * Load an extension messages file
2553  *
2554  * @param string $extensionName Name of extension to load messages from\for.
2555  * @param string $langcode Language to load messages for, or false for default
2556  *                         behvaiour (en, content language and user language).
2557  */
2558 function wfLoadExtensionMessages( $extensionName, $langcode = false ) {
2559         global $wgExtensionMessagesFiles, $wgMessageCache, $wgLang, $wgContLang;
2560
2561         #For recording whether extension message files have been loaded in a given language.
2562         static $loaded = array();
2563
2564         if( !array_key_exists( $extensionName, $loaded ) ) {
2565                 $loaded[$extensionName] = array();
2566         }
2567
2568         if ( !isset($wgExtensionMessagesFiles[$extensionName]) ) {
2569                 throw new MWException( "Messages file for extensions $extensionName is not defined" );
2570         }
2571
2572         if( !$langcode && !array_key_exists( '*', $loaded[$extensionName] ) ) {
2573                 # Just do en, content language and user language.
2574                 $wgMessageCache->loadMessagesFile( $wgExtensionMessagesFiles[$extensionName], false );
2575                 # Mark that they have been loaded.
2576                 $loaded[$extensionName]['en'] = true;
2577                 $loaded[$extensionName][$wgLang->getCode()] = true;
2578                 $loaded[$extensionName][$wgContLang->getCode()] = true;
2579                 # Mark that this part has been done to avoid weird if statements.
2580                 $loaded[$extensionName]['*'] = true;
2581         } elseif( is_string( $langcode ) && !array_key_exists( $langcode, $loaded[$extensionName] ) ) {
2582                 # Load messages for specified language.
2583                 $wgMessageCache->loadMessagesFile( $wgExtensionMessagesFiles[$extensionName], $langcode );
2584                 # Mark that they have been loaded.
2585                 $loaded[$extensionName][$langcode] = true;
2586         }
2587 }
2588
2589 /**
2590  * Get a platform-independent path to the null file, e.g.
2591  * /dev/null
2592  *
2593  * @return string
2594  */
2595 function wfGetNull() {
2596         return wfIsWindows()
2597                 ? 'NUL'
2598                 : '/dev/null';
2599 }
2600
2601 /**
2602  * Displays a maxlag error
2603  *
2604  * @param string $host Server that lags the most
2605  * @param int $lag Maxlag (actual)
2606  * @param int $maxLag Maxlag (requested)
2607  */
2608 function wfMaxlagError( $host, $lag, $maxLag ) {
2609         global $wgShowHostnames;
2610         header( 'HTTP/1.1 503 Service Unavailable' );
2611         header( 'Retry-After: ' . max( intval( $maxLag ), 5 ) );
2612         header( 'X-Database-Lag: ' . intval( $lag ) );
2613         header( 'Content-Type: text/plain' );
2614         if( $wgShowHostnames ) {
2615                 echo "Waiting for $host: $lag seconds lagged\n";
2616         } else {
2617                 echo "Waiting for a database server: $lag seconds lagged\n";
2618         }
2619 }
2620
2621 /**
2622  * Throws an E_USER_NOTICE saying that $function is deprecated
2623  * @param string $function
2624  * @return null
2625  */
2626 function wfDeprecated( $function ) {
2627         global $wgDebugLogFile;
2628         if ( !$wgDebugLogFile ) {
2629                 return;
2630         }
2631         $callers = wfDebugBacktrace();
2632         if( isset( $callers[2] ) ){
2633                 $callerfunc = $callers[2];
2634                 $callerfile = $callers[1];
2635                 if( isset( $callerfile['file'] ) && isset( $callerfile['line'] ) ){
2636                         $file = $callerfile['file'] . ' at line ' . $callerfile['line'];
2637                 } else {
2638                         $file = '(internal function)';
2639                 }
2640                 $func = '';
2641                 if( isset( $callerfunc['class'] ) )
2642                         $func .= $callerfunc['class'] . '::';
2643                 $func .= @$callerfunc['function'];
2644                 $msg = "Use of $function is deprecated. Called from $func in $file";
2645         } else {
2646                 $msg = "Use of $function is deprecated.";
2647         }
2648         wfDebug( "$msg\n" );
2649 }
2650
2651 /**
2652  * Sleep until the worst slave's replication lag is less than or equal to
2653  * $maxLag, in seconds.  Use this when updating very large numbers of rows, as
2654  * in maintenance scripts, to avoid causing too much lag.  Of course, this is
2655  * a no-op if there are no slaves.
2656  *
2657  * Every time the function has to wait for a slave, it will print a message to
2658  * that effect (and then sleep for a little while), so it's probably not best
2659  * to use this outside maintenance scripts in its present form.
2660  *
2661  * @param int $maxLag
2662  * @return null
2663  */
2664 function wfWaitForSlaves( $maxLag ) {
2665         if( $maxLag ) {
2666                 $lb = wfGetLB();
2667                 list( $host, $lag ) = $lb->getMaxLag();
2668                 while( $lag > $maxLag ) {
2669                         $name = @gethostbyaddr( $host );
2670                         if( $name !== false ) {
2671                                 $host = $name;
2672                         }
2673                         print "Waiting for $host (lagged $lag seconds)...\n";
2674                         sleep($maxLag);
2675                         list( $host, $lag ) = $lb->getMaxLag();
2676                 }
2677         }
2678 }
2679
2680 /** Generate a random 32-character hexadecimal token.
2681  * @param mixed $salt Some sort of salt, if necessary, to add to random characters before hashing.
2682  */
2683 function wfGenerateToken( $salt = '' ) {
2684         $salt = serialize($salt);
2685
2686         return md5( mt_rand( 0, 0x7fffffff ) . $salt );
2687 }