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