includes/GlobalFunctions.php

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