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