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