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