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