includes/GlobalFunctions.php

   1 <?php
   2 /**
   3  * Global functions used everywhere.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  */
  22
  23 if ( !defined( 'MEDIAWIKI' ) ) {
  24         die( "This file is part of MediaWiki, it is not a valid entry point" );
  25 }
  26
  27 use Liuggio\StatsdClient\StatsdClient;
  28 use Liuggio\StatsdClient\Sender\SocketSender;
  29
  30 // Hide compatibility functions from Doxygen
  31 /// @cond
  32
  33 /**
  34  * Compatibility functions
  35  *
  36  * We support PHP 5.3.3 and up.
  37  * Re-implementations of newer functions or functions in non-standard
  38  * PHP extensions may be included here.
  39  */
  40
  41 if ( !function_exists( 'mb_substr' ) ) {
  42         /**
  43          * @codeCoverageIgnore
  44          * @see Fallback::mb_substr
  45          * @return string
  46          */
  47         function mb_substr( $str, $start, $count = 'end' ) {
  48                 return Fallback::mb_substr( $str, $start, $count );
  49         }
  50
  51         /**
  52          * @codeCoverageIgnore
  53          * @see Fallback::mb_substr_split_unicode
  54          * @return int
  55          */
  56         function mb_substr_split_unicode( $str, $splitPos ) {
  57                 return Fallback::mb_substr_split_unicode( $str, $splitPos );
  58         }
  59 }
  60
  61 if ( !function_exists( 'mb_strlen' ) ) {
  62         /**
  63          * @codeCoverageIgnore
  64          * @see Fallback::mb_strlen
  65          * @return int
  66          */
  67         function mb_strlen( $str, $enc = '' ) {
  68                 return Fallback::mb_strlen( $str, $enc );
  69         }
  70 }
  71
  72 if ( !function_exists( 'mb_strpos' ) ) {
  73         /**
  74          * @codeCoverageIgnore
  75          * @see Fallback::mb_strpos
  76          * @return int
  77          */
  78         function mb_strpos( $haystack, $needle, $offset = 0, $encoding = '' ) {
  79                 return Fallback::mb_strpos( $haystack, $needle, $offset, $encoding );
  80         }
  81 }
  82
  83 if ( !function_exists( 'mb_strrpos' ) ) {
  84         /**
  85          * @codeCoverageIgnore
  86          * @see Fallback::mb_strrpos
  87          * @return int
  88          */
  89         function mb_strrpos( $haystack, $needle, $offset = 0, $encoding = '' ) {
  90                 return Fallback::mb_strrpos( $haystack, $needle, $offset, $encoding );
  91         }
  92 }
  93
  94 // gzdecode function only exists in PHP >= 5.4.0
  95 // http://php.net/gzdecode
  96 if ( !function_exists( 'gzdecode' ) ) {
  97         /**
  98          * @codeCoverageIgnore
  99          * @param string $data
 100          * @return string
 101          */
 102         function gzdecode( $data ) {
 103                 return gzinflate( substr( $data, 10, -8 ) );
 104         }
 105 }
 106
 107 // hash_equals function only exists in PHP >= 5.6.0
 108 // http://php.net/hash_equals
 109 if ( !function_exists( 'hash_equals' ) ) {
 110         /**
 111          * Check whether a user-provided string is equal to a fixed-length secret string
 112          * without revealing bytes of the secret string through timing differences.
 113          *
 114          * The usual way to compare strings (PHP's === operator or the underlying memcmp()
 115          * function in C) is to compare corresponding bytes and stop at the first difference,
 116          * which would take longer for a partial match than for a complete mismatch. This
 117          * is not secure when one of the strings (e.g. an HMAC or token) must remain secret
 118          * and the other may come from an attacker. Statistical analysis of timing measurements
 119          * over many requests may allow the attacker to guess the string's bytes one at a time
 120          * (and check his guesses) even if the timing differences are extremely small.
 121          *
 122          * When making such a security-sensitive comparison, it is essential that the sequence
 123          * in which instructions are executed and memory locations are accessed not depend on
 124          * the secret string's value. HOWEVER, for simplicity, we do not attempt to minimize
 125          * the inevitable leakage of the string's length. That is generally known anyway as
 126          * a chararacteristic of the hash function used to compute the secret value.
 127          *
 128          * Longer explanation: http://www.emerose.com/timing-attacks-explained
 129          *
 130          * @codeCoverageIgnore
 131          * @param string $known_string Fixed-length secret string to compare against
 132          * @param string $user_string User-provided string
 133          * @return bool True if the strings are the same, false otherwise
 134          */
 135         function hash_equals( $known_string, $user_string ) {
 136                 // Strict type checking as in PHP's native implementation
 137                 if ( !is_string( $known_string ) ) {
 138                         trigger_error( 'hash_equals(): Expected known_string to be a string, ' .
 139                                 gettype( $known_string ) . ' given', E_USER_WARNING );
 140
 141                         return false;
 142                 }
 143
 144                 if ( !is_string( $user_string ) ) {
 145                         trigger_error( 'hash_equals(): Expected user_string to be a string, ' .
 146                                 gettype( $user_string ) . ' given', E_USER_WARNING );
 147
 148                         return false;
 149                 }
 150
 151                 $known_string_len = strlen( $known_string );
 152                 if ( $known_string_len !== strlen( $user_string ) ) {
 153                         return false;
 154                 }
 155
 156                 $result = 0;
 157                 for ( $i = 0; $i < $known_string_len; $i++ ) {
 158                         $result |= ord( $known_string[$i] ) ^ ord( $user_string[$i] );
 159                 }
 160
 161                 return ( $result === 0 );
 162         }
 163 }
 164 /// @endcond
 165
 166 /**
 167  * Load an extension
 168  *
 169  * This queues an extension to be loaded through
 170  * the ExtensionRegistry system.
 171  *
 172  * @param string $name Name of the extension to load
 173  * @param string|null $path Absolute path of where to find the extension.json file
 174  */
 175 function wfLoadExtension( $name, $path = null ) {
 176         if ( !$path ) {
 177                 global $IP;
 178                 $path = "$IP/extensions/$name/extension.json";
 179         }
 180         ExtensionRegistry::getInstance()->queue( $path );
 181 }
 182
 183 /**
 184  * Load multiple extensions at once
 185  *
 186  * Same as wfLoadExtension, but more efficient if you
 187  * are loading multiple extensions.
 188  *
 189  * If you want to specify custom paths, you should interact with
 190  * ExtensionRegistry directly.
 191  *
 192  * @see wfLoadExtension
 193  * @param string[] $exts Array of extension names to load
 194  */
 195 function wfLoadExtensions( array $exts ) {
 196         global $IP;
 197         $registry = ExtensionRegistry::getInstance();
 198         foreach ( $exts as $ext ) {
 199                 $registry->queue( "$IP/extensions/$ext/extension.json" );
 200         }
 201 }
 202
 203 /**
 204  * Load a skin
 205  *
 206  * @see wfLoadExtension
 207  * @param string $name Name of the extension to load
 208  * @param string|null $path Absolute path of where to find the skin.json file
 209  */
 210 function wfLoadSkin( $name, $path = null ) {
 211         if ( !$path ) {
 212                 global $IP;
 213                 $path = "$IP/skins/$name/skin.json";
 214         }
 215         ExtensionRegistry::getInstance()->queue( $path );
 216 }
 217
 218 /**
 219  * Load multiple skins at once
 220  *
 221  * @see wfLoadExtensions
 222  * @param string[] $skins Array of extension names to load
 223  */
 224 function wfLoadSkins( array $skins ) {
 225         global $IP;
 226         $registry = ExtensionRegistry::getInstance();
 227         foreach ( $skins as $skin ) {
 228                 $registry->queue( "$IP/skins/$skin/skin.json" );
 229         }
 230 }
 231
 232 /**
 233  * Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
 234  * @param array $a
 235  * @param array $b
 236  * @return array
 237  */
 238 function wfArrayDiff2( $a, $b ) {
 239         return array_udiff( $a, $b, 'wfArrayDiff2_cmp' );
 240 }
 241
 242 /**
 243  * @param array|string $a
 244  * @param array|string $b
 245  * @return int
 246  */
 247 function wfArrayDiff2_cmp( $a, $b ) {
 248         if ( is_string( $a ) && is_string( $b ) ) {
 249                 return strcmp( $a, $b );
 250         } elseif ( count( $a ) !== count( $b ) ) {
 251                 return count( $a ) < count( $b ) ? -1 : 1;
 252         } else {
 253                 reset( $a );
 254                 reset( $b );
 255                 while ( ( list( , $valueA ) = each( $a ) ) && ( list( , $valueB ) = each( $b ) ) ) {
 256                         $cmp = strcmp( $valueA, $valueB );
 257                         if ( $cmp !== 0 ) {
 258                                 return $cmp;
 259                         }
 260                 }
 261                 return 0;
 262         }
 263 }
 264
 265 /**
 266  * Appends to second array if $value differs from that in $default
 267  *
 268  * @param string|int $key
 269  * @param mixed $value
 270  * @param mixed $default
 271  * @param array $changed Array to alter
 272  * @throws MWException
 273  */
 274 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
 275         if ( is_null( $changed ) ) {
 276                 throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' );
 277         }
 278         if ( $default[$key] !== $value ) {
 279                 $changed[$key] = $value;
 280         }
 281 }
 282
 283 /**
 284  * Merge arrays in the style of getUserPermissionsErrors, with duplicate removal
 285  * e.g.
 286  *      wfMergeErrorArrays(
 287  *              array( array( 'x' ) ),
 288  *              array( array( 'x', '2' ) ),
 289  *              array( array( 'x' ) ),
 290  *              array( array( 'y' ) )
 291  *      );
 292  * returns:
 293  *              array(
 294  *              array( 'x', '2' ),
 295  *              array( 'x' ),
 296  *              array( 'y' )
 297  *      )
 298  *
 299  * @param array $array1,...
 300  * @return array
 301  */
 302 function wfMergeErrorArrays( /*...*/ ) {
 303         $args = func_get_args();
 304         $out = array();
 305         foreach ( $args as $errors ) {
 306                 foreach ( $errors as $params ) {
 307                         # @todo FIXME: Sometimes get nested arrays for $params,
 308                         # which leads to E_NOTICEs
 309                         $spec = implode( "\t", $params );
 310                         $out[$spec] = $params;
 311                 }
 312         }
 313         return array_values( $out );
 314 }
 315
 316 /**
 317  * Insert array into another array after the specified *KEY*
 318  *
 319  * @param array $array The array.
 320  * @param array $insert The array to insert.
 321  * @param mixed $after The key to insert after
 322  * @return array
 323  */
 324 function wfArrayInsertAfter( array $array, array $insert, $after ) {
 325         // Find the offset of the element to insert after.
 326         $keys = array_keys( $array );
 327         $offsetByKey = array_flip( $keys );
 328
 329         $offset = $offsetByKey[$after];
 330
 331         // Insert at the specified offset
 332         $before = array_slice( $array, 0, $offset + 1, true );
 333         $after = array_slice( $array, $offset + 1, count( $array ) - $offset, true );
 334
 335         $output = $before + $insert + $after;
 336
 337         return $output;
 338 }
 339
 340 /**
 341  * Recursively converts the parameter (an object) to an array with the same data
 342  *
 343  * @param object|array $objOrArray
 344  * @param bool $recursive
 345  * @return array
 346  */
 347 function wfObjectToArray( $objOrArray, $recursive = true ) {
 348         $array = array();
 349         if ( is_object( $objOrArray ) ) {
 350                 $objOrArray = get_object_vars( $objOrArray );
 351         }
 352         foreach ( $objOrArray as $key => $value ) {
 353                 if ( $recursive && ( is_object( $value ) || is_array( $value ) ) ) {
 354                         $value = wfObjectToArray( $value );
 355                 }
 356
 357                 $array[$key] = $value;
 358         }
 359
 360         return $array;
 361 }
 362
 363 /**
 364  * Get a random decimal value between 0 and 1, in a way
 365  * not likely to give duplicate values for any realistic
 366  * number of articles.
 367  *
 368  * @return string
 369  */
 370 function wfRandom() {
 371         # The maximum random value is "only" 2^31-1, so get two random
 372         # values to reduce the chance of dupes
 373         $max = mt_getrandmax() + 1;
 374         $rand = number_format( ( mt_rand() * $max + mt_rand() ) / $max / $max, 12, '.', '' );
 375
 376         return $rand;
 377 }
 378
 379 /**
 380  * Get a random string containing a number of pseudo-random hex
 381  * characters.
 382  * @note This is not secure, if you are trying to generate some sort
 383  *       of token please use MWCryptRand instead.
 384  *
 385  * @param int $length The length of the string to generate
 386  * @return string
 387  * @since 1.20
 388  */
 389 function wfRandomString( $length = 32 ) {
 390         $str = '';
 391         for ( $n = 0; $n < $length; $n += 7 ) {
 392                 $str .= sprintf( '%07x', mt_rand() & 0xfffffff );
 393         }
 394         return substr( $str, 0, $length );
 395 }
 396
 397 /**
 398  * We want some things to be included as literal characters in our title URLs
 399  * for prettiness, which urlencode encodes by default.  According to RFC 1738,
 400  * all of the following should be safe:
 401  *
 402  * ;:@&=$-_.+!*'(),
 403  *
 404  * But + is not safe because it's used to indicate a space; &= are only safe in
 405  * paths and not in queries (and we don't distinguish here); ' seems kind of
 406  * scary; and urlencode() doesn't touch -_. to begin with.  Plus, although /
 407  * is reserved, we don't care.  So the list we unescape is:
 408  *
 409  * ;:@$!*(),/
 410  *
 411  * However, IIS7 redirects fail when the url contains a colon (Bug 22709),
 412  * so no fancy : for IIS7.
 413  *
 414  * %2F in the page titles seems to fatally break for some reason.
 415  *
 416  * @param string $s
 417  * @return string
 418  */
 419 function wfUrlencode( $s ) {
 420         static $needle;
 421
 422         if ( is_null( $s ) ) {
 423                 $needle = null;
 424                 return '';
 425         }
 426
 427         if ( is_null( $needle ) ) {
 428                 $needle = array( '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F' );
 429                 if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) ||
 430                         ( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false )
 431                 ) {
 432                         $needle[] = '%3A';
 433                 }
 434         }
 435
 436         $s = urlencode( $s );
 437         $s = str_ireplace(
 438                 $needle,
 439                 array( ';', '@', '$', '!', '*', '(', ')', ',', '/', ':' ),
 440                 $s
 441         );
 442
 443         return $s;
 444 }
 445
 446 /**
 447  * This function takes two arrays as input, and returns a CGI-style string, e.g.
 448  * "days=7&limit=100". Options in the first array override options in the second.
 449  * Options set to null or false will not be output.
 450  *
 451  * @param array $array1 ( String|Array )
 452  * @param array $array2 ( String|Array )
 453  * @param string $prefix
 454  * @return string
 455  */
 456 function wfArrayToCgi( $array1, $array2 = null, $prefix = '' ) {
 457         if ( !is_null( $array2 ) ) {
 458                 $array1 = $array1 + $array2;
 459         }
 460
 461         $cgi = '';
 462         foreach ( $array1 as $key => $value ) {
 463                 if ( !is_null( $value ) && $value !== false ) {
 464                         if ( $cgi != '' ) {
 465                                 $cgi .= '&';
 466                         }
 467                         if ( $prefix !== '' ) {
 468                                 $key = $prefix . "[$key]";
 469                         }
 470                         if ( is_array( $value ) ) {
 471                                 $firstTime = true;
 472                                 foreach ( $value as $k => $v ) {
 473                                         $cgi .= $firstTime ? '' : '&';
 474                                         if ( is_array( $v ) ) {
 475                                                 $cgi .= wfArrayToCgi( $v, null, $key . "[$k]" );
 476                                         } else {
 477                                                 $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v );
 478                                         }
 479                                         $firstTime = false;
 480                                 }
 481                         } else {
 482                                 if ( is_object( $value ) ) {
 483                                         $value = $value->__toString();
 484                                 }
 485                                 $cgi .= urlencode( $key ) . '=' . urlencode( $value );
 486                         }
 487                 }
 488         }
 489         return $cgi;
 490 }
 491
 492 /**
 493  * This is the logical opposite of wfArrayToCgi(): it accepts a query string as
 494  * its argument and returns the same string in array form.  This allows compatibility
 495  * with legacy functions that accept raw query strings instead of nice
 496  * arrays.  Of course, keys and values are urldecode()d.
 497  *
 498  * @param string $query Query string
 499  * @return string[] Array version of input
 500  */
 501 function wfCgiToArray( $query ) {
 502         if ( isset( $query[0] ) && $query[0] == '?' ) {
 503                 $query = substr( $query, 1 );
 504         }
 505         $bits = explode( '&', $query );
 506         $ret = array();
 507         foreach ( $bits as $bit ) {
 508                 if ( $bit === '' ) {
 509                         continue;
 510                 }
 511                 if ( strpos( $bit, '=' ) === false ) {
 512                         // Pieces like &qwerty become 'qwerty' => '' (at least this is what php does)
 513                         $key = $bit;
 514                         $value = '';
 515                 } else {
 516                         list( $key, $value ) = explode( '=', $bit );
 517                 }
 518                 $key = urldecode( $key );
 519                 $value = urldecode( $value );
 520                 if ( strpos( $key, '[' ) !== false ) {
 521                         $keys = array_reverse( explode( '[', $key ) );
 522                         $key = array_pop( $keys );
 523                         $temp = $value;
 524                         foreach ( $keys as $k ) {
 525                                 $k = substr( $k, 0, -1 );
 526                                 $temp = array( $k => $temp );
 527                         }
 528                         if ( isset( $ret[$key] ) ) {
 529                                 $ret[$key] = array_merge( $ret[$key], $temp );
 530                         } else {
 531                                 $ret[$key] = $temp;
 532                         }
 533                 } else {
 534                         $ret[$key] = $value;
 535                 }
 536         }
 537         return $ret;
 538 }
 539
 540 /**
 541  * Append a query string to an existing URL, which may or may not already
 542  * have query string parameters already. If so, they will be combined.
 543  *
 544  * @param string $url
 545  * @param string|string[] $query String or associative array
 546  * @return string
 547  */
 548 function wfAppendQuery( $url, $query ) {
 549         if ( is_array( $query ) ) {
 550                 $query = wfArrayToCgi( $query );
 551         }
 552         if ( $query != '' ) {
 553                 if ( false === strpos( $url, '?' ) ) {
 554                         $url .= '?';
 555                 } else {
 556                         $url .= '&';
 557                 }
 558                 $url .= $query;
 559         }
 560         return $url;
 561 }
 562
 563 /**
 564  * Expand a potentially local URL to a fully-qualified URL. Assumes $wgServer
 565  * is correct.
 566  *
 567  * The meaning of the PROTO_* constants is as follows:
 568  * PROTO_HTTP: Output a URL starting with http://
 569  * PROTO_HTTPS: Output a URL starting with https://
 570  * PROTO_RELATIVE: Output a URL starting with // (protocol-relative URL)
 571  * PROTO_CURRENT: Output a URL starting with either http:// or https:// , depending
 572  *    on which protocol was used for the current incoming request
 573  * PROTO_CANONICAL: For URLs without a domain, like /w/index.php , use $wgCanonicalServer.
 574  *    For protocol-relative URLs, use the protocol of $wgCanonicalServer
 575  * PROTO_INTERNAL: Like PROTO_CANONICAL, but uses $wgInternalServer instead of $wgCanonicalServer
 576  *
 577  * @todo this won't work with current-path-relative URLs
 578  * like "subdir/foo.html", etc.
 579  *
 580  * @param string $url Either fully-qualified or a local path + query
 581  * @param string $defaultProto One of the PROTO_* constants. Determines the
 582  *    protocol to use if $url or $wgServer is protocol-relative
 583  * @return string Fully-qualified URL, current-path-relative URL or false if
 584  *    no valid URL can be constructed
 585  */
 586 function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT ) {
 587         global $wgServer, $wgCanonicalServer, $wgInternalServer, $wgRequest,
 588                 $wgHttpsPort;
 589         if ( $defaultProto === PROTO_CANONICAL ) {
 590                 $serverUrl = $wgCanonicalServer;
 591         } elseif ( $defaultProto === PROTO_INTERNAL && $wgInternalServer !== false ) {
 592                 // Make $wgInternalServer fall back to $wgServer if not set
 593                 $serverUrl = $wgInternalServer;
 594         } else {
 595                 $serverUrl = $wgServer;
 596                 if ( $defaultProto === PROTO_CURRENT ) {
 597                         $defaultProto = $wgRequest->getProtocol() . '://';
 598                 }
 599         }
 600
 601         // Analyze $serverUrl to obtain its protocol
 602         $bits = wfParseUrl( $serverUrl );
 603         $serverHasProto = $bits && $bits['scheme'] != '';
 604
 605         if ( $defaultProto === PROTO_CANONICAL || $defaultProto === PROTO_INTERNAL ) {
 606                 if ( $serverHasProto ) {
 607                         $defaultProto = $bits['scheme'] . '://';
 608                 } else {
 609                         // $wgCanonicalServer or $wgInternalServer doesn't have a protocol.
 610                         // This really isn't supposed to happen. Fall back to HTTP in this
 611                         // ridiculous case.
 612                         $defaultProto = PROTO_HTTP;
 613                 }
 614         }
 615
 616         $defaultProtoWithoutSlashes = substr( $defaultProto, 0, -2 );
 617
 618         if ( substr( $url, 0, 2 ) == '//' ) {
 619                 $url = $defaultProtoWithoutSlashes . $url;
 620         } elseif ( substr( $url, 0, 1 ) == '/' ) {
 621                 // If $serverUrl is protocol-relative, prepend $defaultProtoWithoutSlashes,
 622                 // otherwise leave it alone.
 623                 $url = ( $serverHasProto ? '' : $defaultProtoWithoutSlashes ) . $serverUrl . $url;
 624         }
 625
 626         $bits = wfParseUrl( $url );
 627
 628         // ensure proper port for HTTPS arrives in URL
 629         // https://bugzilla.wikimedia.org/show_bug.cgi?id=65184
 630         if ( $defaultProto === PROTO_HTTPS && $wgHttpsPort != 443 ) {
 631                 $bits['port'] = $wgHttpsPort;
 632         }
 633
 634         if ( $bits && isset( $bits['path'] ) ) {
 635                 $bits['path'] = wfRemoveDotSegments( $bits['path'] );
 636                 return wfAssembleUrl( $bits );
 637         } elseif ( $bits ) {
 638                 # No path to expand
 639                 return $url;
 640         } elseif ( substr( $url, 0, 1 ) != '/' ) {
 641                 # URL is a relative path
 642                 return wfRemoveDotSegments( $url );
 643         }
 644
 645         # Expanded URL is not valid.
 646         return false;
 647 }
 648
 649 /**
 650  * This function will reassemble a URL parsed with wfParseURL.  This is useful
 651  * if you need to edit part of a URL and put it back together.
 652  *
 653  * This is the basic structure used (brackets contain keys for $urlParts):
 654  * [scheme][delimiter][user]:[pass]@[host]:[port][path]?[query]#[fragment]
 655  *
 656  * @todo Need to integrate this into wfExpandUrl (bug 32168)
 657  *
 658  * @since 1.19
 659  * @param array $urlParts URL parts, as output from wfParseUrl
 660  * @return string URL assembled from its component parts
 661  */
 662 function wfAssembleUrl( $urlParts ) {
 663         $result = '';
 664
 665         if ( isset( $urlParts['delimiter'] ) ) {
 666                 if ( isset( $urlParts['scheme'] ) ) {
 667                         $result .= $urlParts['scheme'];
 668                 }
 669
 670                 $result .= $urlParts['delimiter'];
 671         }
 672
 673         if ( isset( $urlParts['host'] ) ) {
 674                 if ( isset( $urlParts['user'] ) ) {
 675                         $result .= $urlParts['user'];
 676                         if ( isset( $urlParts['pass'] ) ) {
 677                                 $result .= ':' . $urlParts['pass'];
 678                         }
 679                         $result .= '@';
 680                 }
 681
 682                 $result .= $urlParts['host'];
 683
 684                 if ( isset( $urlParts['port'] ) ) {
 685                         $result .= ':' . $urlParts['port'];
 686                 }
 687         }
 688
 689         if ( isset( $urlParts['path'] ) ) {
 690                 $result .= $urlParts['path'];
 691         }
 692
 693         if ( isset( $urlParts['query'] ) ) {
 694                 $result .= '?' . $urlParts['query'];
 695         }
 696
 697         if ( isset( $urlParts['fragment'] ) ) {
 698                 $result .= '#' . $urlParts['fragment'];
 699         }
 700
 701         return $result;
 702 }
 703
 704 /**
 705  * Remove all dot-segments in the provided URL path.  For example,
 706  * '/a/./b/../c/' becomes '/a/c/'.  For details on the algorithm, please see
 707  * RFC3986 section 5.2.4.
 708  *
 709  * @todo Need to integrate this into wfExpandUrl (bug 32168)
 710  *
 711  * @param string $urlPath URL path, potentially containing dot-segments
 712  * @return string URL path with all dot-segments removed
 713  */
 714 function wfRemoveDotSegments( $urlPath ) {
 715         $output = '';
 716         $inputOffset = 0;
 717         $inputLength = strlen( $urlPath );
 718
 719         while ( $inputOffset < $inputLength ) {
 720                 $prefixLengthOne = substr( $urlPath, $inputOffset, 1 );
 721                 $prefixLengthTwo = substr( $urlPath, $inputOffset, 2 );
 722                 $prefixLengthThree = substr( $urlPath, $inputOffset, 3 );
 723                 $prefixLengthFour = substr( $urlPath, $inputOffset, 4 );
 724                 $trimOutput = false;
 725
 726                 if ( $prefixLengthTwo == './' ) {
 727                         # Step A, remove leading "./"
 728                         $inputOffset += 2;
 729                 } elseif ( $prefixLengthThree == '../' ) {
 730                         # Step A, remove leading "../"
 731                         $inputOffset += 3;
 732                 } elseif ( ( $prefixLengthTwo == '/.' ) && ( $inputOffset + 2 == $inputLength ) ) {
 733                         # Step B, replace leading "/.$" with "/"
 734                         $inputOffset += 1;
 735                         $urlPath[$inputOffset] = '/';
 736                 } elseif ( $prefixLengthThree == '/./' ) {
 737                         # Step B, replace leading "/./" with "/"
 738                         $inputOffset += 2;
 739                 } elseif ( $prefixLengthThree == '/..' && ( $inputOffset + 3 == $inputLength ) ) {
 740                         # Step C, replace leading "/..$" with "/" and
 741                         # remove last path component in output
 742                         $inputOffset += 2;
 743                         $urlPath[$inputOffset] = '/';
 744                         $trimOutput = true;
 745                 } elseif ( $prefixLengthFour == '/../' ) {
 746                         # Step C, replace leading "/../" with "/" and
 747                         # remove last path component in output
 748                         $inputOffset += 3;
 749                         $trimOutput = true;
 750                 } elseif ( ( $prefixLengthOne == '.' ) && ( $inputOffset + 1 == $inputLength ) ) {
 751                         # Step D, remove "^.$"
 752                         $inputOffset += 1;
 753                 } elseif ( ( $prefixLengthTwo == '..' ) && ( $inputOffset + 2 == $inputLength ) ) {
 754                         # Step D, remove "^..$"
 755                         $inputOffset += 2;
 756                 } else {
 757                         # Step E, move leading path segment to output
 758                         if ( $prefixLengthOne == '/' ) {
 759                                 $slashPos = strpos( $urlPath, '/', $inputOffset + 1 );
 760                         } else {
 761                                 $slashPos = strpos( $urlPath, '/', $inputOffset );
 762                         }
 763                         if ( $slashPos === false ) {
 764                                 $output .= substr( $urlPath, $inputOffset );
 765                                 $inputOffset = $inputLength;
 766                         } else {
 767                                 $output .= substr( $urlPath, $inputOffset, $slashPos - $inputOffset );
 768                                 $inputOffset += $slashPos - $inputOffset;
 769                         }
 770                 }
 771
 772                 if ( $trimOutput ) {
 773                         $slashPos = strrpos( $output, '/' );
 774                         if ( $slashPos === false ) {
 775                                 $output = '';
 776                         } else {
 777                                 $output = substr( $output, 0, $slashPos );
 778                         }
 779                 }
 780         }
 781
 782         return $output;
 783 }
 784
 785 /**
 786  * Returns a regular expression of url protocols
 787  *
 788  * @param bool $includeProtocolRelative If false, remove '//' from the returned protocol list.
 789  *        DO NOT USE this directly, use wfUrlProtocolsWithoutProtRel() instead
 790  * @return string
 791  */
 792 function wfUrlProtocols( $includeProtocolRelative = true ) {
 793         global $wgUrlProtocols;
 794
 795         // Cache return values separately based on $includeProtocolRelative
 796         static $withProtRel = null, $withoutProtRel = null;
 797         $cachedValue = $includeProtocolRelative ? $withProtRel : $withoutProtRel;
 798         if ( !is_null( $cachedValue ) ) {
 799                 return $cachedValue;
 800         }
 801
 802         // Support old-style $wgUrlProtocols strings, for backwards compatibility
 803         // with LocalSettings files from 1.5
 804         if ( is_array( $wgUrlProtocols ) ) {
 805                 $protocols = array();
 806                 foreach ( $wgUrlProtocols as $protocol ) {
 807                         // Filter out '//' if !$includeProtocolRelative
 808                         if ( $includeProtocolRelative || $protocol !== '//' ) {
 809                                 $protocols[] = preg_quote( $protocol, '/' );
 810                         }
 811                 }
 812
 813                 $retval = implode( '|', $protocols );
 814         } else {
 815                 // Ignore $includeProtocolRelative in this case
 816                 // This case exists for pre-1.6 compatibility, and we can safely assume
 817                 // that '//' won't appear in a pre-1.6 config because protocol-relative
 818                 // URLs weren't supported until 1.18
 819                 $retval = $wgUrlProtocols;
 820         }
 821
 822         // Cache return value
 823         if ( $includeProtocolRelative ) {
 824                 $withProtRel = $retval;
 825         } else {
 826                 $withoutProtRel = $retval;
 827         }
 828         return $retval;
 829 }
 830
 831 /**
 832  * Like wfUrlProtocols(), but excludes '//' from the protocol list. Use this if
 833  * you need a regex that matches all URL protocols but does not match protocol-
 834  * relative URLs
 835  * @return string
 836  */
 837 function wfUrlProtocolsWithoutProtRel() {
 838         return wfUrlProtocols( false );
 839 }
 840
 841 /**
 842  * parse_url() work-alike, but non-broken.  Differences:
 843  *
 844  * 1) Does not raise warnings on bad URLs (just returns false).
 845  * 2) Handles protocols that don't use :// (e.g., mailto: and news:, as well as
 846  *    protocol-relative URLs) correctly.
 847  * 3) Adds a "delimiter" element to the array, either '://', ':' or '//' (see (2)).
 848  *
 849  * @param string $url A URL to parse
 850  * @return string[] Bits of the URL in an associative array, per PHP docs
 851  */
 852 function wfParseUrl( $url ) {
 853         global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
 854
 855         // Protocol-relative URLs are handled really badly by parse_url(). It's so
 856         // bad that the easiest way to handle them is to just prepend 'http:' and
 857         // strip the protocol out later.
 858         $wasRelative = substr( $url, 0, 2 ) == '//';
 859         if ( $wasRelative ) {
 860                 $url = "http:$url";
 861         }
 862         wfSuppressWarnings();
 863         $bits = parse_url( $url );
 864         wfRestoreWarnings();
 865         // parse_url() returns an array without scheme for some invalid URLs, e.g.
 866         // parse_url("%0Ahttp://example.com") == array( 'host' => '%0Ahttp', 'path' => 'example.com' )
 867         if ( !$bits || !isset( $bits['scheme'] ) ) {
 868                 return false;
 869         }
 870
 871         // parse_url() incorrectly handles schemes case-sensitively. Convert it to lowercase.
 872         $bits['scheme'] = strtolower( $bits['scheme'] );
 873
 874         // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
 875         if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
 876                 $bits['delimiter'] = '://';
 877         } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
 878                 $bits['delimiter'] = ':';
 879                 // parse_url detects for news: and mailto: the host part of an url as path
 880                 // We have to correct this wrong detection
 881                 if ( isset( $bits['path'] ) ) {
 882                         $bits['host'] = $bits['path'];
 883                         $bits['path'] = '';
 884                 }
 885         } else {
 886                 return false;
 887         }
 888
 889         /* Provide an empty host for eg. file:/// urls (see bug 28627) */
 890         if ( !isset( $bits['host'] ) ) {
 891                 $bits['host'] = '';
 892
 893                 // bug 45069
 894                 if ( isset( $bits['path'] ) ) {
 895                         /* parse_url loses the third / for file:///c:/ urls (but not on variants) */
 896                         if ( substr( $bits['path'], 0, 1 ) !== '/' ) {
 897                                 $bits['path'] = '/' . $bits['path'];
 898                         }
 899                 } else {
 900                         $bits['path'] = '';
 901                 }
 902         }
 903
 904         // If the URL was protocol-relative, fix scheme and delimiter
 905         if ( $wasRelative ) {
 906                 $bits['scheme'] = '';
 907                 $bits['delimiter'] = '//';
 908         }
 909         return $bits;
 910 }
 911
 912 /**
 913  * Take a URL, make sure it's expanded to fully qualified, and replace any
 914  * encoded non-ASCII Unicode characters with their UTF-8 original forms
 915  * for more compact display and legibility for local audiences.
 916  *
 917  * @todo handle punycode domains too
 918  *
 919  * @param string $url
 920  * @return string
 921  */
 922 function wfExpandIRI( $url ) {
 923         return preg_replace_callback(
 924                 '/((?:%[89A-F][0-9A-F])+)/i',
 925                 'wfExpandIRI_callback',
 926                 wfExpandUrl( $url )
 927         );
 928 }
 929
 930 /**
 931  * Private callback for wfExpandIRI
 932  * @param array $matches
 933  * @return string
 934  */
 935 function wfExpandIRI_callback( $matches ) {
 936         return urldecode( $matches[1] );
 937 }
 938
 939 /**
 940  * Make URL indexes, appropriate for the el_index field of externallinks.
 941  *
 942  * @param string $url
 943  * @return array
 944  */
 945 function wfMakeUrlIndexes( $url ) {
 946         $bits = wfParseUrl( $url );
 947
 948         // Reverse the labels in the hostname, convert to lower case
 949         // For emails reverse domainpart only
 950         if ( $bits['scheme'] == 'mailto' ) {
 951                 $mailparts = explode( '@', $bits['host'], 2 );
 952                 if ( count( $mailparts ) === 2 ) {
 953                         $domainpart = strtolower( implode( '.', array_reverse( explode( '.', $mailparts[1] ) ) ) );
 954                 } else {
 955                         // No domain specified, don't mangle it
 956                         $domainpart = '';
 957                 }
 958                 $reversedHost = $domainpart . '@' . $mailparts[0];
 959         } else {
 960                 $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) );
 961         }
 962         // Add an extra dot to the end
 963         // Why? Is it in wrong place in mailto links?
 964         if ( substr( $reversedHost, -1, 1 ) !== '.' ) {
 965                 $reversedHost .= '.';
 966         }
 967         // Reconstruct the pseudo-URL
 968         $prot = $bits['scheme'];
 969         $index = $prot . $bits['delimiter'] . $reversedHost;
 970         // Leave out user and password. Add the port, path, query and fragment
 971         if ( isset( $bits['port'] ) ) {
 972                 $index .= ':' . $bits['port'];
 973         }
 974         if ( isset( $bits['path'] ) ) {
 975                 $index .= $bits['path'];
 976         } else {
 977                 $index .= '/';
 978         }
 979         if ( isset( $bits['query'] ) ) {
 980                 $index .= '?' . $bits['query'];
 981         }
 982         if ( isset( $bits['fragment'] ) ) {
 983                 $index .= '#' . $bits['fragment'];
 984         }
 985
 986         if ( $prot == '' ) {
 987                 return array( "http:$index", "https:$index" );
 988         } else {
 989                 return array( $index );
 990         }
 991 }
 992
 993 /**
 994  * Check whether a given URL has a domain that occurs in a given set of domains
 995  * @param string $url URL
 996  * @param array $domains Array of domains (strings)
 997  * @return bool True if the host part of $url ends in one of the strings in $domains
 998  */
 999 function wfMatchesDomainList( $url, $domains ) {
1000         $bits = wfParseUrl( $url );
1001         if ( is_array( $bits ) && isset( $bits['host'] ) ) {
1002                 $host = '.' . $bits['host'];
1003                 foreach ( (array)$domains as $domain ) {
1004                         $domain = '.' . $domain;
1005                         if ( substr( $host, -strlen( $domain ) ) === $domain ) {
1006                                 return true;
1007                         }
1008                 }
1009         }
1010         return false;
1011 }
1012
1013 /**
1014  * Sends a line to the debug log if enabled or, optionally, to a comment in output.
1015  * In normal operation this is a NOP.
1016  *
1017  * Controlling globals:
1018  * $wgDebugLogFile - points to the log file
1019  * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
1020  * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
1021  *
1022  * @since 1.25 support for additional context data
1023  *
1024  * @param string $text
1025  * @param string|bool $dest Unused
1026  * @param array $context Additional logging context data
1027  */
1028 function wfDebug( $text, $dest = 'all', array $context = array() ) {
1029         global $wgDebugRawPage, $wgDebugLogPrefix;
1030         global $wgDebugTimestamps, $wgRequestTime;
1031
1032         if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1033                 return;
1034         }
1035
1036         $text = trim( $text );
1037
1038         // Inline logic from deprecated wfDebugTimer()
1039         if ( $wgDebugTimestamps ) {
1040                 $context['seconds_elapsed'] = sprintf(
1041                         '%6.4f',
1042                         microtime( true ) - $wgRequestTime
1043                 );
1044                 $context['memory_used'] = sprintf(
1045                         '%5.1fM',
1046                         ( memory_get_usage( true ) / ( 1024 * 1024 ) )
1047                 );
1048         }
1049
1050         if ( $wgDebugLogPrefix !== '' ) {
1051                 $context['prefix'] = $wgDebugLogPrefix;
1052         }
1053
1054         $logger = MWLoggerFactory::getInstance( 'wfDebug' );
1055         $logger->debug( $text, $context );
1056 }
1057
1058 /**
1059  * Returns true if debug logging should be suppressed if $wgDebugRawPage = false
1060  * @return bool
1061  */
1062 function wfIsDebugRawPage() {
1063         static $cache;
1064         if ( $cache !== null ) {
1065                 return $cache;
1066         }
1067         # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
1068         if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
1069                 || (
1070                         isset( $_SERVER['SCRIPT_NAME'] )
1071                         && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
1072                 )
1073         ) {
1074                 $cache = true;
1075         } else {
1076                 $cache = false;
1077         }
1078         return $cache;
1079 }
1080
1081 /**
1082  * Get microsecond timestamps for debug logs
1083  *
1084  * @deprecated since 1.25
1085  * @return string
1086  */
1087 function wfDebugTimer() {
1088         global $wgDebugTimestamps, $wgRequestTime;
1089
1090         wfDeprecated( __METHOD__, '1.25' );
1091
1092         if ( !$wgDebugTimestamps ) {
1093                 return '';
1094         }
1095
1096         $prefix = sprintf( "%6.4f", microtime( true ) - $wgRequestTime );
1097         $mem = sprintf( "%5.1fM", ( memory_get_usage( true ) / ( 1024 * 1024 ) ) );
1098         return "$prefix $mem  ";
1099 }
1100
1101 /**
1102  * Send a line giving PHP memory usage.
1103  *
1104  * @param bool $exact Print exact byte values instead of kibibytes (default: false)
1105  */
1106 function wfDebugMem( $exact = false ) {
1107         $mem = memory_get_usage();
1108         if ( !$exact ) {
1109                 $mem = floor( $mem / 1024 ) . ' KiB';
1110         } else {
1111                 $mem .= ' B';
1112         }
1113         wfDebug( "Memory usage: $mem\n" );
1114 }
1115
1116 /**
1117  * Send a line to a supplementary debug log file, if configured, or main debug
1118  * log if not.
1119  *
1120  * To configure a supplementary log file, set $wgDebugLogGroups[$logGroup] to
1121  * a string filename or an associative array mapping 'destination' to the
1122  * desired filename. The associative array may also contain a 'sample' key
1123  * with an integer value, specifying a sampling factor. Sampled log events
1124  * will be emitted with a 1 in N random chance.
1125  *
1126  * @since 1.23 support for sampling log messages via $wgDebugLogGroups.
1127  * @since 1.25 support for additional context data
1128  * @since 1.25 sample behavior dependent on configured $wgMWLoggerDefaultSpi
1129  *
1130  * @param string $logGroup
1131  * @param string $text
1132  * @param string|bool $dest Destination of the message:
1133  *     - 'all': both to the log and HTML (debug toolbar or HTML comments)
1134  *     - 'log': only to the log and not in HTML
1135  *     - 'private': only to the specific log if set in $wgDebugLogGroups and
1136  *       discarded otherwise
1137  *   For backward compatibility, it can also take a boolean:
1138  *     - true: same as 'all'
1139  *     - false: same as 'private'
1140  * @param array $context Additional logging context data
1141  */
1142 function wfDebugLog(
1143         $logGroup, $text, $dest = 'all', array $context = array()
1144 ) {
1145         // Turn $dest into a string if it's a boolean (for b/c)
1146         if ( $dest === true ) {
1147                 $dest = 'all';
1148         } elseif ( $dest === false ) {
1149                 $dest = 'private';
1150         }
1151
1152         $text = trim( $text );
1153
1154         $logger = MWLoggerFactory::getInstance( $logGroup );
1155         $context['private'] = ( $dest === 'private' );
1156         $logger->info( $text, $context );
1157 }
1158
1159 /**
1160  * Log for database errors
1161  *
1162  * @since 1.25 support for additional context data
1163  *
1164  * @param string $text Database error message.
1165  * @param array $context Additional logging context data
1166  */
1167 function wfLogDBError( $text, array $context = array() ) {
1168         $logger = MWLoggerFactory::getInstance( 'wfLogDBError' );
1169         $logger->error( trim( $text ), $context );
1170 }
1171
1172 /**
1173  * Throws a warning that $function is deprecated
1174  *
1175  * @param string $function
1176  * @param string|bool $version Version of MediaWiki that the function
1177  *    was deprecated in (Added in 1.19).
1178  * @param string|bool $component Added in 1.19.
1179  * @param int $callerOffset How far up the call stack is the original
1180  *    caller. 2 = function that called the function that called
1181  *    wfDeprecated (Added in 1.20)
1182  *
1183  * @return null
1184  */
1185 function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) {
1186         MWDebug::deprecated( $function, $version, $component, $callerOffset + 1 );
1187 }
1188
1189 /**
1190  * Send a warning either to the debug log or in a PHP error depending on
1191  * $wgDevelopmentWarnings. To log warnings in production, use wfLogWarning() instead.
1192  *
1193  * @param string $msg Message to send
1194  * @param int $callerOffset Number of items to go back in the backtrace to
1195  *        find the correct caller (1 = function calling wfWarn, ...)
1196  * @param int $level PHP error level; defaults to E_USER_NOTICE;
1197  *        only used when $wgDevelopmentWarnings is true
1198  */
1199 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE ) {
1200         MWDebug::warning( $msg, $callerOffset + 1, $level, 'auto' );
1201 }
1202
1203 /**
1204  * Send a warning as a PHP error and the debug log. This is intended for logging
1205  * warnings in production. For logging development warnings, use WfWarn instead.
1206  *
1207  * @param string $msg Message to send
1208  * @param int $callerOffset Number of items to go back in the backtrace to
1209  *        find the correct caller (1 = function calling wfLogWarning, ...)
1210  * @param int $level PHP error level; defaults to E_USER_WARNING
1211  */
1212 function wfLogWarning( $msg, $callerOffset = 1, $level = E_USER_WARNING ) {
1213         MWDebug::warning( $msg, $callerOffset + 1, $level, 'production' );
1214 }
1215
1216 /**
1217  * Log to a file without getting "file size exceeded" signals.
1218  *
1219  * Can also log to TCP or UDP with the syntax udp://host:port/prefix. This will
1220  * send lines to the specified port, prefixed by the specified prefix and a space.
1221  * @since 1.25 support for additional context data
1222  *
1223  * @param string $text
1224  * @param string $file Filename
1225  * @param array $context Additional logging context data
1226  * @throws MWException
1227  * @deprecated since 1.25 Use MWLoggerLegacyLogger::emit or UDPTransport
1228  */
1229 function wfErrorLog( $text, $file, array $context = array() ) {
1230         wfDeprecated( __METHOD__, '1.25' );
1231         $logger = MWLoggerFactory::getInstance( 'wfErrorLog' );
1232         $context['destination'] = $file;
1233         $logger->info( trim( $text ), $context );
1234 }
1235
1236 /**
1237  * @todo document
1238  */
1239 function wfLogProfilingData() {
1240         global $wgRequestTime, $wgDebugLogGroups, $wgDebugRawPage;
1241         global $wgProfileLimit, $wgUser, $wgRequest;
1242
1243         $context = RequestContext::getMain();
1244         $config = $context->getConfig();
1245         if ( $config->has( 'StatsdServer' ) ) {
1246                 $statsdServer = explode( ':', $config->get( 'StatsdServer' ) );
1247                 $statsdHost = $statsdServer[0];
1248                 $statsdPort = isset( $statsdServer[1] ) ? $statsdServer[1] : 8125;
1249                 $statsdSender = new SocketSender( $statsdHost, $statsdPort );
1250                 $statsdClient = new StatsdClient( $statsdSender );
1251                 $statsdClient->send( $context->getStats()->getBuffer() );
1252         }
1253
1254         $profiler = Profiler::instance();
1255
1256         # Profiling must actually be enabled...
1257         if ( $profiler instanceof ProfilerStub ) {
1258                 return;
1259         }
1260
1261         // Get total page request time and only show pages that longer than
1262         // $wgProfileLimit time (default is 0)
1263         $elapsed = microtime( true ) - $wgRequestTime;
1264         if ( $elapsed <= $wgProfileLimit ) {
1265                 return;
1266         }
1267
1268         $profiler->logData();
1269
1270         if ( isset( $wgDebugLogGroups['profileoutput'] )
1271                 && $wgDebugLogGroups['profileoutput'] === false
1272         ) {
1273                 // Explicitly disabled
1274                 return;
1275         }
1276         if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1277                 return;
1278         }
1279
1280         $ctx = array( 'elapsed' => $elapsed );
1281         if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1282                 $ctx['forwarded_for'] = $_SERVER['HTTP_X_FORWARDED_FOR'];
1283         }
1284         if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1285                 $ctx['client_ip'] = $_SERVER['HTTP_CLIENT_IP'];
1286         }
1287         if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1288                 $ctx['from'] = $_SERVER['HTTP_FROM'];
1289         }
1290         if ( isset( $ctx['forwarded_for'] ) ||
1291                 isset( $ctx['client_ip'] ) ||
1292                 isset( $ctx['from'] ) ) {
1293                 $ctx['proxy'] = $_SERVER['REMOTE_ADDR'];
1294         }
1295
1296         // Don't load $wgUser at this late stage just for statistics purposes
1297         // @todo FIXME: We can detect some anons even if it is not loaded.
1298         // See User::getId()
1299         if ( $wgUser->isItemLoaded( 'id' ) && $wgUser->isAnon() ) {
1300                 $ctx['anon'] = true;
1301         } else {
1302                 $ctx['anon'] = false;
1303         }
1304
1305         // Command line script uses a FauxRequest object which does not have
1306         // any knowledge about an URL and throw an exception instead.
1307         try {
1308                 $ctx['url'] = urldecode( $wgRequest->getRequestURL() );
1309         } catch ( Exception $ignored ) {
1310                 // no-op
1311         }
1312
1313         $ctx['output'] = $profiler->getOutput();
1314
1315         $log = MWLoggerFactory::getInstance( 'profileoutput' );
1316         $log->info( "Elapsed: {elapsed}; URL: <{url}>\n{output}", $ctx );
1317 }
1318
1319 /**
1320  * Increment a statistics counter
1321  *
1322  * @param string $key
1323  * @param int $count
1324  * @return void
1325  */
1326 function wfIncrStats( $key, $count = 1 ) {
1327         $stats = RequestContext::getMain()->getStats();
1328         $stats->updateCount( $key, $count );
1329 }
1330
1331 /**
1332  * Check whether the wiki is in read-only mode.
1333  *
1334  * @return bool
1335  */
1336 function wfReadOnly() {
1337         return wfReadOnlyReason() !== false;
1338 }
1339
1340 /**
1341  * Get the value of $wgReadOnly or the contents of $wgReadOnlyFile.
1342  *
1343  * @return string|bool String when in read-only mode; false otherwise
1344  */
1345 function wfReadOnlyReason() {
1346         global $wgReadOnly, $wgReadOnlyFile;
1347
1348         if ( $wgReadOnly === null ) {
1349                 // Set $wgReadOnly for faster access next time
1350                 if ( is_file( $wgReadOnlyFile ) && filesize( $wgReadOnlyFile ) > 0 ) {
1351                         $wgReadOnly = file_get_contents( $wgReadOnlyFile );
1352                 } else {
1353                         $wgReadOnly = false;
1354                 }
1355         }
1356
1357         return $wgReadOnly;
1358 }
1359
1360 /**
1361  * Return a Language object from $langcode
1362  *
1363  * @param Language|string|bool $langcode Either:
1364  *                  - a Language object
1365  *                  - code of the language to get the message for, if it is
1366  *                    a valid code create a language for that language, if
1367  *                    it is a string but not a valid code then make a basic
1368  *                    language object
1369  *                  - a boolean: if it's false then use the global object for
1370  *                    the current user's language (as a fallback for the old parameter
1371  *                    functionality), or if it is true then use global object
1372  *                    for the wiki's content language.
1373  * @return Language
1374  */
1375 function wfGetLangObj( $langcode = false ) {
1376         # Identify which language to get or create a language object for.
1377         # Using is_object here due to Stub objects.
1378         if ( is_object( $langcode ) ) {
1379                 # Great, we already have the object (hopefully)!
1380                 return $langcode;
1381         }
1382
1383         global $wgContLang, $wgLanguageCode;
1384         if ( $langcode === true || $langcode === $wgLanguageCode ) {
1385                 # $langcode is the language code of the wikis content language object.
1386                 # or it is a boolean and value is true
1387                 return $wgContLang;
1388         }
1389
1390         global $wgLang;
1391         if ( $langcode === false || $langcode === $wgLang->getCode() ) {
1392                 # $langcode is the language code of user language object.
1393                 # or it was a boolean and value is false
1394                 return $wgLang;
1395         }
1396
1397         $validCodes = array_keys( Language::fetchLanguageNames() );
1398         if ( in_array( $langcode, $validCodes ) ) {
1399                 # $langcode corresponds to a valid language.
1400                 return Language::factory( $langcode );
1401         }
1402
1403         # $langcode is a string, but not a valid language code; use content language.
1404         wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1405         return $wgContLang;
1406 }
1407
1408 /**
1409  * This is the function for getting translated interface messages.
1410  *
1411  * @see Message class for documentation how to use them.
1412  * @see https://www.mediawiki.org/wiki/Manual:Messages_API
1413  *
1414  * This function replaces all old wfMsg* functions.
1415  *
1416  * @param string|string[] $key Message key, or array of keys
1417  * @param mixed $params,... Normal message parameters
1418  * @return Message
1419  *
1420  * @since 1.17
1421  *
1422  * @see Message::__construct
1423  */
1424 function wfMessage( $key /*...*/ ) {
1425         $params = func_get_args();
1426         array_shift( $params );
1427         if ( isset( $params[0] ) && is_array( $params[0] ) ) {
1428                 $params = $params[0];
1429         }
1430         return new Message( $key, $params );
1431 }
1432
1433 /**
1434  * This function accepts multiple message keys and returns a message instance
1435  * for the first message which is non-empty. If all messages are empty then an
1436  * instance of the first message key is returned.
1437  *
1438  * @param string|string[] $keys,... Message keys
1439  * @return Message
1440  *
1441  * @since 1.18
1442  *
1443  * @see Message::newFallbackSequence
1444  */
1445 function wfMessageFallback( /*...*/ ) {
1446         $args = func_get_args();
1447         return call_user_func_array( 'Message::newFallbackSequence', $args );
1448 }
1449
1450 /**
1451  * Get a message from anywhere, for the current user language.
1452  *
1453  * Use wfMsgForContent() instead if the message should NOT
1454  * change depending on the user preferences.
1455  *
1456  * @deprecated since 1.18
1457  *
1458  * @param string $key Lookup key for the message, usually
1459  *    defined in languages/Language.php
1460  *
1461  * Parameters to the message, which can be used to insert variable text into
1462  * it, can be passed to this function in the following formats:
1463  * - One per argument, starting at the second parameter
1464  * - As an array in the second parameter
1465  * These are not shown in the function definition.
1466  *
1467  * @return string
1468  */
1469 function wfMsg( $key ) {
1470         wfDeprecated( __METHOD__, '1.21' );
1471
1472         $args = func_get_args();
1473         array_shift( $args );
1474         return wfMsgReal( $key, $args );
1475 }
1476
1477 /**
1478  * Same as above except doesn't transform the message
1479  *
1480  * @deprecated since 1.18
1481  *
1482  * @param string $key
1483  * @return string
1484  */
1485 function wfMsgNoTrans( $key ) {
1486         wfDeprecated( __METHOD__, '1.21' );
1487
1488         $args = func_get_args();
1489         array_shift( $args );
1490         return wfMsgReal( $key, $args, true, false, false );
1491 }
1492
1493 /**
1494  * Get a message from anywhere, for the current global language
1495  * set with $wgLanguageCode.
1496  *
1497  * Use this if the message should NOT change dependent on the
1498  * language set in the user's preferences. This is the case for
1499  * most text written into logs, as well as link targets (such as
1500  * the name of the copyright policy page). Link titles, on the
1501  * other hand, should be shown in the UI language.
1502  *
1503  * Note that MediaWiki allows users to change the user interface
1504  * language in their preferences, but a single installation
1505  * typically only contains content in one language.
1506  *
1507  * Be wary of this distinction: If you use wfMsg() where you should
1508  * use wfMsgForContent(), a user of the software may have to
1509  * customize potentially hundreds of messages in
1510  * order to, e.g., fix a link in every possible language.
1511  *
1512  * @deprecated since 1.18
1513  *
1514  * @param string $key Lookup key for the message, usually
1515  *     defined in languages/Language.php
1516  * @return string
1517  */
1518 function wfMsgForContent( $key ) {
1519         wfDeprecated( __METHOD__, '1.21' );
1520
1521         global $wgForceUIMsgAsContentMsg;
1522         $args = func_get_args();
1523         array_shift( $args );
1524         $forcontent = true;
1525         if ( is_array( $wgForceUIMsgAsContentMsg )
1526                 && in_array( $key, $wgForceUIMsgAsContentMsg )
1527         ) {
1528                 $forcontent = false;
1529         }
1530         return wfMsgReal( $key, $args, true, $forcontent );
1531 }
1532
1533 /**
1534  * Same as above except doesn't transform the message
1535  *
1536  * @deprecated since 1.18
1537  *
1538  * @param string $key
1539  * @return string
1540  */
1541 function wfMsgForContentNoTrans( $key ) {
1542         wfDeprecated( __METHOD__, '1.21' );
1543
1544         global $wgForceUIMsgAsContentMsg;
1545         $args = func_get_args();
1546         array_shift( $args );
1547         $forcontent = true;
1548         if ( is_array( $wgForceUIMsgAsContentMsg )
1549                 && in_array( $key, $wgForceUIMsgAsContentMsg )
1550         ) {
1551                 $forcontent = false;
1552         }
1553         return wfMsgReal( $key, $args, true, $forcontent, false );
1554 }
1555
1556 /**
1557  * Really get a message
1558  *
1559  * @deprecated since 1.18
1560  *
1561  * @param string $key Key to get.
1562  * @param array $args
1563  * @param bool $useDB
1564  * @param string|bool $forContent Language code, or false for user lang, true for content lang.
1565  * @param bool $transform Whether or not to transform the message.
1566  * @return string The requested message.
1567  */
1568 function wfMsgReal( $key, $args, $useDB = true, $forContent = false, $transform = true ) {
1569         wfDeprecated( __METHOD__, '1.21' );
1570
1571         $message = wfMsgGetKey( $key, $useDB, $forContent, $transform );
1572         $message = wfMsgReplaceArgs( $message, $args );
1573         return $message;
1574 }
1575
1576 /**
1577  * Fetch a message string value, but don't replace any keys yet.
1578  *
1579  * @deprecated since 1.18
1580  *
1581  * @param string $key
1582  * @param bool $useDB
1583  * @param string|bool $langCode Code of the language to get the message for, or
1584  *   behaves as a content language switch if it is a boolean.
1585  * @param bool $transform Whether to parse magic words, etc.
1586  * @return string
1587  */
1588 function wfMsgGetKey( $key, $useDB = true, $langCode = false, $transform = true ) {
1589         wfDeprecated( __METHOD__, '1.21' );
1590
1591         Hooks::run( 'NormalizeMessageKey', array( &$key, &$useDB, &$langCode, &$transform ) );
1592
1593         $cache = MessageCache::singleton();
1594         $message = $cache->get( $key, $useDB, $langCode );
1595         if ( $message === false ) {
1596                 $message = '&lt;' . htmlspecialchars( $key ) . '&gt;';
1597         } elseif ( $transform ) {
1598                 $message = $cache->transform( $message );
1599         }
1600         return $message;
1601 }
1602
1603 /**
1604  * Replace message parameter keys on the given formatted output.
1605  *
1606  * @param string $message
1607  * @param array $args
1608  * @return string
1609  * @private
1610  */
1611 function wfMsgReplaceArgs( $message, $args ) {
1612         # Fix windows line-endings
1613         # Some messages are split with explode("\n", $msg)
1614         $message = str_replace( "\r", '', $message );
1615
1616         // Replace arguments
1617         if ( count( $args ) ) {
1618                 if ( is_array( $args[0] ) ) {
1619                         $args = array_values( $args[0] );
1620                 }
1621                 $replacementKeys = array();
1622                 foreach ( $args as $n => $param ) {
1623                         $replacementKeys['$' . ( $n + 1 )] = $param;
1624                 }
1625                 $message = strtr( $message, $replacementKeys );
1626         }
1627
1628         return $message;
1629 }
1630
1631 /**
1632  * Return an HTML-escaped version of a message.
1633  * Parameter replacements, if any, are done *after* the HTML-escaping,
1634  * so parameters may contain HTML (eg links or form controls). Be sure
1635  * to pre-escape them if you really do want plaintext, or just wrap
1636  * the whole thing in htmlspecialchars().
1637  *
1638  * @deprecated since 1.18
1639  *
1640  * @param string $key
1641  * @param string $args,... Parameters
1642  * @return string
1643  */
1644 function wfMsgHtml( $key ) {
1645         wfDeprecated( __METHOD__, '1.21' );
1646
1647         $args = func_get_args();
1648         array_shift( $args );
1649         return wfMsgReplaceArgs( htmlspecialchars( wfMsgGetKey( $key ) ), $args );
1650 }
1651
1652 /**
1653  * Return an HTML version of message
1654  * Parameter replacements, if any, are done *after* parsing the wiki-text message,
1655  * so parameters may contain HTML (eg links or form controls). Be sure
1656  * to pre-escape them if you really do want plaintext, or just wrap
1657  * the whole thing in htmlspecialchars().
1658  *
1659  * @deprecated since 1.18
1660  *
1661  * @param string $key
1662  * @param string $args,... Parameters
1663  * @return string
1664  */
1665 function wfMsgWikiHtml( $key ) {
1666         wfDeprecated( __METHOD__, '1.21' );
1667
1668         $args = func_get_args();
1669         array_shift( $args );
1670         return wfMsgReplaceArgs(
1671                 MessageCache::singleton()->parse( wfMsgGetKey( $key ), null,
1672                 /* can't be set to false */ true, /* interface */ true )->getText(),
1673                 $args );
1674 }
1675
1676 /**
1677  * Returns message in the requested format
1678  *
1679  * @deprecated since 1.18
1680  *
1681  * @param string $key Key of the message
1682  * @param array $options Processing rules.
1683  *   Can take the following options:
1684  *     parse: parses wikitext to HTML
1685  *     parseinline: parses wikitext to HTML and removes the surrounding
1686  *       p's added by parser or tidy
1687  *     escape: filters message through htmlspecialchars
1688  *     escapenoentities: same, but allows entity references like &#160; through
1689  *     replaceafter: parameters are substituted after parsing or escaping
1690  *     parsemag: transform the message using magic phrases
1691  *     content: fetch message for content language instead of interface
1692  *   Also can accept a single associative argument, of the form 'language' => 'xx':
1693  *     language: Language object or language code to fetch message for
1694  *       (overridden by content).
1695  * Behavior for conflicting options (e.g., parse+parseinline) is undefined.
1696  *
1697  * @return string
1698  */
1699 function wfMsgExt( $key, $options ) {
1700         wfDeprecated( __METHOD__, '1.21' );
1701
1702         $args = func_get_args();
1703         array_shift( $args );
1704         array_shift( $args );
1705         $options = (array)$options;
1706         $validOptions = array( 'parse', 'parseinline', 'escape', 'escapenoentities', 'replaceafter',
1707                 'parsemag', 'content' );
1708
1709         foreach ( $options as $arrayKey => $option ) {
1710                 if ( !preg_match( '/^[0-9]+|language$/', $arrayKey ) ) {
1711                         // An unknown index, neither numeric nor "language"
1712                         wfWarn( "wfMsgExt called with incorrect parameter key $arrayKey", 1, E_USER_WARNING );
1713                 } elseif ( preg_match( '/^[0-9]+$/', $arrayKey ) && !in_array( $option, $validOptions ) ) {
1714                         // A numeric index with unknown value
1715                         wfWarn( "wfMsgExt called with incorrect parameter $option", 1, E_USER_WARNING );
1716                 }
1717         }
1718
1719         if ( in_array( 'content', $options, true ) ) {
1720                 $forContent = true;
1721                 $langCode = true;
1722                 $langCodeObj = null;
1723         } elseif ( array_key_exists( 'language', $options ) ) {
1724                 $forContent = false;
1725                 $langCode = wfGetLangObj( $options['language'] );
1726                 $langCodeObj = $langCode;
1727         } else {
1728                 $forContent = false;
1729                 $langCode = false;
1730                 $langCodeObj = null;
1731         }
1732
1733         $string = wfMsgGetKey( $key, /*DB*/true, $langCode, /*Transform*/false );
1734
1735         if ( !in_array( 'replaceafter', $options, true ) ) {
1736                 $string = wfMsgReplaceArgs( $string, $args );
1737         }
1738
1739         $messageCache = MessageCache::singleton();
1740         $parseInline = in_array( 'parseinline', $options, true );
1741         if ( in_array( 'parse', $options, true ) || $parseInline ) {
1742                 $string = $messageCache->parse( $string, null, true, !$forContent, $langCodeObj );
1743                 if ( $string instanceof ParserOutput ) {
1744                         $string = $string->getText();
1745                 }
1746
1747                 if ( $parseInline ) {
1748                         $string = Parser::stripOuterParagraph( $string );
1749                 }
1750         } elseif ( in_array( 'parsemag', $options, true ) ) {
1751                 $string = $messageCache->transform( $string,
1752                                 !$forContent, $langCodeObj );
1753         }
1754
1755         if ( in_array( 'escape', $options, true ) ) {
1756                 $string = htmlspecialchars ( $string );
1757         } elseif ( in_array( 'escapenoentities', $options, true ) ) {
1758                 $string = Sanitizer::escapeHtmlAllowEntities( $string );
1759         }
1760
1761         if ( in_array( 'replaceafter', $options, true ) ) {
1762                 $string = wfMsgReplaceArgs( $string, $args );
1763         }
1764
1765         return $string;
1766 }
1767
1768 /**
1769  * Since wfMsg() and co suck, they don't return false if the message key they
1770  * looked up didn't exist but instead the key wrapped in <>'s, this function checks for the
1771  * nonexistence of messages by checking the MessageCache::get() result directly.
1772  *
1773  * @deprecated since 1.18. Use Message::isDisabled().
1774  *
1775  * @param string $key The message key looked up
1776  * @return bool True if the message *doesn't* exist.
1777  */
1778 function wfEmptyMsg( $key ) {
1779         wfDeprecated( __METHOD__, '1.21' );
1780
1781         return MessageCache::singleton()->get( $key, /*useDB*/true, /*content*/false ) === false;
1782 }
1783
1784 /**
1785  * Fetch server name for use in error reporting etc.
1786  * Use real server name if available, so we know which machine
1787  * in a server farm generated the current page.
1788  *
1789  * @return string
1790  */
1791 function wfHostname() {
1792         static $host;
1793         if ( is_null( $host ) ) {
1794
1795                 # Hostname overriding
1796                 global $wgOverrideHostname;
1797                 if ( $wgOverrideHostname !== false ) {
1798                         # Set static and skip any detection
1799                         $host = $wgOverrideHostname;
1800                         return $host;
1801                 }
1802
1803                 if ( function_exists( 'posix_uname' ) ) {
1804                         // This function not present on Windows
1805                         $uname = posix_uname();
1806                 } else {
1807                         $uname = false;
1808                 }
1809                 if ( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1810                         $host = $uname['nodename'];
1811                 } elseif ( getenv( 'COMPUTERNAME' ) ) {
1812                         # Windows computer name
1813                         $host = getenv( 'COMPUTERNAME' );
1814                 } else {
1815                         # This may be a virtual server.
1816                         $host = $_SERVER['SERVER_NAME'];
1817                 }
1818         }
1819         return $host;
1820 }
1821
1822 /**
1823  * Returns a script tag that stores the amount of time it took MediaWiki to
1824  * handle the request in milliseconds as 'wgBackendResponseTime'.
1825  *
1826  * If $wgShowHostnames is true, the script will also set 'wgHostname' to the
1827  * hostname of the server handling the request.
1828  *
1829  * @return string
1830  */
1831 function wfReportTime() {
1832         global $wgRequestTime, $wgShowHostnames;
1833
1834         $responseTime = round( ( microtime( true ) - $wgRequestTime ) * 1000 );
1835         $reportVars = array( 'wgBackendResponseTime' => $responseTime );
1836         if ( $wgShowHostnames ) {
1837                 $reportVars['wgHostname'] = wfHostname();
1838         }
1839         return Skin::makeVariablesScript( $reportVars );
1840 }
1841
1842 /**
1843  * Safety wrapper for debug_backtrace().
1844  *
1845  * Will return an empty array if debug_backtrace is disabled, otherwise
1846  * the output from debug_backtrace() (trimmed).
1847  *
1848  * @param int $limit This parameter can be used to limit the number of stack frames returned
1849  *
1850  * @return array Array of backtrace information
1851  */
1852 function wfDebugBacktrace( $limit = 0 ) {
1853         static $disabled = null;
1854
1855         if ( is_null( $disabled ) ) {
1856                 $disabled = !function_exists( 'debug_backtrace' );
1857                 if ( $disabled ) {
1858                         wfDebug( "debug_backtrace() is disabled\n" );
1859                 }
1860         }
1861         if ( $disabled ) {
1862                 return array();
1863         }
1864
1865         if ( $limit && version_compare( PHP_VERSION, '5.4.0', '>=' ) ) {
1866                 return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT, $limit + 1 ), 1 );
1867         } else {
1868                 return array_slice( debug_backtrace(), 1 );
1869         }
1870 }
1871
1872 /**
1873  * Get a debug backtrace as a string
1874  *
1875  * @param bool|null $raw If true, the return value is plain text. If false, HTML.
1876  *   Defaults to $wgCommandLineMode if unset.
1877  * @return string
1878  * @since 1.25 Supports $raw parameter.
1879  */
1880 function wfBacktrace( $raw = null ) {
1881         global $wgCommandLineMode;
1882
1883         if ( $raw === null ) {
1884                 $raw = $wgCommandLineMode;
1885         }
1886
1887         if ( $raw ) {
1888                 $frameFormat = "%s line %s calls %s()\n";
1889                 $traceFormat = "%s";
1890         } else {
1891                 $frameFormat = "<li>%s line %s calls %s()</li>\n";
1892                 $traceFormat = "<ul>\n%s</ul>\n";
1893         }
1894
1895         $frames = array_map( function ( $frame ) use ( $frameFormat ) {
1896                 $file = !empty( $frame['file'] ) ? basename( $frame['file'] ) : '-';
1897                 $line = isset( $frame['line'] ) ? $frame['line'] : '-';
1898                 $call = $frame['function'];
1899                 if ( !empty( $frame['class'] ) ) {
1900                         $call = $frame['class'] . $frame['type'] . $call;
1901                 }
1902                 return sprintf( $frameFormat, $file, $line, $call );
1903         }, wfDebugBacktrace() );
1904
1905         return sprintf( $traceFormat, implode( '', $frames ) );
1906 }
1907
1908 /**
1909  * Get the name of the function which called this function
1910  * wfGetCaller( 1 ) is the function with the wfGetCaller() call (ie. __FUNCTION__)
1911  * wfGetCaller( 2 ) [default] is the caller of the function running wfGetCaller()
1912  * wfGetCaller( 3 ) is the parent of that.
1913  *
1914  * @param int $level
1915  * @return string
1916  */
1917 function wfGetCaller( $level = 2 ) {
1918         $backtrace = wfDebugBacktrace( $level + 1 );
1919         if ( isset( $backtrace[$level] ) ) {
1920                 return wfFormatStackFrame( $backtrace[$level] );
1921         } else {
1922                 return 'unknown';
1923         }
1924 }
1925
1926 /**
1927  * Return a string consisting of callers in the stack. Useful sometimes
1928  * for profiling specific points.
1929  *
1930  * @param int $limit The maximum depth of the stack frame to return, or false for the entire stack.
1931  * @return string
1932  */
1933 function wfGetAllCallers( $limit = 3 ) {
1934         $trace = array_reverse( wfDebugBacktrace() );
1935         if ( !$limit || $limit > count( $trace ) - 1 ) {
1936                 $limit = count( $trace ) - 1;
1937         }
1938         $trace = array_slice( $trace, -$limit - 1, $limit );
1939         return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1940 }
1941
1942 /**
1943  * Return a string representation of frame
1944  *
1945  * @param array $frame
1946  * @return string
1947  */
1948 function wfFormatStackFrame( $frame ) {
1949         return isset( $frame['class'] ) ?
1950                 $frame['class'] . '::' . $frame['function'] :
1951                 $frame['function'];
1952 }
1953
1954 /* Some generic result counters, pulled out of SearchEngine */
1955
1956 /**
1957  * @todo document
1958  *
1959  * @param int $offset
1960  * @param int $limit
1961  * @return string
1962  */
1963 function wfShowingResults( $offset, $limit ) {
1964         return wfMessage( 'showingresults' )->numParams( $limit, $offset + 1 )->parse();
1965 }
1966
1967 /**
1968  * @todo document
1969  * @todo FIXME: We may want to blacklist some broken browsers
1970  *
1971  * @param bool $force
1972  * @return bool Whereas client accept gzip compression
1973  */
1974 function wfClientAcceptsGzip( $force = false ) {
1975         static $result = null;
1976         if ( $result === null || $force ) {
1977                 $result = false;
1978                 if ( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
1979                         # @todo FIXME: We may want to blacklist some broken browsers
1980                         $m = array();
1981                         if ( preg_match(
1982                                         '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
1983                                         $_SERVER['HTTP_ACCEPT_ENCODING'],
1984                                         $m
1985                                 )
1986                         ) {
1987                                 if ( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
1988                                         $result = false;
1989                                         return $result;
1990                                 }
1991                                 wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
1992                                 $result = true;
1993                         }
1994                 }
1995         }
1996         return $result;
1997 }
1998
1999 /**
2000  * Obtain the offset and limit values from the request string;
2001  * used in special pages
2002  *
2003  * @param int $deflimit Default limit if none supplied
2004  * @param string $optionname Name of a user preference to check against
2005  * @return array
2006  * @deprecated since 1.24, just call WebRequest::getLimitOffset() directly
2007  */
2008 function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
2009         global $wgRequest;
2010         wfDeprecated( __METHOD__, '1.24' );
2011         return $wgRequest->getLimitOffset( $deflimit, $optionname );
2012 }
2013
2014 /**
2015  * Escapes the given text so that it may be output using addWikiText()
2016  * without any linking, formatting, etc. making its way through. This
2017  * is achieved by substituting certain characters with HTML entities.
2018  * As required by the callers, "<nowiki>" is not used.
2019  *
2020  * @param string $text Text to be escaped
2021  * @return string
2022  */
2023 function wfEscapeWikiText( $text ) {
2024         static $repl = null, $repl2 = null;
2025         if ( $repl === null ) {
2026                 $repl = array(
2027                         '"' => '&#34;', '&' => '&#38;', "'" => '&#39;', '<' => '&#60;',
2028                         '=' => '&#61;', '>' => '&#62;', '[' => '&#91;', ']' => '&#93;',
2029                         '{' => '&#123;', '|' => '&#124;', '}' => '&#125;', ';' => '&#59;',
2030                         "\n#" => "\n&#35;", "\r#" => "\r&#35;",
2031                         "\n*" => "\n&#42;", "\r*" => "\r&#42;",
2032                         "\n:" => "\n&#58;", "\r:" => "\r&#58;",
2033                         "\n " => "\n&#32;", "\r " => "\r&#32;",
2034                         "\n\n" => "\n&#10;", "\r\n" => "&#13;\n",
2035                         "\n\r" => "\n&#13;", "\r\r" => "\r&#13;",
2036                         "\n\t" => "\n&#9;", "\r\t" => "\r&#9;", // "\n\t\n" is treated like "\n\n"
2037                         "\n----" => "\n&#45;---", "\r----" => "\r&#45;---",
2038                         '__' => '_&#95;', '://' => '&#58;//',
2039                 );
2040
2041                 // We have to catch everything "\s" matches in PCRE
2042                 foreach ( array( 'ISBN', 'RFC', 'PMID' ) as $magic ) {
2043                         $repl["$magic "] = "$magic&#32;";
2044                         $repl["$magic\t"] = "$magic&#9;";
2045                         $repl["$magic\r"] = "$magic&#13;";
2046                         $repl["$magic\n"] = "$magic&#10;";
2047                         $repl["$magic\f"] = "$magic&#12;";
2048                 }
2049
2050                 // And handle protocols that don't use "://"
2051                 global $wgUrlProtocols;
2052                 $repl2 = array();
2053                 foreach ( $wgUrlProtocols as $prot ) {
2054                         if ( substr( $prot, -1 ) === ':' ) {
2055                                 $repl2[] = preg_quote( substr( $prot, 0, -1 ), '/' );
2056                         }
2057                 }
2058                 $repl2 = $repl2 ? '/\b(' . join( '|', $repl2 ) . '):/i' : '/^(?!)/';
2059         }
2060         $text = substr( strtr( "\n$text", $repl ), 1 );
2061         $text = preg_replace( $repl2, '$1&#58;', $text );
2062         return $text;
2063 }
2064
2065 /**
2066  * Sets dest to source and returns the original value of dest
2067  * If source is NULL, it just returns the value, it doesn't set the variable
2068  * If force is true, it will set the value even if source is NULL
2069  *
2070  * @param mixed $dest
2071  * @param mixed $source
2072  * @param bool $force
2073  * @return mixed
2074  */
2075 function wfSetVar( &$dest, $source, $force = false ) {
2076         $temp = $dest;
2077         if ( !is_null( $source ) || $force ) {
2078                 $dest = $source;
2079         }
2080         return $temp;
2081 }
2082
2083 /**
2084  * As for wfSetVar except setting a bit
2085  *
2086  * @param int $dest
2087  * @param int $bit
2088  * @param bool $state
2089  *
2090  * @return bool
2091  */
2092 function wfSetBit( &$dest, $bit, $state = true ) {
2093         $temp = (bool)( $dest & $bit );
2094         if ( !is_null( $state ) ) {
2095                 if ( $state ) {
2096                         $dest |= $bit;
2097                 } else {
2098                         $dest &= ~$bit;
2099                 }
2100         }
2101         return $temp;
2102 }
2103
2104 /**
2105  * A wrapper around the PHP function var_export().
2106  * Either print it or add it to the regular output ($wgOut).
2107  *
2108  * @param mixed $var A PHP variable to dump.
2109  */
2110 function wfVarDump( $var ) {
2111         global $wgOut;
2112         $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
2113         if ( headers_sent() || !isset( $wgOut ) || !is_object( $wgOut ) ) {
2114                 print $s;
2115         } else {
2116                 $wgOut->addHTML( $s );
2117         }
2118 }
2119
2120 /**
2121  * Provide a simple HTTP error.
2122  *
2123  * @param int|string $code
2124  * @param string $label
2125  * @param string $desc
2126  */
2127 function wfHttpError( $code, $label, $desc ) {
2128         global $wgOut;
2129         header( "HTTP/1.0 $code $label" );
2130         header( "Status: $code $label" );
2131         if ( $wgOut ) {
2132                 $wgOut->disable();
2133                 $wgOut->sendCacheControl();
2134         }
2135
2136         header( 'Content-type: text/html; charset=utf-8' );
2137         print "<!doctype html>" .
2138                 '<html><head><title>' .
2139                 htmlspecialchars( $label ) .
2140                 '</title></head><body><h1>' .
2141                 htmlspecialchars( $label ) .
2142                 '</h1><p>' .
2143                 nl2br( htmlspecialchars( $desc ) ) .
2144                 "</p></body></html>\n";
2145 }
2146
2147 /**
2148  * Clear away any user-level output buffers, discarding contents.
2149  *
2150  * Suitable for 'starting afresh', for instance when streaming
2151  * relatively large amounts of data without buffering, or wanting to
2152  * output image files without ob_gzhandler's compression.
2153  *
2154  * The optional $resetGzipEncoding parameter controls suppression of
2155  * the Content-Encoding header sent by ob_gzhandler; by default it
2156  * is left. See comments for wfClearOutputBuffers() for why it would
2157  * be used.
2158  *
2159  * Note that some PHP configuration options may add output buffer
2160  * layers which cannot be removed; these are left in place.
2161  *
2162  * @param bool $resetGzipEncoding
2163  */
2164 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
2165         if ( $resetGzipEncoding ) {
2166                 // Suppress Content-Encoding and Content-Length
2167                 // headers from 1.10+s wfOutputHandler
2168                 global $wgDisableOutputCompression;
2169                 $wgDisableOutputCompression = true;
2170         }
2171         while ( $status = ob_get_status() ) {
2172                 if ( $status['type'] == 0 /* PHP_OUTPUT_HANDLER_INTERNAL */ ) {
2173                         // Probably from zlib.output_compression or other
2174                         // PHP-internal setting which can't be removed.
2175                         //
2176                         // Give up, and hope the result doesn't break
2177                         // output behavior.
2178                         break;
2179                 }
2180                 if ( !ob_end_clean() ) {
2181                         // Could not remove output buffer handler; abort now
2182                         // to avoid getting in some kind of infinite loop.
2183                         break;
2184                 }
2185                 if ( $resetGzipEncoding ) {
2186                         if ( $status['name'] == 'ob_gzhandler' ) {
2187                                 // Reset the 'Content-Encoding' field set by this handler
2188                                 // so we can start fresh.
2189                                 header_remove( 'Content-Encoding' );
2190                                 break;
2191                         }
2192                 }
2193         }
2194 }
2195
2196 /**
2197  * More legible than passing a 'false' parameter to wfResetOutputBuffers():
2198  *
2199  * Clear away output buffers, but keep the Content-Encoding header
2200  * produced by ob_gzhandler, if any.
2201  *
2202  * This should be used for HTTP 304 responses, where you need to
2203  * preserve the Content-Encoding header of the real result, but
2204  * also need to suppress the output of ob_gzhandler to keep to spec
2205  * and avoid breaking Firefox in rare cases where the headers and
2206  * body are broken over two packets.
2207  */
2208 function wfClearOutputBuffers() {
2209         wfResetOutputBuffers( false );
2210 }
2211
2212 /**
2213  * Converts an Accept-* header into an array mapping string values to quality
2214  * factors
2215  *
2216  * @param string $accept
2217  * @param string $def Default
2218  * @return float[] Associative array of string => float pairs
2219  */
2220 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
2221         # No arg means accept anything (per HTTP spec)
2222         if ( !$accept ) {
2223                 return array( $def => 1.0 );
2224         }
2225
2226         $prefs = array();
2227
2228         $parts = explode( ',', $accept );
2229
2230         foreach ( $parts as $part ) {
2231                 # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
2232                 $values = explode( ';', trim( $part ) );
2233                 $match = array();
2234                 if ( count( $values ) == 1 ) {
2235                         $prefs[$values[0]] = 1.0;
2236                 } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
2237                         $prefs[$values[0]] = floatval( $match[1] );
2238                 }
2239         }
2240
2241         return $prefs;
2242 }
2243
2244 /**
2245  * Checks if a given MIME type matches any of the keys in the given
2246  * array. Basic wildcards are accepted in the array keys.
2247  *
2248  * Returns the matching MIME type (or wildcard) if a match, otherwise
2249  * NULL if no match.
2250  *
2251  * @param string $type
2252  * @param array $avail
2253  * @return string
2254  * @private
2255  */
2256 function mimeTypeMatch( $type, $avail ) {
2257         if ( array_key_exists( $type, $avail ) ) {
2258                 return $type;
2259         } else {
2260                 $parts = explode( '/', $type );
2261                 if ( array_key_exists( $parts[0] . '/*', $avail ) ) {
2262                         return $parts[0] . '/*';
2263                 } elseif ( array_key_exists( '*/*', $avail ) ) {
2264                         return '*/*';
2265                 } else {
2266                         return null;
2267                 }
2268         }
2269 }
2270
2271 /**
2272  * Returns the 'best' match between a client's requested internet media types
2273  * and the server's list of available types. Each list should be an associative
2274  * array of type to preference (preference is a float between 0.0 and 1.0).
2275  * Wildcards in the types are acceptable.
2276  *
2277  * @param array $cprefs Client's acceptable type list
2278  * @param array $sprefs Server's offered types
2279  * @return string
2280  *
2281  * @todo FIXME: Doesn't handle params like 'text/plain; charset=UTF-8'
2282  * XXX: generalize to negotiate other stuff
2283  */
2284 function wfNegotiateType( $cprefs, $sprefs ) {
2285         $combine = array();
2286
2287         foreach ( array_keys( $sprefs ) as $type ) {
2288                 $parts = explode( '/', $type );
2289                 if ( $parts[1] != '*' ) {
2290                         $ckey = mimeTypeMatch( $type, $cprefs );
2291                         if ( $ckey ) {
2292                                 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
2293                         }
2294                 }
2295         }
2296
2297         foreach ( array_keys( $cprefs ) as $type ) {
2298                 $parts = explode( '/', $type );
2299                 if ( $parts[1] != '*' && !array_key_exists( $type, $sprefs ) ) {
2300                         $skey = mimeTypeMatch( $type, $sprefs );
2301                         if ( $skey ) {
2302                                 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
2303                         }
2304                 }
2305         }
2306
2307         $bestq = 0;
2308         $besttype = null;
2309
2310         foreach ( array_keys( $combine ) as $type ) {
2311                 if ( $combine[$type] > $bestq ) {
2312                         $besttype = $type;
2313                         $bestq = $combine[$type];
2314                 }
2315         }
2316
2317         return $besttype;
2318 }
2319
2320 /**
2321  * Reference-counted warning suppression
2322  *
2323  * @param bool $end
2324  */
2325 function wfSuppressWarnings( $end = false ) {
2326         static $suppressCount = 0;
2327         static $originalLevel = false;
2328
2329         if ( $end ) {
2330                 if ( $suppressCount ) {
2331                         --$suppressCount;
2332                         if ( !$suppressCount ) {
2333                                 error_reporting( $originalLevel );
2334                         }
2335                 }
2336         } else {
2337                 if ( !$suppressCount ) {
2338                         $originalLevel = error_reporting( E_ALL & ~(
2339                                 E_WARNING |
2340                                 E_NOTICE |
2341                                 E_USER_WARNING |
2342                                 E_USER_NOTICE |
2343                                 E_DEPRECATED |
2344                                 E_USER_DEPRECATED |
2345                                 E_STRICT
2346                         ) );
2347                 }
2348                 ++$suppressCount;
2349         }
2350 }
2351
2352 /**
2353  * Restore error level to previous value
2354  */
2355 function wfRestoreWarnings() {
2356         wfSuppressWarnings( true );
2357 }
2358
2359 # Autodetect, convert and provide timestamps of various types
2360
2361 /**
2362  * Unix time - the number of seconds since 1970-01-01 00:00:00 UTC
2363  */
2364 define( 'TS_UNIX', 0 );
2365
2366 /**
2367  * MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
2368  */
2369 define( 'TS_MW', 1 );
2370
2371 /**
2372  * MySQL DATETIME (YYYY-MM-DD HH:MM:SS)
2373  */
2374 define( 'TS_DB', 2 );
2375
2376 /**
2377  * RFC 2822 format, for E-mail and HTTP headers
2378  */
2379 define( 'TS_RFC2822', 3 );
2380
2381 /**
2382  * ISO 8601 format with no timezone: 1986-02-09T20:00:00Z
2383  *
2384  * This is used by Special:Export
2385  */
2386 define( 'TS_ISO_8601', 4 );
2387
2388 /**
2389  * An Exif timestamp (YYYY:MM:DD HH:MM:SS)
2390  *
2391  * @see http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the
2392  *       DateTime tag and page 36 for the DateTimeOriginal and
2393  *       DateTimeDigitized tags.
2394  */
2395 define( 'TS_EXIF', 5 );
2396
2397 /**
2398  * Oracle format time.
2399  */
2400 define( 'TS_ORACLE', 6 );
2401
2402 /**
2403  * Postgres format time.
2404  */
2405 define( 'TS_POSTGRES', 7 );
2406
2407 /**
2408  * ISO 8601 basic format with no timezone: 19860209T200000Z.  This is used by ResourceLoader
2409  */
2410 define( 'TS_ISO_8601_BASIC', 9 );
2411
2412 /**
2413  * Get a timestamp string in one of various formats
2414  *
2415  * @param mixed $outputtype A timestamp in one of the supported formats, the
2416  *   function will autodetect which format is supplied and act accordingly.
2417  * @param mixed $ts Optional timestamp to convert, default 0 for the current time
2418  * @return string|bool String / false The same date in the format specified in $outputtype or false
2419  */
2420 function wfTimestamp( $outputtype = TS_UNIX, $ts = 0 ) {
2421         try {
2422                 $timestamp = new MWTimestamp( $ts );
2423                 return $timestamp->getTimestamp( $outputtype );
2424         } catch ( TimestampException $e ) {
2425                 wfDebug( "wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n" );
2426                 return false;
2427         }
2428 }
2429
2430 /**
2431  * Return a formatted timestamp, or null if input is null.
2432  * For dealing with nullable timestamp columns in the database.
2433  *
2434  * @param int $outputtype
2435  * @param string $ts
2436  * @return string
2437  */
2438 function wfTimestampOrNull( $outputtype = TS_UNIX, $ts = null ) {
2439         if ( is_null( $ts ) ) {
2440                 return null;
2441         } else {
2442                 return wfTimestamp( $outputtype, $ts );
2443         }
2444 }
2445
2446 /**
2447  * Convenience function; returns MediaWiki timestamp for the present time.
2448  *
2449  * @return string
2450  */
2451 function wfTimestampNow() {
2452         # return NOW
2453         return wfTimestamp( TS_MW, time() );
2454 }
2455
2456 /**
2457  * Check if the operating system is Windows
2458  *
2459  * @return bool True if it's Windows, false otherwise.
2460  */
2461 function wfIsWindows() {
2462         static $isWindows = null;
2463         if ( $isWindows === null ) {
2464                 $isWindows = substr( php_uname(), 0, 7 ) == 'Windows';
2465         }
2466         return $isWindows;
2467 }
2468
2469 /**
2470  * Check if we are running under HHVM
2471  *
2472  * @return bool
2473  */
2474 function wfIsHHVM() {
2475         return defined( 'HHVM_VERSION' );
2476 }
2477
2478 /**
2479  * Swap two variables
2480  *
2481  * @deprecated since 1.24
2482  * @param mixed $x
2483  * @param mixed $y
2484  */
2485 function swap( &$x, &$y ) {
2486         wfDeprecated( __FUNCTION__, '1.24' );
2487         $z = $x;
2488         $x = $y;
2489         $y = $z;
2490 }
2491
2492 /**
2493  * Tries to get the system directory for temporary files. First
2494  * $wgTmpDirectory is checked, and then the TMPDIR, TMP, and TEMP
2495  * environment variables are then checked in sequence, and if none are
2496  * set try sys_get_temp_dir().
2497  *
2498  * NOTE: When possible, use instead the tmpfile() function to create
2499  * temporary files to avoid race conditions on file creation, etc.
2500  *
2501  * @return string
2502  */
2503 function wfTempDir() {
2504         global $wgTmpDirectory;
2505
2506         if ( $wgTmpDirectory !== false ) {
2507                 return $wgTmpDirectory;
2508         }
2509
2510         $tmpDir = array_map( "getenv", array( 'TMPDIR', 'TMP', 'TEMP' ) );
2511
2512         foreach ( $tmpDir as $tmp ) {
2513                 if ( $tmp && file_exists( $tmp ) && is_dir( $tmp ) && is_writable( $tmp ) ) {
2514                         return $tmp;
2515                 }
2516         }
2517         return sys_get_temp_dir();
2518 }
2519
2520 /**
2521  * Make directory, and make all parent directories if they don't exist
2522  *
2523  * @param string $dir Full path to directory to create
2524  * @param int $mode Chmod value to use, default is $wgDirectoryMode
2525  * @param string $caller Optional caller param for debugging.
2526  * @throws MWException
2527  * @return bool
2528  */
2529 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2530         global $wgDirectoryMode;
2531
2532         if ( FileBackend::isStoragePath( $dir ) ) { // sanity
2533                 throw new MWException( __FUNCTION__ . " given storage path '$dir'." );
2534         }
2535
2536         if ( !is_null( $caller ) ) {
2537                 wfDebug( "$caller: called wfMkdirParents($dir)\n" );
2538         }
2539
2540         if ( strval( $dir ) === '' || ( file_exists( $dir ) && is_dir( $dir ) ) ) {
2541                 return true;
2542         }
2543
2544         $dir = str_replace( array( '\\', '/' ), DIRECTORY_SEPARATOR, $dir );
2545
2546         if ( is_null( $mode ) ) {
2547                 $mode = $wgDirectoryMode;
2548         }
2549
2550         // Turn off the normal warning, we're doing our own below
2551         wfSuppressWarnings();
2552         $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2553         wfRestoreWarnings();
2554
2555         if ( !$ok ) {
2556                 //directory may have been created on another request since we last checked
2557                 if ( is_dir( $dir ) ) {
2558                         return true;
2559                 }
2560
2561                 // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2562                 wfLogWarning( sprintf( "failed to mkdir \"%s\" mode 0%o", $dir, $mode ) );
2563         }
2564         return $ok;
2565 }
2566
2567 /**
2568  * Remove a directory and all its content.
2569  * Does not hide error.
2570  * @param string $dir
2571  */
2572 function wfRecursiveRemoveDir( $dir ) {
2573         wfDebug( __FUNCTION__ . "( $dir )\n" );
2574         // taken from http://de3.php.net/manual/en/function.rmdir.php#98622
2575         if ( is_dir( $dir ) ) {
2576                 $objects = scandir( $dir );
2577                 foreach ( $objects as $object ) {
2578                         if ( $object != "." && $object != ".." ) {
2579                                 if ( filetype( $dir . '/' . $object ) == "dir" ) {
2580                                         wfRecursiveRemoveDir( $dir . '/' . $object );
2581                                 } else {
2582                                         unlink( $dir . '/' . $object );
2583                                 }
2584                         }
2585                 }
2586                 reset( $objects );
2587                 rmdir( $dir );
2588         }
2589 }
2590
2591 /**
2592  * @param int $nr The number to format
2593  * @param int $acc The number of digits after the decimal point, default 2
2594  * @param bool $round Whether or not to round the value, default true
2595  * @return string
2596  */
2597 function wfPercent( $nr, $acc = 2, $round = true ) {
2598         $ret = sprintf( "%.${acc}f", $nr );
2599         return $round ? round( $ret, $acc ) . '%' : "$ret%";
2600 }
2601
2602 /**
2603  * Safety wrapper around ini_get() for boolean settings.
2604  * The values returned from ini_get() are pre-normalized for settings
2605  * set via php.ini or php_flag/php_admin_flag... but *not*
2606  * for those set via php_value/php_admin_value.
2607  *
2608  * It's fairly common for people to use php_value instead of php_flag,
2609  * which can leave you with an 'off' setting giving a false positive
2610  * for code that just takes the ini_get() return value as a boolean.
2611  *
2612  * To make things extra interesting, setting via php_value accepts
2613  * "true" and "yes" as true, but php.ini and php_flag consider them false. :)
2614  * Unrecognized values go false... again opposite PHP's own coercion
2615  * from string to bool.
2616  *
2617  * Luckily, 'properly' set settings will always come back as '0' or '1',
2618  * so we only have to worry about them and the 'improper' settings.
2619  *
2620  * I frickin' hate PHP... :P
2621  *
2622  * @param string $setting
2623  * @return bool
2624  */
2625 function wfIniGetBool( $setting ) {
2626         $val = strtolower( ini_get( $setting ) );
2627         // 'on' and 'true' can't have whitespace around them, but '1' can.
2628         return $val == 'on'
2629                 || $val == 'true'
2630                 || $val == 'yes'
2631                 || preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2632 }
2633
2634 /**
2635  * Windows-compatible version of escapeshellarg()
2636  * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
2637  * function puts single quotes in regardless of OS.
2638  *
2639  * Also fixes the locale problems on Linux in PHP 5.2.6+ (bug backported to
2640  * earlier distro releases of PHP)
2641  *
2642  * @param string ... strings to escape and glue together, or a single array of strings parameter
2643  * @return string
2644  */
2645 function wfEscapeShellArg( /*...*/ ) {
2646         wfInitShellLocale();
2647
2648         $args = func_get_args();
2649         if ( count( $args ) === 1 && is_array( reset( $args ) ) ) {
2650                 // If only one argument has been passed, and that argument is an array,
2651                 // treat it as a list of arguments
2652                 $args = reset( $args );
2653         }
2654
2655         $first = true;
2656         $retVal = '';
2657         foreach ( $args as $arg ) {
2658                 if ( !$first ) {
2659                         $retVal .= ' ';
2660                 } else {
2661                         $first = false;
2662                 }
2663
2664                 if ( wfIsWindows() ) {
2665                         // Escaping for an MSVC-style command line parser and CMD.EXE
2666                         // @codingStandardsIgnoreStart For long URLs
2667                         // Refs:
2668                         //  * http://web.archive.org/web/20020708081031/http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
2669                         //  * http://technet.microsoft.com/en-us/library/cc723564.aspx
2670                         //  * Bug #13518
2671                         //  * CR r63214
2672                         // Double the backslashes before any double quotes. Escape the double quotes.
2673                         // @codingStandardsIgnoreEnd
2674                         $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE );
2675                         $arg = '';
2676                         $iteration = 0;
2677                         foreach ( $tokens as $token ) {
2678                                 if ( $iteration % 2 == 1 ) {
2679                                         // Delimiter, a double quote preceded by zero or more slashes
2680                                         $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
2681                                 } elseif ( $iteration % 4 == 2 ) {
2682                                         // ^ in $token will be outside quotes, need to be escaped
2683                                         $arg .= str_replace( '^', '^^', $token );
2684                                 } else { // $iteration % 4 == 0
2685                                         // ^ in $token will appear inside double quotes, so leave as is
2686                                         $arg .= $token;
2687                                 }
2688                                 $iteration++;
2689                         }
2690                         // Double the backslashes before the end of the string, because
2691                         // we will soon add a quote
2692                         $m = array();
2693                         if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
2694                                 $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
2695                         }
2696
2697                         // Add surrounding quotes
2698                         $retVal .= '"' . $arg . '"';
2699                 } else {
2700                         $retVal .= escapeshellarg( $arg );
2701                 }
2702         }
2703         return $retVal;
2704 }
2705
2706 /**
2707  * Check if wfShellExec() is effectively disabled via php.ini config
2708  *
2709  * @return bool|string False or one of (safemode,disabled)
2710  * @since 1.22
2711  */
2712 function wfShellExecDisabled() {
2713         static $disabled = null;
2714         if ( is_null( $disabled ) ) {
2715                 if ( wfIniGetBool( 'safe_mode' ) ) {
2716                         wfDebug( "wfShellExec can't run in safe_mode, PHP's exec functions are too broken.\n" );
2717                         $disabled = 'safemode';
2718                 } elseif ( !function_exists( 'proc_open' ) ) {
2719                         wfDebug( "proc_open() is disabled\n" );
2720                         $disabled = 'disabled';
2721                 } else {
2722                         $disabled = false;
2723                 }
2724         }
2725         return $disabled;
2726 }
2727
2728 /**
2729  * Execute a shell command, with time and memory limits mirrored from the PHP
2730  * configuration if supported.
2731  *
2732  * @param string|string[] $cmd If string, a properly shell-escaped command line,
2733  *   or an array of unescaped arguments, in which case each value will be escaped
2734  *   Example:   [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
2735  * @param null|mixed &$retval Optional, will receive the program's exit code.
2736  *   (non-zero is usually failure). If there is an error from
2737  *   read, select, or proc_open(), this will be set to -1.
2738  * @param array $environ Optional environment variables which should be
2739  *   added to the executed command environment.
2740  * @param array $limits Optional array with limits(filesize, memory, time, walltime)
2741  *   this overwrites the global wgMaxShell* limits.
2742  * @param array $options Array of options:
2743  *   - duplicateStderr: Set this to true to duplicate stderr to stdout,
2744  *     including errors from limit.sh
2745  *   - profileMethod: By default this function will profile based on the calling
2746  *     method. Set this to a string for an alternative method to profile from
2747  *
2748  * @return string Collected stdout as a string
2749  */
2750 function wfShellExec( $cmd, &$retval = null, $environ = array(),
2751         $limits = array(), $options = array()
2752 ) {
2753         global $IP, $wgMaxShellMemory, $wgMaxShellFileSize, $wgMaxShellTime,
2754                 $wgMaxShellWallClockTime, $wgShellCgroup;
2755
2756         $disabled = wfShellExecDisabled();
2757         if ( $disabled ) {
2758                 $retval = 1;
2759                 return $disabled == 'safemode' ?
2760                         'Unable to run external programs in safe mode.' :
2761                         'Unable to run external programs, proc_open() is disabled.';
2762         }
2763
2764         $includeStderr = isset( $options['duplicateStderr'] ) && $options['duplicateStderr'];
2765         $profileMethod = isset( $options['profileMethod'] ) ? $options['profileMethod'] : wfGetCaller();
2766
2767         wfInitShellLocale();
2768
2769         $envcmd = '';
2770         foreach ( $environ as $k => $v ) {
2771                 if ( wfIsWindows() ) {
2772                         /* Surrounding a set in quotes (method used by wfEscapeShellArg) makes the quotes themselves
2773                          * appear in the environment variable, so we must use carat escaping as documented in
2774                          * http://technet.microsoft.com/en-us/library/cc723564.aspx
2775                          * Note however that the quote isn't listed there, but is needed, and the parentheses
2776                          * are listed there but doesn't appear to need it.
2777                          */
2778                         $envcmd .= "set $k=" . preg_replace( '/([&|()<>^"])/', '^\\1', $v ) . '&& ';
2779                 } else {
2780                         /* Assume this is a POSIX shell, thus required to accept variable assignments before the command
2781                          * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_09_01
2782                          */
2783                         $envcmd .= "$k=" . escapeshellarg( $v ) . ' ';
2784                 }
2785         }
2786         if ( is_array( $cmd ) ) {
2787                 $cmd = wfEscapeShellArg( $cmd );
2788         }
2789
2790         $cmd = $envcmd . $cmd;
2791
2792         $useLogPipe = false;
2793         if ( is_executable( '/bin/bash' ) ) {
2794                 $time = intval ( isset( $limits['time'] ) ? $limits['time'] : $wgMaxShellTime );
2795                 if ( isset( $limits['walltime'] ) ) {
2796                         $wallTime = intval( $limits['walltime'] );
2797                 } elseif ( isset( $limits['time'] ) ) {
2798                         $wallTime = $time;
2799                 } else {
2800                         $wallTime = intval( $wgMaxShellWallClockTime );
2801                 }
2802                 $mem = intval ( isset( $limits['memory'] ) ? $limits['memory'] : $wgMaxShellMemory );
2803                 $filesize = intval ( isset( $limits['filesize'] ) ? $limits['filesize'] : $wgMaxShellFileSize );
2804
2805                 if ( $time > 0 || $mem > 0 || $filesize > 0 || $wallTime > 0 ) {
2806                         $cmd = '/bin/bash ' . escapeshellarg( "$IP/includes/limit.sh" ) . ' ' .
2807                                 escapeshellarg( $cmd ) . ' ' .
2808                                 escapeshellarg(
2809                                         "MW_INCLUDE_STDERR=" . ( $includeStderr ? '1' : '' ) . ';' .
2810                                         "MW_CPU_LIMIT=$time; " .
2811                                         'MW_CGROUP=' . escapeshellarg( $wgShellCgroup ) . '; ' .
2812                                         "MW_MEM_LIMIT=$mem; " .
2813                                         "MW_FILE_SIZE_LIMIT=$filesize; " .
2814                                         "MW_WALL_CLOCK_LIMIT=$wallTime; " .
2815                                         "MW_USE_LOG_PIPE=yes"
2816                                 );
2817                         $useLogPipe = true;
2818                 } elseif ( $includeStderr ) {
2819                         $cmd .= ' 2>&1';
2820                 }
2821         } elseif ( $includeStderr ) {
2822                 $cmd .= ' 2>&1';
2823         }
2824         wfDebug( "wfShellExec: $cmd\n" );
2825
2826         $desc = array(
2827                 0 => array( 'file', 'php://stdin', 'r' ),
2828                 1 => array( 'pipe', 'w' ),
2829                 2 => array( 'file', 'php://stderr', 'w' ) );
2830         if ( $useLogPipe ) {
2831                 $desc[3] = array( 'pipe', 'w' );
2832         }
2833         $pipes = null;
2834         $scoped = Profiler::instance()->scopedProfileIn( __FUNCTION__ . '-' . $profileMethod );
2835         $proc = proc_open( $cmd, $desc, $pipes );
2836         if ( !$proc ) {
2837                 wfDebugLog( 'exec', "proc_open() failed: $cmd" );
2838                 $retval = -1;
2839                 return '';
2840         }
2841         $outBuffer = $logBuffer = '';
2842         $emptyArray = array();
2843         $status = false;
2844         $logMsg = false;
2845
2846         // According to the documentation, it is possible for stream_select()
2847         // to fail due to EINTR. I haven't managed to induce this in testing
2848         // despite sending various signals. If it did happen, the error
2849         // message would take the form:
2850         //
2851         // stream_select(): unable to select [4]: Interrupted system call (max_fd=5)
2852         //
2853         // where [4] is the value of the macro EINTR and "Interrupted system
2854         // call" is string which according to the Linux manual is "possibly"
2855         // localised according to LC_MESSAGES.
2856         $eintr = defined( 'SOCKET_EINTR' ) ? SOCKET_EINTR : 4;
2857         $eintrMessage = "stream_select(): unable to select [$eintr]";
2858
2859         // Build a table mapping resource IDs to pipe FDs to work around a
2860         // PHP 5.3 issue in which stream_select() does not preserve array keys
2861         // <https://bugs.php.net/bug.php?id=53427>.
2862         $fds = array();
2863         foreach ( $pipes as $fd => $pipe ) {
2864                 $fds[(int)$pipe] = $fd;
2865         }
2866
2867         $running = true;
2868         $timeout = null;
2869         $numReadyPipes = 0;
2870
2871         while ( $running === true || $numReadyPipes !== 0 ) {
2872                 if ( $running ) {
2873                         $status = proc_get_status( $proc );
2874                         // If the process has terminated, switch to nonblocking selects
2875                         // for getting any data still waiting to be read.
2876                         if ( !$status['running'] ) {
2877                                 $running = false;
2878                                 $timeout = 0;
2879                         }
2880                 }
2881
2882                 $readyPipes = $pipes;
2883
2884                 // Clear last error
2885                 // @codingStandardsIgnoreStart Generic.PHP.NoSilencedErrors.Discouraged
2886                 @trigger_error( '' );
2887                 $numReadyPipes = @stream_select( $readyPipes, $emptyArray, $emptyArray, $timeout );
2888                 if ( $numReadyPipes === false ) {
2889                         // @codingStandardsIgnoreEnd
2890                         $error = error_get_last();
2891                         if ( strncmp( $error['message'], $eintrMessage, strlen( $eintrMessage ) ) == 0 ) {
2892                                 continue;
2893                         } else {
2894                                 trigger_error( $error['message'], E_USER_WARNING );
2895                                 $logMsg = $error['message'];
2896                                 break;
2897                         }
2898                 }
2899                 foreach ( $readyPipes as $pipe ) {
2900                         $block = fread( $pipe, 65536 );
2901                         $fd = $fds[(int)$pipe];
2902                         if ( $block === '' ) {
2903                                 // End of file
2904                                 fclose( $pipes[$fd] );
2905                                 unset( $pipes[$fd] );
2906                                 if ( !$pipes ) {
2907                                         break 2;
2908                                 }
2909                         } elseif ( $block === false ) {
2910                                 // Read error
2911                                 $logMsg = "Error reading from pipe";
2912                                 break 2;
2913                         } elseif ( $fd == 1 ) {
2914                                 // From stdout
2915                                 $outBuffer .= $block;
2916                         } elseif ( $fd == 3 ) {
2917                                 // From log FD
2918                                 $logBuffer .= $block;
2919                                 if ( strpos( $block, "\n" ) !== false ) {
2920                                         $lines = explode( "\n", $logBuffer );
2921                                         $logBuffer = array_pop( $lines );
2922                                         foreach ( $lines as $line ) {
2923                                                 wfDebugLog( 'exec', $line );
2924                                         }
2925                                 }
2926                         }
2927                 }
2928         }
2929
2930         foreach ( $pipes as $pipe ) {
2931                 fclose( $pipe );
2932         }
2933
2934         // Use the status previously collected if possible, since proc_get_status()
2935         // just calls waitpid() which will not return anything useful the second time.
2936         if ( $running ) {
2937                 $status = proc_get_status( $proc );
2938         }
2939
2940         if ( $logMsg !== false ) {
2941                 // Read/select error
2942                 $retval = -1;
2943                 proc_close( $proc );
2944         } elseif ( $status['signaled'] ) {
2945                 $logMsg = "Exited with signal {$status['termsig']}";
2946                 $retval = 128 + $status['termsig'];
2947                 proc_close( $proc );
2948         } else {
2949                 if ( $status['running'] ) {
2950                         $retval = proc_close( $proc );
2951                 } else {
2952                         $retval = $status['exitcode'];
2953                         proc_close( $proc );
2954                 }
2955                 if ( $retval == 127 ) {
2956                         $logMsg = "Possibly missing executable file";
2957                 } elseif ( $retval >= 129 && $retval <= 192 ) {
2958                         $logMsg = "Probably exited with signal " . ( $retval - 128 );
2959                 }
2960         }
2961
2962         if ( $logMsg !== false ) {
2963                 wfDebugLog( 'exec', "$logMsg: $cmd" );
2964         }
2965
2966         return $outBuffer;
2967 }
2968
2969 /**
2970  * Execute a shell command, returning both stdout and stderr. Convenience
2971  * function, as all the arguments to wfShellExec can become unwieldy.
2972  *
2973  * @note This also includes errors from limit.sh, e.g. if $wgMaxShellFileSize is exceeded.
2974  * @param string|string[] $cmd If string, a properly shell-escaped command line,
2975  *   or an array of unescaped arguments, in which case each value will be escaped
2976  *   Example:   [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
2977  * @param null|mixed &$retval Optional, will receive the program's exit code.
2978  *   (non-zero is usually failure)
2979  * @param array $environ Optional environment variables which should be
2980  *   added to the executed command environment.
2981  * @param array $limits Optional array with limits(filesize, memory, time, walltime)
2982  *   this overwrites the global wgMaxShell* limits.
2983  * @return string Collected stdout and stderr as a string
2984  */
2985 function wfShellExecWithStderr( $cmd, &$retval = null, $environ = array(), $limits = array() ) {
2986         return wfShellExec( $cmd, $retval, $environ, $limits,
2987                 array( 'duplicateStderr' => true, 'profileMethod' => wfGetCaller() ) );
2988 }
2989
2990 /**
2991  * Workaround for http://bugs.php.net/bug.php?id=45132
2992  * escapeshellarg() destroys non-ASCII characters if LANG is not a UTF-8 locale
2993  */
2994 function wfInitShellLocale() {
2995         static $done = false;
2996         if ( $done ) {
2997                 return;
2998         }
2999         $done = true;
3000         global $wgShellLocale;
3001         if ( !wfIniGetBool( 'safe_mode' ) ) {
3002                 putenv( "LC_CTYPE=$wgShellLocale" );
3003                 setlocale( LC_CTYPE, $wgShellLocale );
3004         }
3005 }
3006
3007 /**
3008  * Generate a shell-escaped command line string to run a MediaWiki cli script.
3009  * Note that $parameters should be a flat array and an option with an argument
3010  * should consist of two consecutive items in the array (do not use "--option value").
3011  *
3012  * @param string $script MediaWiki cli script path
3013  * @param array $parameters Arguments and options to the script
3014  * @param array $options Associative array of options:
3015  *              'php': The path to the php executable
3016  *              'wrapper': Path to a PHP wrapper to handle the maintenance script
3017  * @return string
3018  */
3019 function wfShellWikiCmd( $script, array $parameters = array(), array $options = array() ) {
3020         global $wgPhpCli;
3021         // Give site config file a chance to run the script in a wrapper.
3022         // The caller may likely want to call wfBasename() on $script.
3023         Hooks::run( 'wfShellWikiCmd', array( &$script, &$parameters, &$options ) );
3024         $cmd = isset( $options['php'] ) ? array( $options['php'] ) : array( $wgPhpCli );
3025         if ( isset( $options['wrapper'] ) ) {
3026                 $cmd[] = $options['wrapper'];
3027         }
3028         $cmd[] = $script;
3029         // Escape each parameter for shell
3030         return wfEscapeShellArg( array_merge( $cmd, $parameters ) );
3031 }
3032
3033 /**
3034  * wfMerge attempts to merge differences between three texts.
3035  * Returns true for a clean merge and false for failure or a conflict.
3036  *
3037  * @param string $old
3038  * @param string $mine
3039  * @param string $yours
3040  * @param string $result
3041  * @return bool
3042  */
3043 function wfMerge( $old, $mine, $yours, &$result ) {
3044         global $wgDiff3;
3045
3046         # This check may also protect against code injection in
3047         # case of broken installations.
3048         wfSuppressWarnings();
3049         $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
3050         wfRestoreWarnings();
3051
3052         if ( !$haveDiff3 ) {
3053                 wfDebug( "diff3 not found\n" );
3054                 return false;
3055         }
3056
3057         # Make temporary files
3058         $td = wfTempDir();
3059         $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
3060         $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
3061         $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
3062
3063         # NOTE: diff3 issues a warning to stderr if any of the files does not end with
3064         #       a newline character. To avoid this, we normalize the trailing whitespace before
3065         #       creating the diff.
3066
3067         fwrite( $oldtextFile, rtrim( $old ) . "\n" );
3068         fclose( $oldtextFile );
3069         fwrite( $mytextFile, rtrim( $mine ) . "\n" );
3070         fclose( $mytextFile );
3071         fwrite( $yourtextFile, rtrim( $yours ) . "\n" );
3072         fclose( $yourtextFile );
3073
3074         # Check for a conflict
3075         $cmd = wfEscapeShellArg( $wgDiff3, '-a', '--overlap-only', $mytextName, $oldtextName, $yourtextName );
3076         $handle = popen( $cmd, 'r' );
3077
3078         if ( fgets( $handle, 1024 ) ) {
3079                 $conflict = true;
3080         } else {
3081                 $conflict = false;
3082         }
3083         pclose( $handle );
3084
3085         # Merge differences
3086         $cmd = wfEscapeShellArg( $wgDiff3, '-a', '-e', '--merge', $mytextName, $oldtextName, $yourtextName );
3087         $handle = popen( $cmd, 'r' );
3088         $result = '';
3089         do {
3090                 $data = fread( $handle, 8192 );
3091                 if ( strlen( $data ) == 0 ) {
3092                         break;
3093                 }
3094                 $result .= $data;
3095         } while ( true );
3096         pclose( $handle );
3097         unlink( $mytextName );
3098         unlink( $oldtextName );
3099         unlink( $yourtextName );
3100
3101         if ( $result === '' && $old !== '' && !$conflict ) {
3102                 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
3103                 $conflict = true;
3104         }
3105         return !$conflict;
3106 }
3107
3108 /**
3109  * Returns unified plain-text diff of two texts.
3110  * "Useful" for machine processing of diffs.
3111  *
3112  * @deprecated since 1.25, use DiffEngine/UnifiedDiffFormatter directly
3113  *
3114  * @param string $before The text before the changes.
3115  * @param string $after The text after the changes.
3116  * @param string $params Command-line options for the diff command.
3117  * @return string Unified diff of $before and $after
3118  */
3119 function wfDiff( $before, $after, $params = '-u' ) {
3120         if ( $before == $after ) {
3121                 return '';
3122         }
3123
3124         global $wgDiff;
3125         wfSuppressWarnings();
3126         $haveDiff = $wgDiff && file_exists( $wgDiff );
3127         wfRestoreWarnings();
3128
3129         # This check may also protect against code injection in
3130         # case of broken installations.
3131         if ( !$haveDiff ) {
3132                 wfDebug( "diff executable not found\n" );
3133                 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
3134                 $format = new UnifiedDiffFormatter();
3135                 return $format->format( $diffs );
3136         }
3137
3138         # Make temporary files
3139         $td = wfTempDir();
3140         $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
3141         $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
3142
3143         fwrite( $oldtextFile, $before );
3144         fclose( $oldtextFile );
3145         fwrite( $newtextFile, $after );
3146         fclose( $newtextFile );
3147
3148         // Get the diff of the two files
3149         $cmd = "$wgDiff " . $params . ' ' . wfEscapeShellArg( $oldtextName, $newtextName );
3150
3151         $h = popen( $cmd, 'r' );
3152         if ( !$h ) {
3153                 unlink( $oldtextName );
3154                 unlink( $newtextName );
3155                 throw new Exception( __METHOD__ . '(): popen() failed' );
3156         }
3157
3158         $diff = '';
3159
3160         do {
3161                 $data = fread( $h, 8192 );
3162                 if ( strlen( $data ) == 0 ) {
3163                         break;
3164                 }
3165                 $diff .= $data;
3166         } while ( true );
3167
3168         // Clean up
3169         pclose( $h );
3170         unlink( $oldtextName );
3171         unlink( $newtextName );
3172
3173         // Kill the --- and +++ lines. They're not useful.
3174         $diff_lines = explode( "\n", $diff );
3175         if ( isset( $diff_lines[0] ) && strpos( $diff_lines[0], '---' ) === 0 ) {
3176                 unset( $diff_lines[0] );
3177         }
3178         if ( isset( $diff_lines[1] ) && strpos( $diff_lines[1], '+++' ) === 0 ) {
3179                 unset( $diff_lines[1] );
3180         }
3181
3182         $diff = implode( "\n", $diff_lines );
3183
3184         return $diff;
3185 }
3186
3187 /**
3188  * This function works like "use VERSION" in Perl, the program will die with a
3189  * backtrace if the current version of PHP is less than the version provided
3190  *
3191  * This is useful for extensions which due to their nature are not kept in sync
3192  * with releases, and might depend on other versions of PHP than the main code
3193  *
3194  * Note: PHP might die due to parsing errors in some cases before it ever
3195  *       manages to call this function, such is life
3196  *
3197  * @see perldoc -f use
3198  *
3199  * @param string|int|float $req_ver The version to check, can be a string, an integer, or a float
3200  * @throws MWException
3201  */
3202 function wfUsePHP( $req_ver ) {
3203         $php_ver = PHP_VERSION;
3204
3205         if ( version_compare( $php_ver, (string)$req_ver, '<' ) ) {
3206                 throw new MWException( "PHP $req_ver required--this is only $php_ver" );
3207         }
3208 }
3209
3210 /**
3211  * This function works like "use VERSION" in Perl except it checks the version
3212  * of MediaWiki, the program will die with a backtrace if the current version
3213  * of MediaWiki is less than the version provided.
3214  *
3215  * This is useful for extensions which due to their nature are not kept in sync
3216  * with releases
3217  *
3218  * Note: Due to the behavior of PHP's version_compare() which is used in this
3219  * function, if you want to allow the 'wmf' development versions add a 'c' (or
3220  * any single letter other than 'a', 'b' or 'p') as a post-fix to your
3221  * targeted version number. For example if you wanted to allow any variation
3222  * of 1.22 use `wfUseMW( '1.22c' )`. Using an 'a' or 'b' instead of 'c' will
3223  * not result in the same comparison due to the internal logic of
3224  * version_compare().
3225  *
3226  * @see perldoc -f use
3227  *
3228  * @param string|int|float $req_ver The version to check, can be a string, an integer, or a float
3229  * @throws MWException
3230  */
3231 function wfUseMW( $req_ver ) {
3232         global $wgVersion;
3233
3234         if ( version_compare( $wgVersion, (string)$req_ver, '<' ) ) {
3235                 throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
3236         }
3237 }
3238
3239 /**
3240  * Return the final portion of a pathname.
3241  * Reimplemented because PHP5's "basename()" is buggy with multibyte text.
3242  * http://bugs.php.net/bug.php?id=33898
3243  *
3244  * PHP's basename() only considers '\' a pathchar on Windows and Netware.
3245  * We'll consider it so always, as we don't want '\s' in our Unix paths either.
3246  *
3247  * @param string $path
3248  * @param string $suffix String to remove if present
3249  * @return string
3250  */
3251 function wfBaseName( $path, $suffix = '' ) {
3252         if ( $suffix == '' ) {
3253                 $encSuffix = '';
3254         } else {
3255                 $encSuffix = '(?:' . preg_quote( $suffix, '#' ) . ')?';
3256         }
3257
3258         $matches = array();
3259         if ( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
3260                 return $matches[1];
3261         } else {
3262                 return '';
3263         }
3264 }
3265
3266 /**
3267  * Generate a relative path name to the given file.
3268  * May explode on non-matching case-insensitive paths,
3269  * funky symlinks, etc.
3270  *
3271  * @param string $path Absolute destination path including target filename
3272  * @param string $from Absolute source path, directory only
3273  * @return string
3274  */
3275 function wfRelativePath( $path, $from ) {
3276         // Normalize mixed input on Windows...
3277         $path = str_replace( '/', DIRECTORY_SEPARATOR, $path );
3278         $from = str_replace( '/', DIRECTORY_SEPARATOR, $from );
3279
3280         // Trim trailing slashes -- fix for drive root
3281         $path = rtrim( $path, DIRECTORY_SEPARATOR );
3282         $from = rtrim( $from, DIRECTORY_SEPARATOR );
3283
3284         $pieces = explode( DIRECTORY_SEPARATOR, dirname( $path ) );
3285         $against = explode( DIRECTORY_SEPARATOR, $from );
3286
3287         if ( $pieces[0] !== $against[0] ) {
3288                 // Non-matching Windows drive letters?
3289                 // Return a full path.
3290                 return $path;
3291         }
3292
3293         // Trim off common prefix
3294         while ( count( $pieces ) && count( $against )
3295                 && $pieces[0] == $against[0] ) {
3296                 array_shift( $pieces );
3297                 array_shift( $against );
3298         }
3299
3300         // relative dots to bump us to the parent
3301         while ( count( $against ) ) {
3302                 array_unshift( $pieces, '..' );
3303                 array_shift( $against );
3304         }
3305
3306         array_push( $pieces, wfBaseName( $path ) );
3307
3308         return implode( DIRECTORY_SEPARATOR, $pieces );
3309 }
3310
3311 /**
3312  * Convert an arbitrarily-long digit string from one numeric base
3313  * to another, optionally zero-padding to a minimum column width.
3314  *
3315  * Supports base 2 through 36; digit values 10-36 are represented
3316  * as lowercase letters a-z. Input is case-insensitive.
3317  *
3318  * @param string $input Input number
3319  * @param int $sourceBase Base of the input number
3320  * @param int $destBase Desired base of the output
3321  * @param int $pad Minimum number of digits in the output (pad with zeroes)
3322  * @param bool $lowercase Whether to output in lowercase or uppercase
3323  * @param string $engine Either "gmp", "bcmath", or "php"
3324  * @return string|bool The output number as a string, or false on error
3325  */
3326 function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1,
3327         $lowercase = true, $engine = 'auto'
3328 ) {
3329         $input = (string)$input;
3330         if (
3331                 $sourceBase < 2 ||
3332                 $sourceBase > 36 ||
3333                 $destBase < 2 ||
3334                 $destBase > 36 ||
3335                 $sourceBase != (int)$sourceBase ||
3336                 $destBase != (int)$destBase ||
3337                 $pad != (int)$pad ||
3338                 !preg_match(
3339                         "/^[" . substr( '0123456789abcdefghijklmnopqrstuvwxyz', 0, $sourceBase ) . "]+$/i",
3340                         $input
3341                 )
3342         ) {
3343                 return false;
3344         }
3345
3346         static $baseChars = array(
3347                 10 => 'a', 11 => 'b', 12 => 'c', 13 => 'd', 14 => 'e', 15 => 'f',
3348                 16 => 'g', 17 => 'h', 18 => 'i', 19 => 'j', 20 => 'k', 21 => 'l',
3349                 22 => 'm', 23 => 'n', 24 => 'o', 25 => 'p', 26 => 'q', 27 => 'r',
3350                 28 => 's', 29 => 't', 30 => 'u', 31 => 'v', 32 => 'w', 33 => 'x',
3351                 34 => 'y', 35 => 'z',
3352
3353                 '0' => 0, '1' => 1, '2' => 2, '3' => 3, '4' => 4, '5' => 5,
3354                 '6' => 6, '7' => 7, '8' => 8, '9' => 9, 'a' => 10, 'b' => 11,
3355                 'c' => 12, 'd' => 13, 'e' => 14, 'f' => 15, 'g' => 16, 'h' => 17,
3356                 'i' => 18, 'j' => 19, 'k' => 20, 'l' => 21, 'm' => 22, 'n' => 23,
3357                 'o' => 24, 'p' => 25, 'q' => 26, 'r' => 27, 's' => 28, 't' => 29,
3358                 'u' => 30, 'v' => 31, 'w' => 32, 'x' => 33, 'y' => 34, 'z' => 35
3359         );
3360
3361         if ( extension_loaded( 'gmp' ) && ( $engine == 'auto' || $engine == 'gmp' ) ) {
3362                 // Removing leading zeros works around broken base detection code in
3363                 // some PHP versions (see <https://bugs.php.net/bug.php?id=50175> and
3364                 // <https://bugs.php.net/bug.php?id=55398>).
3365                 $result = gmp_strval( gmp_init( ltrim( $input, '0' ), $sourceBase ), $destBase );
3366         } elseif ( extension_loaded( 'bcmath' ) && ( $engine == 'auto' || $engine == 'bcmath' ) ) {
3367                 $decimal = '0';
3368                 foreach ( str_split( strtolower( $input ) ) as $char ) {
3369                         $decimal = bcmul( $decimal, $sourceBase );
3370                         $decimal = bcadd( $decimal, $baseChars[$char] );
3371                 }
3372
3373                 // @codingStandardsIgnoreStart Generic.CodeAnalysis.ForLoopWithTestFunctionCall.NotAllowed
3374                 for ( $result = ''; bccomp( $decimal, 0 ); $decimal = bcdiv( $decimal, $destBase, 0 ) ) {
3375                         $result .= $baseChars[bcmod( $decimal, $destBase )];
3376                 }
3377                 // @codingStandardsIgnoreEnd
3378
3379                 $result = strrev( $result );
3380         } else {
3381                 $inDigits = array();
3382                 foreach ( str_split( strtolower( $input ) ) as $char ) {
3383                         $inDigits[] = $baseChars[$char];
3384                 }
3385
3386                 // Iterate over the input, modulo-ing out an output digit
3387                 // at a time until input is gone.
3388                 $result = '';
3389                 while ( $inDigits ) {
3390                         $work = 0;
3391                         $workDigits = array();
3392
3393                         // Long division...
3394                         foreach ( $inDigits as $digit ) {
3395                                 $work *= $sourceBase;
3396                                 $work += $digit;
3397
3398                                 if ( $workDigits || $work >= $destBase ) {
3399                                         $workDigits[] = (int)( $work / $destBase );
3400                                 }
3401                                 $work %= $destBase;
3402                         }
3403
3404                         // All that division leaves us with a remainder,
3405                         // which is conveniently our next output digit.
3406                         $result .= $baseChars[$work];
3407
3408                         // And we continue!
3409                         $inDigits = $workDigits;
3410                 }
3411
3412                 $result = strrev( $result );
3413         }
3414
3415         if ( !$lowercase ) {
3416                 $result = strtoupper( $result );
3417         }
3418
3419         return str_pad( $result, $pad, '0', STR_PAD_LEFT );
3420 }
3421
3422 /**
3423  * Check if there is sufficient entropy in php's built-in session generation
3424  *
3425  * @return bool True = there is sufficient entropy
3426  */
3427 function wfCheckEntropy() {
3428         return (
3429                         ( wfIsWindows() && version_compare( PHP_VERSION, '5.3.3', '>=' ) )
3430                         || ini_get( 'session.entropy_file' )
3431                 )
3432                 && intval( ini_get( 'session.entropy_length' ) ) >= 32;
3433 }
3434
3435 /**
3436  * Override session_id before session startup if php's built-in
3437  * session generation code is not secure.
3438  */
3439 function wfFixSessionID() {
3440         // If the cookie or session id is already set we already have a session and should abort
3441         if ( isset( $_COOKIE[session_name()] ) || session_id() ) {
3442                 return;
3443         }
3444
3445         // PHP's built-in session entropy is enabled if:
3446         // - entropy_file is set or you're on Windows with php 5.3.3+
3447         // - AND entropy_length is > 0
3448         // We treat it as disabled if it doesn't have an entropy length of at least 32
3449         $entropyEnabled = wfCheckEntropy();
3450
3451         // If built-in entropy is not enabled or not sufficient override PHP's
3452         // built in session id generation code
3453         if ( !$entropyEnabled ) {
3454                 wfDebug( __METHOD__ . ": PHP's built in entropy is disabled or not sufficient, " .
3455                         "overriding session id generation using our cryptrand source.\n" );
3456                 session_id( MWCryptRand::generateHex( 32 ) );
3457         }
3458 }
3459
3460 /**
3461  * Reset the session_id
3462  *
3463  * @since 1.22
3464  */
3465 function wfResetSessionID() {
3466         global $wgCookieSecure;
3467         $oldSessionId = session_id();
3468         $cookieParams = session_get_cookie_params();
3469         if ( wfCheckEntropy() && $wgCookieSecure == $cookieParams['secure'] ) {
3470                 session_regenerate_id( false );
3471         } else {
3472                 $tmp = $_SESSION;
3473                 session_destroy();
3474                 wfSetupSession( MWCryptRand::generateHex( 32 ) );
3475                 $_SESSION = $tmp;
3476         }
3477         $newSessionId = session_id();
3478         Hooks::run( 'ResetSessionID', array( $oldSessionId, $newSessionId ) );
3479 }
3480
3481 /**
3482  * Initialise php session
3483  *
3484  * @param bool $sessionId
3485  */
3486 function wfSetupSession( $sessionId = false ) {
3487         global $wgSessionsInMemcached, $wgSessionsInObjectCache, $wgCookiePath, $wgCookieDomain,
3488                         $wgCookieSecure, $wgCookieHttpOnly, $wgSessionHandler;
3489         if ( $wgSessionsInObjectCache || $wgSessionsInMemcached ) {
3490                 ObjectCacheSessionHandler::install();
3491         } elseif ( $wgSessionHandler && $wgSessionHandler != ini_get( 'session.save_handler' ) ) {
3492                 # Only set this if $wgSessionHandler isn't null and session.save_handler
3493                 # hasn't already been set to the desired value (that causes errors)
3494                 ini_set( 'session.save_handler', $wgSessionHandler );
3495         }
3496         session_set_cookie_params(
3497                 0, $wgCookiePath, $wgCookieDomain, $wgCookieSecure, $wgCookieHttpOnly );
3498         session_cache_limiter( 'private, must-revalidate' );
3499         if ( $sessionId ) {
3500                 session_id( $sessionId );
3501         } else {
3502                 wfFixSessionID();
3503         }
3504         wfSuppressWarnings();
3505         session_start();
3506         wfRestoreWarnings();
3507 }
3508
3509 /**
3510  * Get an object from the precompiled serialized directory
3511  *
3512  * @param string $name
3513  * @return mixed The variable on success, false on failure
3514  */
3515 function wfGetPrecompiledData( $name ) {
3516         global $IP;
3517
3518         $file = "$IP/serialized/$name";
3519         if ( file_exists( $file ) ) {
3520                 $blob = file_get_contents( $file );
3521                 if ( $blob ) {
3522                         return unserialize( $blob );
3523                 }
3524         }
3525         return false;
3526 }
3527
3528 /**
3529  * Get a cache key
3530  *
3531  * @param string $args,...
3532  * @return string
3533  */
3534 function wfMemcKey( /*...*/ ) {
3535         global $wgCachePrefix;
3536         $prefix = $wgCachePrefix === false ? wfWikiID() : $wgCachePrefix;
3537         $args = func_get_args();
3538         $key = $prefix . ':' . implode( ':', $args );
3539         $key = str_replace( ' ', '_', $key );
3540         return $key;
3541 }
3542
3543 /**
3544  * Get a cache key for a foreign DB
3545  *
3546  * @param string $db
3547  * @param string $prefix
3548  * @param string $args,...
3549  * @return string
3550  */
3551 function wfForeignMemcKey( $db, $prefix /*...*/ ) {
3552         $args = array_slice( func_get_args(), 2 );
3553         if ( $prefix ) {
3554                 $key = "$db-$prefix:" . implode( ':', $args );
3555         } else {
3556                 $key = $db . ':' . implode( ':', $args );
3557         }
3558         return str_replace( ' ', '_', $key );
3559 }
3560
3561 /**
3562  * Get an ASCII string identifying this wiki
3563  * This is used as a prefix in memcached keys
3564  *
3565  * @return string
3566  */
3567 function wfWikiID() {
3568         global $wgDBprefix, $wgDBname;
3569         if ( $wgDBprefix ) {
3570                 return "$wgDBname-$wgDBprefix";
3571         } else {
3572                 return $wgDBname;
3573         }
3574 }
3575
3576 /**
3577  * Split a wiki ID into DB name and table prefix
3578  *
3579  * @param string $wiki
3580  *
3581  * @return array
3582  */
3583 function wfSplitWikiID( $wiki ) {
3584         $bits = explode( '-', $wiki, 2 );
3585         if ( count( $bits ) < 2 ) {
3586                 $bits[] = '';
3587         }
3588         return $bits;
3589 }
3590
3591 /**
3592  * Get a Database object.
3593  *
3594  * @param int $db Index of the connection to get. May be DB_MASTER for the
3595  *            master (for write queries), DB_SLAVE for potentially lagged read
3596  *            queries, or an integer >= 0 for a particular server.
3597  *
3598  * @param string|string[] $groups Query groups. An array of group names that this query
3599  *                belongs to. May contain a single string if the query is only
3600  *                in one group.
3601  *
3602  * @param string|bool $wiki The wiki ID, or false for the current wiki
3603  *
3604  * Note: multiple calls to wfGetDB(DB_SLAVE) during the course of one request
3605  * will always return the same object, unless the underlying connection or load
3606  * balancer is manually destroyed.
3607  *
3608  * Note 2: use $this->getDB() in maintenance scripts that may be invoked by
3609  * updater to ensure that a proper database is being updated.
3610  *
3611  * @return DatabaseBase
3612  */
3613 function wfGetDB( $db, $groups = array(), $wiki = false ) {
3614         return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
3615 }
3616
3617 /**
3618  * Get a load balancer object.
3619  *
3620  * @param string|bool $wiki Wiki ID, or false for the current wiki
3621  * @return LoadBalancer
3622  */
3623 function wfGetLB( $wiki = false ) {
3624         return wfGetLBFactory()->getMainLB( $wiki );
3625 }
3626
3627 /**
3628  * Get the load balancer factory object
3629  *
3630  * @return LBFactory
3631  */
3632 function wfGetLBFactory() {
3633         return LBFactory::singleton();
3634 }
3635
3636 /**
3637  * Find a file.
3638  * Shortcut for RepoGroup::singleton()->findFile()
3639  *
3640  * @param string $title String or Title object
3641  * @param array $options Associative array of options (see RepoGroup::findFile)
3642  * @return File|bool File, or false if the file does not exist
3643  */
3644 function wfFindFile( $title, $options = array() ) {
3645         return RepoGroup::singleton()->findFile( $title, $options );
3646 }
3647
3648 /**
3649  * Get an object referring to a locally registered file.
3650  * Returns a valid placeholder object if the file does not exist.
3651  *
3652  * @param Title|string $title
3653  * @return LocalFile|null A File, or null if passed an invalid Title
3654  */
3655 function wfLocalFile( $title ) {
3656         return RepoGroup::singleton()->getLocalRepo()->newFile( $title );
3657 }
3658
3659 /**
3660  * Should low-performance queries be disabled?
3661  *
3662  * @return bool
3663  * @codeCoverageIgnore
3664  */
3665 function wfQueriesMustScale() {
3666         global $wgMiserMode;
3667         return $wgMiserMode
3668                 || ( SiteStats::pages() > 100000
3669                 && SiteStats::edits() > 1000000
3670                 && SiteStats::users() > 10000 );
3671 }
3672
3673 /**
3674  * Get the path to a specified script file, respecting file
3675  * extensions; this is a wrapper around $wgScriptExtension etc.
3676  * except for 'index' and 'load' which use $wgScript/$wgLoadScript
3677  *
3678  * @param string $script Script filename, sans extension
3679  * @return string
3680  */
3681 function wfScript( $script = 'index' ) {
3682         global $wgScriptPath, $wgScriptExtension, $wgScript, $wgLoadScript;
3683         if ( $script === 'index' ) {
3684                 return $wgScript;
3685         } elseif ( $script === 'load' ) {
3686                 return $wgLoadScript;
3687         } else {
3688                 return "{$wgScriptPath}/{$script}{$wgScriptExtension}";
3689         }
3690 }
3691
3692 /**
3693  * Get the script URL.
3694  *
3695  * @return string Script URL
3696  */
3697 function wfGetScriptUrl() {
3698         if ( isset( $_SERVER['SCRIPT_NAME'] ) ) {
3699                 #
3700                 # as it was called, minus the query string.
3701                 #
3702                 # Some sites use Apache rewrite rules to handle subdomains,
3703                 # and have PHP set up in a weird way that causes PHP_SELF
3704                 # to contain the rewritten URL instead of the one that the
3705                 # outside world sees.
3706                 #
3707                 # If in this mode, use SCRIPT_URL instead, which mod_rewrite
3708                 # provides containing the "before" URL.
3709                 return $_SERVER['SCRIPT_NAME'];
3710         } else {
3711                 return $_SERVER['URL'];
3712         }
3713 }
3714
3715 /**
3716  * Convenience function converts boolean values into "true"
3717  * or "false" (string) values
3718  *
3719  * @param bool $value
3720  * @return string
3721  */
3722 function wfBoolToStr( $value ) {
3723         return $value ? 'true' : 'false';
3724 }
3725
3726 /**
3727  * Get a platform-independent path to the null file, e.g. /dev/null
3728  *
3729  * @return string
3730  */
3731 function wfGetNull() {
3732         return wfIsWindows() ? 'NUL' : '/dev/null';
3733 }
3734
3735 /**
3736  * Waits for the slaves to catch up to the master position
3737  *
3738  * Use this when updating very large numbers of rows, as in maintenance scripts,
3739  * to avoid causing too much lag. Of course, this is a no-op if there are no slaves.
3740  *
3741  * By default this waits on the main DB cluster of the current wiki.
3742  * If $cluster is set to "*" it will wait on all DB clusters, including
3743  * external ones. If the lag being waiting on is caused by the code that
3744  * does this check, it makes since to use $ifWritesSince, particularly if
3745  * cluster is "*", to avoid excess overhead.
3746  *
3747  * Never call this function after a big DB write that is still in a transaction.
3748  * This only makes sense after the possible lag inducing changes were committed.
3749  *
3750  * @param float|null $ifWritesSince Only wait if writes were done since this UNIX timestamp
3751  * @param string|bool $wiki Wiki identifier accepted by wfGetLB
3752  * @param string|bool $cluster Cluster name accepted by LBFactory. Default: false.
3753  * @param int|null $timeout Max wait time. Default: 1 day (cli), ~10 seconds (web)
3754  * @return bool Success (able to connect and no timeouts reached)
3755  */
3756 function wfWaitForSlaves(
3757         $ifWritesSince = null, $wiki = false, $cluster = false, $timeout = null
3758 ) {
3759         // B/C: first argument used to be "max seconds of lag"; ignore such values
3760         $ifWritesSince = ( $ifWritesSince > 1e9 ) ? $ifWritesSince : null;
3761
3762         if ( $timeout === null ) {
3763                 $timeout = ( PHP_SAPI === 'cli' ) ? 86400 : 10;
3764         }
3765
3766         // Figure out which clusters need to be checked
3767         $lbs = array();
3768         if ( $cluster === '*' ) {
3769                 wfGetLBFactory()->forEachLB( function ( LoadBalancer $lb ) use ( &$lbs ) {
3770                         $lbs[] = $lb;
3771                 } );
3772         } elseif ( $cluster !== false ) {
3773                 $lbs[] = wfGetLBFactory()->getExternalLB( $cluster );
3774         } else {
3775                 $lbs[] = wfGetLB( $wiki );
3776         }
3777
3778         // Get all the master positions of applicable DBs right now.
3779         // This can be faster since waiting on one cluster reduces the
3780         // time needed to wait on the next clusters.
3781         $masterPositions = array_fill( 0, count( $lbs ), false );
3782         foreach ( $lbs as $i => $lb ) {
3783                 // bug 27975 - Don't try to wait for slaves if there are none
3784                 // Prevents permission error when getting master position
3785                 if ( $lb->getServerCount() > 1 ) {
3786                         if ( $ifWritesSince && !$lb->hasMasterConnection() ) {
3787                                 continue; // assume no writes done
3788                         }
3789                         // Use the empty string to not trigger selectDB() since the connection
3790                         // may have been to a server that does not have a DB for the current wiki.
3791                         $dbw = $lb->getConnection( DB_MASTER, array(), '' );
3792                         if ( $ifWritesSince && $dbw->lastDoneWrites() < $ifWritesSince ) {
3793                                 continue; // no writes since the last wait
3794                         }
3795                         $masterPositions[$i] = $dbw->getMasterPos();
3796                 }
3797         }
3798
3799         $ok = true;
3800         foreach ( $lbs as $i => $lb ) {
3801                 if ( $masterPositions[$i] ) {
3802                         // The DBMS may not support getMasterPos() or the whole
3803                         // load balancer might be fake (e.g. $wgAllDBsAreLocalhost).
3804                         $ok = $lb->waitForAll( $masterPositions[$i], $timeout ) && $ok;
3805                 }
3806         }
3807
3808         return $ok;
3809 }
3810
3811 /**
3812  * Count down from $seconds to zero on the terminal, with a one-second pause
3813  * between showing each number. For use in command-line scripts.
3814  *
3815  * @codeCoverageIgnore
3816  * @param int $seconds
3817  */
3818 function wfCountDown( $seconds ) {
3819         for ( $i = $seconds; $i >= 0; $i-- ) {
3820                 if ( $i != $seconds ) {
3821                         echo str_repeat( "\x08", strlen( $i + 1 ) );
3822                 }
3823                 echo $i;
3824                 flush();
3825                 if ( $i ) {
3826                         sleep( 1 );
3827                 }
3828         }
3829         echo "\n";
3830 }
3831
3832 /**
3833  * Replace all invalid characters with -
3834  * Additional characters can be defined in $wgIllegalFileChars (see bug 20489)
3835  * By default, $wgIllegalFileChars = ':'
3836  *
3837  * @param string $name Filename to process
3838  * @return string
3839  */
3840 function wfStripIllegalFilenameChars( $name ) {
3841         global $wgIllegalFileChars;
3842         $illegalFileChars = $wgIllegalFileChars ? "|[" . $wgIllegalFileChars . "]" : '';
3843         $name = wfBaseName( $name );
3844         $name = preg_replace(
3845                 "/[^" . Title::legalChars() . "]" . $illegalFileChars . "/",
3846                 '-',
3847                 $name
3848         );
3849         return $name;
3850 }
3851
3852 /**
3853  * Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit;
3854  *
3855  * @return int Value the memory limit was set to.
3856  */
3857 function wfMemoryLimit() {
3858         global $wgMemoryLimit;
3859         $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
3860         if ( $memlimit != -1 ) {
3861                 $conflimit = wfShorthandToInteger( $wgMemoryLimit );
3862                 if ( $conflimit == -1 ) {
3863                         wfDebug( "Removing PHP's memory limit\n" );
3864                         wfSuppressWarnings();
3865                         ini_set( 'memory_limit', $conflimit );
3866                         wfRestoreWarnings();
3867                         return $conflimit;
3868                 } elseif ( $conflimit > $memlimit ) {
3869                         wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
3870                         wfSuppressWarnings();
3871                         ini_set( 'memory_limit', $conflimit );
3872                         wfRestoreWarnings();
3873                         return $conflimit;
3874                 }
3875         }
3876         return $memlimit;
3877 }
3878
3879 /**
3880  * Converts shorthand byte notation to integer form
3881  *
3882  * @param string $string
3883  * @return int
3884  */
3885 function wfShorthandToInteger( $string = '' ) {
3886         $string = trim( $string );
3887         if ( $string === '' ) {
3888                 return -1;
3889         }
3890         $last = $string[strlen( $string ) - 1];
3891         $val = intval( $string );
3892         switch ( $last ) {
3893                 case 'g':
3894                 case 'G':
3895                         $val *= 1024;
3896                         // break intentionally missing
3897                 case 'm':
3898                 case 'M':
3899                         $val *= 1024;
3900                         // break intentionally missing
3901                 case 'k':
3902                 case 'K':
3903                         $val *= 1024;
3904         }
3905
3906         return $val;
3907 }
3908
3909 /**
3910  * Get the normalised IETF language tag
3911  * See unit test for examples.
3912  *
3913  * @param string $code The language code.
3914  * @return string The language code which complying with BCP 47 standards.
3915  */
3916 function wfBCP47( $code ) {
3917         $codeSegment = explode( '-', $code );
3918         $codeBCP = array();
3919         foreach ( $codeSegment as $segNo => $seg ) {
3920                 // when previous segment is x, it is a private segment and should be lc
3921                 if ( $segNo > 0 && strtolower( $codeSegment[( $segNo - 1 )] ) == 'x' ) {
3922                         $codeBCP[$segNo] = strtolower( $seg );
3923                 // ISO 3166 country code
3924                 } elseif ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) {
3925                         $codeBCP[$segNo] = strtoupper( $seg );
3926                 // ISO 15924 script code
3927                 } elseif ( ( strlen( $seg ) == 4 ) && ( $segNo > 0 ) ) {
3928                         $codeBCP[$segNo] = ucfirst( strtolower( $seg ) );
3929                 // Use lowercase for other cases
3930                 } else {
3931                         $codeBCP[$segNo] = strtolower( $seg );
3932                 }
3933         }
3934         $langCode = implode( '-', $codeBCP );
3935         return $langCode;
3936 }
3937
3938 /**
3939  * Get a cache object.
3940  *
3941  * @param int $inputType Cache type, one of the CACHE_* constants.
3942  * @return BagOStuff
3943  */
3944 function wfGetCache( $inputType ) {
3945         return ObjectCache::getInstance( $inputType );
3946 }
3947
3948 /**
3949  * Get the main cache object
3950  *
3951  * @return BagOStuff
3952  */
3953 function wfGetMainCache() {
3954         global $wgMainCacheType;
3955         return ObjectCache::getInstance( $wgMainCacheType );
3956 }
3957
3958 /**
3959  * Get the cache object used by the message cache
3960  *
3961  * @return BagOStuff
3962  */
3963 function wfGetMessageCacheStorage() {
3964         global $wgMessageCacheType;
3965         return ObjectCache::getInstance( $wgMessageCacheType );
3966 }
3967
3968 /**
3969  * Get the cache object used by the parser cache
3970  *
3971  * @return BagOStuff
3972  */
3973 function wfGetParserCacheStorage() {
3974         global $wgParserCacheType;
3975         return ObjectCache::getInstance( $wgParserCacheType );
3976 }
3977
3978 /**
3979  * Call hook functions defined in $wgHooks
3980  *
3981  * @param string $event Event name
3982  * @param array $args Parameters passed to hook functions
3983  * @param string|null $deprecatedVersion Optionally mark hook as deprecated with version number
3984  *
3985  * @return bool True if no handler aborted the hook
3986  * @deprecated 1.25 - use Hooks::run
3987  */
3988 function wfRunHooks( $event, array $args = array(), $deprecatedVersion = null ) {
3989         return Hooks::run( $event, $args, $deprecatedVersion );
3990 }
3991
3992 /**
3993  * Wrapper around php's unpack.
3994  *
3995  * @param string $format The format string (See php's docs)
3996  * @param string $data A binary string of binary data
3997  * @param int|bool $length The minimum length of $data or false. This is to
3998  *      prevent reading beyond the end of $data. false to disable the check.
3999  *
4000  * Also be careful when using this function to read unsigned 32 bit integer
4001  * because php might make it negative.
4002  *
4003  * @throws MWException If $data not long enough, or if unpack fails
4004  * @return array Associative array of the extracted data
4005  */
4006 function wfUnpack( $format, $data, $length = false ) {
4007         if ( $length !== false ) {
4008                 $realLen = strlen( $data );
4009                 if ( $realLen < $length ) {
4010                         throw new MWException( "Tried to use wfUnpack on a "
4011                                 . "string of length $realLen, but needed one "
4012                                 . "of at least length $length."
4013                         );
4014                 }
4015         }
4016
4017         wfSuppressWarnings();
4018         $result = unpack( $format, $data );
4019         wfRestoreWarnings();
4020
4021         if ( $result === false ) {
4022                 // If it cannot extract the packed data.
4023                 throw new MWException( "unpack could not unpack binary data" );
4024         }
4025         return $result;
4026 }
4027
4028 /**
4029  * Determine if an image exists on the 'bad image list'.
4030  *
4031  * The format of MediaWiki:Bad_image_list is as follows:
4032  *    * Only list items (lines starting with "*") are considered
4033  *    * The first link on a line must be a link to a bad image
4034  *    * Any subsequent links on the same line are considered to be exceptions,
4035  *      i.e. articles where the image may occur inline.
4036  *
4037  * @param string $name The image name to check
4038  * @param Title|bool $contextTitle The page on which the image occurs, if known
4039  * @param string $blacklist Wikitext of a file blacklist
4040  * @return bool
4041  */
4042 function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
4043         static $badImageCache = null; // based on bad_image_list msg
4044
4045         # Handle redirects
4046         $redirectTitle = RepoGroup::singleton()->checkRedirect( Title::makeTitle( NS_FILE, $name ) );
4047         if ( $redirectTitle ) {
4048                 $name = $redirectTitle->getDBkey();
4049         }
4050
4051         # Run the extension hook
4052         $bad = false;
4053         if ( !Hooks::run( 'BadImage', array( $name, &$bad ) ) ) {
4054                 return $bad;
4055         }
4056
4057         $cacheable = ( $blacklist === null );
4058         if ( $cacheable && $badImageCache !== null ) {
4059                 $badImages = $badImageCache;
4060         } else { // cache miss
4061                 if ( $blacklist === null ) {
4062                         $blacklist = wfMessage( 'bad_image_list' )->inContentLanguage()->plain(); // site list
4063                 }
4064                 # Build the list now
4065                 $badImages = array();
4066                 $lines = explode( "\n", $blacklist );
4067                 foreach ( $lines as $line ) {
4068                         # List items only
4069                         if ( substr( $line, 0, 1 ) !== '*' ) {
4070                                 continue;
4071                         }
4072
4073                         # Find all links
4074                         $m = array();
4075                         if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
4076                                 continue;
4077                         }
4078
4079                         $exceptions = array();
4080                         $imageDBkey = false;
4081                         foreach ( $m[1] as $i => $titleText ) {
4082                                 $title = Title::newFromText( $titleText );
4083                                 if ( !is_null( $title ) ) {
4084                                         if ( $i == 0 ) {
4085                                                 $imageDBkey = $title->getDBkey();
4086                                         } else {
4087                                                 $exceptions[$title->getPrefixedDBkey()] = true;
4088                                         }
4089                                 }
4090                         }
4091
4092                         if ( $imageDBkey !== false ) {
4093                                 $badImages[$imageDBkey] = $exceptions;
4094                         }
4095                 }
4096                 if ( $cacheable ) {
4097                         $badImageCache = $badImages;
4098                 }
4099         }
4100
4101         $contextKey = $contextTitle ? $contextTitle->getPrefixedDBkey() : false;
4102         $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
4103         return $bad;
4104 }
4105
4106 /**
4107  * Determine whether the client at a given source IP is likely to be able to
4108  * access the wiki via HTTPS.
4109  *
4110  * @param string $ip The IPv4/6 address in the normal human-readable form
4111  * @return bool
4112  */
4113 function wfCanIPUseHTTPS( $ip ) {
4114         $canDo = true;
4115         Hooks::run( 'CanIPUseHTTPS', array( $ip, &$canDo ) );
4116         return !!$canDo;
4117 }
4118
4119 /**
4120  * Determine input string is represents as infinity
4121  *
4122  * @param string $str The string to determine
4123  * @return bool
4124  * @since 1.25
4125  */
4126 function wfIsInfinity( $str ) {
4127         $infinityValues = array( 'infinite', 'indefinite', 'infinity', 'never' );
4128         return in_array( $str, $infinityValues );
4129 }
4130
4131 /**
4132  * Work out the IP address based on various globals
4133  * For trusted proxies, use the XFF client IP (first of the chain)
4134  *
4135  * @deprecated since 1.19; call $wgRequest->getIP() directly.
4136  * @return string
4137  */
4138 function wfGetIP() {
4139         wfDeprecated( __METHOD__, '1.19' );
4140         global $wgRequest;
4141         return $wgRequest->getIP();
4142 }
4143
4144 /**
4145  * Checks if an IP is a trusted proxy provider.
4146  * Useful to tell if X-Forwarded-For data is possibly bogus.
4147  * Squid cache servers for the site are whitelisted.
4148  * @deprecated Since 1.24, use IP::isTrustedProxy()
4149  *
4150  * @param string $ip
4151  * @return bool
4152  */
4153 function wfIsTrustedProxy( $ip ) {
4154         wfDeprecated( __METHOD__, '1.24' );
4155         return IP::isTrustedProxy( $ip );
4156 }
4157
4158 /**
4159  * Checks if an IP matches a proxy we've configured.
4160  * @deprecated Since 1.24, use IP::isConfiguredProxy()
4161  *
4162  * @param string $ip
4163  * @return bool
4164  * @since 1.23 Supports CIDR ranges in $wgSquidServersNoPurge
4165  */
4166 function wfIsConfiguredProxy( $ip ) {
4167         wfDeprecated( __METHOD__, '1.24' );
4168         return IP::isConfiguredProxy( $ip );
4169 }
4170
4171 /**
4172  * Returns true if these thumbnail parameters match one that MediaWiki
4173  * requests from file description pages and/or parser output.
4174  *
4175  * $params is considered non-standard if they involve a non-standard
4176  * width or any non-default parameters aside from width and page number.
4177  * The number of possible files with standard parameters is far less than
4178  * that of all combinations; rate-limiting for them can thus be more generious.
4179  *
4180  * @param File $file
4181  * @param array $params
4182  * @return bool
4183  * @since 1.24 Moved from thumb.php to GlobalFunctions in 1.25
4184  */
4185 function wfThumbIsStandard( File $file, array $params ) {
4186         global $wgThumbLimits, $wgImageLimits, $wgResponsiveImages;
4187
4188         $multipliers = array( 1 );
4189         if ( $wgResponsiveImages ) {
4190                 // These available sizes are hardcoded currently elsewhere in MediaWiki.
4191                 // @see Linker::processResponsiveImages
4192                 $multipliers[] = 1.5;
4193                 $multipliers[] = 2;
4194         }
4195
4196         $handler = $file->getHandler();
4197         if ( !$handler || !isset( $params['width'] ) ) {
4198                 return false;
4199         }
4200
4201         $basicParams = array();
4202         if ( isset( $params['page'] ) ) {
4203                 $basicParams['page'] = $params['page'];
4204         }
4205
4206         $thumbLimits = array();
4207         $imageLimits = array();
4208         // Expand limits to account for multipliers
4209         foreach ( $multipliers as $multiplier ) {
4210                 $thumbLimits = array_merge( $thumbLimits, array_map(
4211                         function ( $width ) use ( $multiplier ) {
4212                                 return round( $width * $multiplier );
4213                         }, $wgThumbLimits )
4214                 );
4215                 $imageLimits = array_merge( $imageLimits, array_map(
4216                         function ( $pair ) use ( $multiplier ) {
4217                                 return array(
4218                                         round( $pair[0] * $multiplier ),
4219                                         round( $pair[1] * $multiplier ),
4220                                 );
4221                         }, $wgImageLimits )
4222                 );
4223         }
4224
4225         // Check if the width matches one of $wgThumbLimits
4226         if ( in_array( $params['width'], $thumbLimits ) ) {
4227                 $normalParams = $basicParams + array( 'width' => $params['width'] );
4228                 // Append any default values to the map (e.g. "lossy", "lossless", ...)
4229                 $handler->normaliseParams( $file, $normalParams );
4230         } else {
4231                 // If not, then check if the width matchs one of $wgImageLimits
4232                 $match = false;
4233                 foreach ( $imageLimits as $pair ) {
4234                         $normalParams = $basicParams + array( 'width' => $pair[0], 'height' => $pair[1] );
4235                         // Decide whether the thumbnail should be scaled on width or height.
4236                         // Also append any default values to the map (e.g. "lossy", "lossless", ...)
4237                         $handler->normaliseParams( $file, $normalParams );
4238                         // Check if this standard thumbnail size maps to the given width
4239                         if ( $normalParams['width'] == $params['width'] ) {
4240                                 $match = true;
4241                                 break;
4242                         }
4243                 }
4244                 if ( !$match ) {
4245                         return false; // not standard for description pages
4246                 }
4247         }
4248
4249         // Check that the given values for non-page, non-width, params are just defaults
4250         foreach ( $params as $key => $value ) {
4251                 if ( !isset( $normalParams[$key] ) || $normalParams[$key] != $value ) {
4252                         return false;
4253                 }
4254         }
4255
4256         return true;
4257 }