includes/GlobalFunctions.php

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