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