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