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