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