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