includes/GlobalFunctions.php

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