includes/GlobalFunctions.php

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