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 // Hide compatibility functions from Doxygen
  28 /// @cond
  29
  30 /**
  31  * Compatibility functions
  32  *
  33  * We support PHP 5.3.2 and up.
  34  * Re-implementations of newer functions or functions in non-standard
  35  * PHP extensions may be included here.
  36  */
  37
  38 if ( !function_exists( 'iconv' ) ) {
  39         /**
  40          * @codeCoverageIgnore
  41          * @return string
  42          */
  43         function iconv( $from, $to, $string ) {
  44                 return Fallback::iconv( $from, $to, $string );
  45         }
  46 }
  47
  48 if ( !function_exists( 'mb_substr' ) ) {
  49         /**
  50          * @codeCoverageIgnore
  51          * @return string
  52          */
  53         function mb_substr( $str, $start, $count = 'end' ) {
  54                 return Fallback::mb_substr( $str, $start, $count );
  55         }
  56
  57         /**
  58          * @codeCoverageIgnore
  59          * @return int
  60          */
  61         function mb_substr_split_unicode( $str, $splitPos ) {
  62                 return Fallback::mb_substr_split_unicode( $str, $splitPos );
  63         }
  64 }
  65
  66 if ( !function_exists( 'mb_strlen' ) ) {
  67         /**
  68          * @codeCoverageIgnore
  69          * @return int
  70          */
  71         function mb_strlen( $str, $enc = '' ) {
  72                 return Fallback::mb_strlen( $str, $enc );
  73         }
  74 }
  75
  76 if ( !function_exists( 'mb_strpos' ) ) {
  77         /**
  78          * @codeCoverageIgnore
  79          * @return int
  80          */
  81         function mb_strpos( $haystack, $needle, $offset = 0, $encoding = '' ) {
  82                 return Fallback::mb_strpos( $haystack, $needle, $offset, $encoding );
  83         }
  84
  85 }
  86
  87 if ( !function_exists( 'mb_strrpos' ) ) {
  88         /**
  89          * @codeCoverageIgnore
  90          * @return int
  91          */
  92         function mb_strrpos( $haystack, $needle, $offset = 0, $encoding = '' ) {
  93                 return Fallback::mb_strrpos( $haystack, $needle, $offset, $encoding );
  94         }
  95 }
  96
  97 // gzdecode function only exists in PHP >= 5.4.0
  98 // http://php.net/gzdecode
  99 if ( !function_exists( 'gzdecode' ) ) {
 100         /**
 101          * @codeCoverageIgnore
 102          * @return string
 103          */
 104         function gzdecode( $data ) {
 105                 return gzinflate( substr( $data, 10, -8 ) );
 106         }
 107 }
 108 /// @endcond
 109
 110 /**
 111  * Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
 112  * @param $a array
 113  * @param $b array
 114  * @return array
 115  */
 116 function wfArrayDiff2( $a, $b ) {
 117         return array_udiff( $a, $b, 'wfArrayDiff2_cmp' );
 118 }
 119
 120 /**
 121  * @param $a
 122  * @param $b
 123  * @return int
 124  */
 125 function wfArrayDiff2_cmp( $a, $b ) {
 126         if ( !is_array( $a ) ) {
 127                 return strcmp( $a, $b );
 128         } elseif ( count( $a ) !== count( $b ) ) {
 129                 return count( $a ) < count( $b ) ? -1 : 1;
 130         } else {
 131                 reset( $a );
 132                 reset( $b );
 133                 while ( ( list( , $valueA ) = each( $a ) ) && ( list( , $valueB ) = each( $b ) ) ) {
 134                         $cmp = strcmp( $valueA, $valueB );
 135                         if ( $cmp !== 0 ) {
 136                                 return $cmp;
 137                         }
 138                 }
 139                 return 0;
 140         }
 141 }
 142
 143 /**
 144  * Array lookup
 145  * Returns an array where the values in array $b are replaced by the
 146  * values in array $a with the corresponding keys
 147  *
 148  * @deprecated since 1.22; use array_intersect_key()
 149  * @param $a Array
 150  * @param $b Array
 151  * @return array
 152  */
 153 function wfArrayLookup( $a, $b ) {
 154         wfDeprecated( __FUNCTION__, '1.22' );
 155         return array_flip( array_intersect( array_flip( $a ), array_keys( $b ) ) );
 156 }
 157
 158 /**
 159  * Appends to second array if $value differs from that in $default
 160  *
 161  * @param $key String|Int
 162  * @param $value Mixed
 163  * @param $default Mixed
 164  * @param array $changed to alter
 165  * @throws MWException
 166  */
 167 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
 168         if ( is_null( $changed ) ) {
 169                 throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' );
 170         }
 171         if ( $default[$key] !== $value ) {
 172                 $changed[$key] = $value;
 173         }
 174 }
 175
 176 /**
 177  * Backwards array plus for people who haven't bothered to read the PHP manual
 178  * XXX: will not darn your socks for you.
 179  *
 180  * @deprecated since 1.22; use array_replace()
 181  * @param $array1 Array
 182  * @param [$array2, [...]] Arrays
 183  * @return Array
 184  */
 185 function wfArrayMerge( $array1/* ... */ ) {
 186         wfDeprecated( __FUNCTION__, '1.22' );
 187         $args = func_get_args();
 188         $args = array_reverse( $args, true );
 189         $out = array();
 190         foreach ( $args as $arg ) {
 191                 $out += $arg;
 192         }
 193         return $out;
 194 }
 195
 196 /**
 197  * Merge arrays in the style of getUserPermissionsErrors, with duplicate removal
 198  * e.g.
 199  *      wfMergeErrorArrays(
 200  *              array( array( 'x' ) ),
 201  *              array( array( 'x', '2' ) ),
 202  *              array( array( 'x' ) ),
 203  *              array( array( 'y' ) )
 204  *      );
 205  * returns:
 206  *              array(
 207  *              array( 'x', '2' ),
 208  *              array( 'x' ),
 209  *              array( 'y' )
 210  *      )
 211  * @param varargs
 212  * @return Array
 213  */
 214 function wfMergeErrorArrays( /*...*/ ) {
 215         $args = func_get_args();
 216         $out = array();
 217         foreach ( $args as $errors ) {
 218                 foreach ( $errors as $params ) {
 219                         # @todo FIXME: Sometimes get nested arrays for $params,
 220                         # which leads to E_NOTICEs
 221                         $spec = implode( "\t", $params );
 222                         $out[$spec] = $params;
 223                 }
 224         }
 225         return array_values( $out );
 226 }
 227
 228 /**
 229  * Insert array into another array after the specified *KEY*
 230  *
 231  * @param array $array The array.
 232  * @param array $insert The array to insert.
 233  * @param $after Mixed: The key to insert after
 234  * @return Array
 235  */
 236 function wfArrayInsertAfter( array $array, array $insert, $after ) {
 237         // Find the offset of the element to insert after.
 238         $keys = array_keys( $array );
 239         $offsetByKey = array_flip( $keys );
 240
 241         $offset = $offsetByKey[$after];
 242
 243         // Insert at the specified offset
 244         $before = array_slice( $array, 0, $offset + 1, true );
 245         $after = array_slice( $array, $offset + 1, count( $array ) - $offset, true );
 246
 247         $output = $before + $insert + $after;
 248
 249         return $output;
 250 }
 251
 252 /**
 253  * Recursively converts the parameter (an object) to an array with the same data
 254  *
 255  * @param $objOrArray Object|Array
 256  * @param $recursive Bool
 257  * @return Array
 258  */
 259 function wfObjectToArray( $objOrArray, $recursive = true ) {
 260         $array = array();
 261         if ( is_object( $objOrArray ) ) {
 262                 $objOrArray = get_object_vars( $objOrArray );
 263         }
 264         foreach ( $objOrArray as $key => $value ) {
 265                 if ( $recursive && ( is_object( $value ) || is_array( $value ) ) ) {
 266                         $value = wfObjectToArray( $value );
 267                 }
 268
 269                 $array[$key] = $value;
 270         }
 271
 272         return $array;
 273 }
 274
 275 /**
 276  * Get a random decimal value between 0 and 1, in a way
 277  * not likely to give duplicate values for any realistic
 278  * number of articles.
 279  *
 280  * @return string
 281  */
 282 function wfRandom() {
 283         # The maximum random value is "only" 2^31-1, so get two random
 284         # values to reduce the chance of dupes
 285         $max = mt_getrandmax() + 1;
 286         $rand = number_format( ( mt_rand() * $max + mt_rand() )
 287                 / $max / $max, 12, '.', '' );
 288         return $rand;
 289 }
 290
 291 /**
 292  * Get a random string containing a number of pseudo-random hex
 293  * characters.
 294  * @note This is not secure, if you are trying to generate some sort
 295  *       of token please use MWCryptRand instead.
 296  *
 297  * @param int $length The length of the string to generate
 298  * @return String
 299  * @since 1.20
 300  */
 301 function wfRandomString( $length = 32 ) {
 302         $str = '';
 303         for ( $n = 0; $n < $length; $n += 7 ) {
 304                 $str .= sprintf( '%07x', mt_rand() & 0xfffffff );
 305         }
 306         return substr( $str, 0, $length );
 307 }
 308
 309 /**
 310  * We want some things to be included as literal characters in our title URLs
 311  * for prettiness, which urlencode encodes by default.  According to RFC 1738,
 312  * all of the following should be safe:
 313  *
 314  * ;:@&=$-_.+!*'(),
 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 (Bug 22709),
 324  * so no fancy : for IIS7.
 325  *
 326  * %2F in the page titles seems to fatally break for some reason.
 327  *
 328  * @param $s String:
 329  * @return string
 330  */
 331 function wfUrlencode( $s ) {
 332         static $needle;
 333         if ( is_null( $s ) ) {
 334                 $needle = null;
 335                 return '';
 336         }
 337
 338         if ( is_null( $needle ) ) {
 339                 $needle = array( '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F' );
 340                 if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) || ( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false ) ) {
 341                         $needle[] = '%3A';
 342                 }
 343         }
 344
 345         $s = urlencode( $s );
 346         $s = str_ireplace(
 347                 $needle,
 348                 array( ';', '@', '$', '!', '*', '(', ')', ',', '/', ':' ),
 349                 $s
 350         );
 351
 352         return $s;
 353 }
 354
 355 /**
 356  * This function takes two arrays as input, and returns a CGI-style string, e.g.
 357  * "days=7&limit=100". Options in the first array override options in the second.
 358  * Options set to null or false will not be output.
 359  *
 360  * @param array $array1 ( String|Array )
 361  * @param array $array2 ( String|Array )
 362  * @param $prefix String
 363  * @return String
 364  */
 365 function wfArrayToCgi( $array1, $array2 = null, $prefix = '' ) {
 366         if ( !is_null( $array2 ) ) {
 367                 $array1 = $array1 + $array2;
 368         }
 369
 370         $cgi = '';
 371         foreach ( $array1 as $key => $value ) {
 372                 if ( !is_null( $value ) && $value !== false ) {
 373                         if ( $cgi != '' ) {
 374                                 $cgi .= '&';
 375                         }
 376                         if ( $prefix !== '' ) {
 377                                 $key = $prefix . "[$key]";
 378                         }
 379                         if ( is_array( $value ) ) {
 380                                 $firstTime = true;
 381                                 foreach ( $value as $k => $v ) {
 382                                         $cgi .= $firstTime ? '' : '&';
 383                                         if ( is_array( $v ) ) {
 384                                                 $cgi .= wfArrayToCgi( $v, null, $key . "[$k]" );
 385                                         } else {
 386                                                 $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v );
 387                                         }
 388                                         $firstTime = false;
 389                                 }
 390                         } else {
 391                                 if ( is_object( $value ) ) {
 392                                         $value = $value->__toString();
 393                                 }
 394                                 $cgi .= urlencode( $key ) . '=' . urlencode( $value );
 395                         }
 396                 }
 397         }
 398         return $cgi;
 399 }
 400
 401 /**
 402  * This is the logical opposite of wfArrayToCgi(): it accepts a query string as
 403  * its argument and returns the same string in array form.  This allows compatibility
 404  * with legacy functions that accept raw query strings instead of nice
 405  * arrays.  Of course, keys and values are urldecode()d.
 406  *
 407  * @param string $query query string
 408  * @return array Array version of input
 409  */
 410 function wfCgiToArray( $query ) {
 411         if ( isset( $query[0] ) && $query[0] == '?' ) {
 412                 $query = substr( $query, 1 );
 413         }
 414         $bits = explode( '&', $query );
 415         $ret = array();
 416         foreach ( $bits as $bit ) {
 417                 if ( $bit === '' ) {
 418                         continue;
 419                 }
 420                 if ( strpos( $bit, '=' ) === false ) {
 421                         // Pieces like &qwerty become 'qwerty' => '' (at least this is what php does)
 422                         $key = $bit;
 423                         $value = '';
 424                 } else {
 425                         list( $key, $value ) = explode( '=', $bit );
 426                 }
 427                 $key = urldecode( $key );
 428                 $value = urldecode( $value );
 429                 if ( strpos( $key, '[' ) !== false ) {
 430                         $keys = array_reverse( explode( '[', $key ) );
 431                         $key = array_pop( $keys );
 432                         $temp = $value;
 433                         foreach ( $keys as $k ) {
 434                                 $k = substr( $k, 0, -1 );
 435                                 $temp = array( $k => $temp );
 436                         }
 437                         if ( isset( $ret[$key] ) ) {
 438                                 $ret[$key] = array_merge( $ret[$key], $temp );
 439                         } else {
 440                                 $ret[$key] = $temp;
 441                         }
 442                 } else {
 443                         $ret[$key] = $value;
 444                 }
 445         }
 446         return $ret;
 447 }
 448
 449 /**
 450  * Append a query string to an existing URL, which may or may not already
 451  * have query string parameters already. If so, they will be combined.
 452  *
 453  * @param $url String
 454  * @param $query Mixed: string or associative array
 455  * @return string
 456  */
 457 function wfAppendQuery( $url, $query ) {
 458         if ( is_array( $query ) ) {
 459                 $query = wfArrayToCgi( $query );
 460         }
 461         if ( $query != '' ) {
 462                 if ( false === strpos( $url, '?' ) ) {
 463                         $url .= '?';
 464                 } else {
 465                         $url .= '&';
 466                 }
 467                 $url .= $query;
 468         }
 469         return $url;
 470 }
 471
 472 /**
 473  * Expand a potentially local URL to a fully-qualified URL.  Assumes $wgServer
 474  * is correct.
 475  *
 476  * The meaning of the PROTO_* constants is as follows:
 477  * PROTO_HTTP: Output a URL starting with http://
 478  * PROTO_HTTPS: Output a URL starting with https://
 479  * PROTO_RELATIVE: Output a URL starting with // (protocol-relative URL)
 480  * PROTO_CURRENT: Output a URL starting with either http:// or https:// , depending on which protocol was used for the current incoming request
 481  * PROTO_CANONICAL: For URLs without a domain, like /w/index.php , use $wgCanonicalServer. For protocol-relative URLs, use the protocol of $wgCanonicalServer
 482  * PROTO_INTERNAL: Like PROTO_CANONICAL, but uses $wgInternalServer instead of $wgCanonicalServer
 483  *
 484  * @todo this won't work with current-path-relative URLs
 485  * like "subdir/foo.html", etc.
 486  *
 487  * @param string $url either fully-qualified or a local path + query
 488  * @param $defaultProto Mixed: one of the PROTO_* constants. Determines the
 489  *                             protocol to use if $url or $wgServer is
 490  *                             protocol-relative
 491  * @return string Fully-qualified URL, current-path-relative URL or false if
 492  *                no valid URL can be constructed
 493  */
 494 function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT ) {
 495         global $wgServer, $wgCanonicalServer, $wgInternalServer;
 496         $serverUrl = $wgServer;
 497         if ( $defaultProto === PROTO_CANONICAL ) {
 498                 $serverUrl = $wgCanonicalServer;
 499         }
 500         // Make $wgInternalServer fall back to $wgServer if not set
 501         if ( $defaultProto === PROTO_INTERNAL && $wgInternalServer !== false ) {
 502                 $serverUrl = $wgInternalServer;
 503         }
 504         if ( $defaultProto === PROTO_CURRENT ) {
 505                 $defaultProto = WebRequest::detectProtocol() . '://';
 506         }
 507
 508         // Analyze $serverUrl to obtain its protocol
 509         $bits = wfParseUrl( $serverUrl );
 510         $serverHasProto = $bits && $bits['scheme'] != '';
 511
 512         if ( $defaultProto === PROTO_CANONICAL || $defaultProto === PROTO_INTERNAL ) {
 513                 if ( $serverHasProto ) {
 514                         $defaultProto = $bits['scheme'] . '://';
 515                 } else {
 516                         // $wgCanonicalServer or $wgInternalServer doesn't have a protocol. This really isn't supposed to happen
 517                         // Fall back to HTTP in this ridiculous case
 518                         $defaultProto = PROTO_HTTP;
 519                 }
 520         }
 521
 522         $defaultProtoWithoutSlashes = substr( $defaultProto, 0, -2 );
 523
 524         if ( substr( $url, 0, 2 ) == '//' ) {
 525                 $url = $defaultProtoWithoutSlashes . $url;
 526         } elseif ( substr( $url, 0, 1 ) == '/' ) {
 527                 // If $serverUrl is protocol-relative, prepend $defaultProtoWithoutSlashes, otherwise leave it alone
 528                 $url = ( $serverHasProto ? '' : $defaultProtoWithoutSlashes ) . $serverUrl . $url;
 529         }
 530
 531         $bits = wfParseUrl( $url );
 532         if ( $bits && isset( $bits['path'] ) ) {
 533                 $bits['path'] = wfRemoveDotSegments( $bits['path'] );
 534                 return wfAssembleUrl( $bits );
 535         } elseif ( $bits ) {
 536                 # No path to expand
 537                 return $url;
 538         } elseif ( substr( $url, 0, 1 ) != '/' ) {
 539                 # URL is a relative path
 540                 return wfRemoveDotSegments( $url );
 541         }
 542
 543         # Expanded URL is not valid.
 544         return false;
 545 }
 546
 547 /**
 548  * This function will reassemble a URL parsed with wfParseURL.  This is useful
 549  * if you need to edit part of a URL and put it back together.
 550  *
 551  * This is the basic structure used (brackets contain keys for $urlParts):
 552  * [scheme][delimiter][user]:[pass]@[host]:[port][path]?[query]#[fragment]
 553  *
 554  * @todo Need to integrate this into wfExpandUrl (bug 32168)
 555  *
 556  * @since 1.19
 557  * @param array $urlParts URL parts, as output from wfParseUrl
 558  * @return string URL assembled from its component parts
 559  */
 560 function wfAssembleUrl( $urlParts ) {
 561         $result = '';
 562
 563         if ( isset( $urlParts['delimiter'] ) ) {
 564                 if ( isset( $urlParts['scheme'] ) ) {
 565                         $result .= $urlParts['scheme'];
 566                 }
 567
 568                 $result .= $urlParts['delimiter'];
 569         }
 570
 571         if ( isset( $urlParts['host'] ) ) {
 572                 if ( isset( $urlParts['user'] ) ) {
 573                         $result .= $urlParts['user'];
 574                         if ( isset( $urlParts['pass'] ) ) {
 575                                 $result .= ':' . $urlParts['pass'];
 576                         }
 577                         $result .= '@';
 578                 }
 579
 580                 $result .= $urlParts['host'];
 581
 582                 if ( isset( $urlParts['port'] ) ) {
 583                         $result .= ':' . $urlParts['port'];
 584                 }
 585         }
 586
 587         if ( isset( $urlParts['path'] ) ) {
 588                 $result .= $urlParts['path'];
 589         }
 590
 591         if ( isset( $urlParts['query'] ) ) {
 592                 $result .= '?' . $urlParts['query'];
 593         }
 594
 595         if ( isset( $urlParts['fragment'] ) ) {
 596                 $result .= '#' . $urlParts['fragment'];
 597         }
 598
 599         return $result;
 600 }
 601
 602 /**
 603  * Remove all dot-segments in the provided URL path.  For example,
 604  * '/a/./b/../c/' becomes '/a/c/'.  For details on the algorithm, please see
 605  * RFC3986 section 5.2.4.
 606  *
 607  * @todo Need to integrate this into wfExpandUrl (bug 32168)
 608  *
 609  * @param string $urlPath URL path, potentially containing dot-segments
 610  * @return string URL path with all dot-segments removed
 611  */
 612 function wfRemoveDotSegments( $urlPath ) {
 613         $output = '';
 614         $inputOffset = 0;
 615         $inputLength = strlen( $urlPath );
 616
 617         while ( $inputOffset < $inputLength ) {
 618                 $prefixLengthOne = substr( $urlPath, $inputOffset, 1 );
 619                 $prefixLengthTwo = substr( $urlPath, $inputOffset, 2 );
 620                 $prefixLengthThree = substr( $urlPath, $inputOffset, 3 );
 621                 $prefixLengthFour = substr( $urlPath, $inputOffset, 4 );
 622                 $trimOutput = false;
 623
 624                 if ( $prefixLengthTwo == './' ) {
 625                         # Step A, remove leading "./"
 626                         $inputOffset += 2;
 627                 } elseif ( $prefixLengthThree == '../' ) {
 628                         # Step A, remove leading "../"
 629                         $inputOffset += 3;
 630                 } elseif ( ( $prefixLengthTwo == '/.' ) && ( $inputOffset + 2 == $inputLength ) ) {
 631                         # Step B, replace leading "/.$" with "/"
 632                         $inputOffset += 1;
 633                         $urlPath[$inputOffset] = '/';
 634                 } elseif ( $prefixLengthThree == '/./' ) {
 635                         # Step B, replace leading "/./" with "/"
 636                         $inputOffset += 2;
 637                 } elseif ( $prefixLengthThree == '/..' && ( $inputOffset + 3 == $inputLength ) ) {
 638                         # Step C, replace leading "/..$" with "/" and
 639                         # remove last path component in output
 640                         $inputOffset += 2;
 641                         $urlPath[$inputOffset] = '/';
 642                         $trimOutput = true;
 643                 } elseif ( $prefixLengthFour == '/../' ) {
 644                         # Step C, replace leading "/../" with "/" and
 645                         # remove last path component in output
 646                         $inputOffset += 3;
 647                         $trimOutput = true;
 648                 } elseif ( ( $prefixLengthOne == '.' ) && ( $inputOffset + 1 == $inputLength ) ) {
 649                         # Step D, remove "^.$"
 650                         $inputOffset += 1;
 651                 } elseif ( ( $prefixLengthTwo == '..' ) && ( $inputOffset + 2 == $inputLength ) ) {
 652                         # Step D, remove "^..$"
 653                         $inputOffset += 2;
 654                 } else {
 655                         # Step E, move leading path segment to output
 656                         if ( $prefixLengthOne == '/' ) {
 657                                 $slashPos = strpos( $urlPath, '/', $inputOffset + 1 );
 658                         } else {
 659                                 $slashPos = strpos( $urlPath, '/', $inputOffset );
 660                         }
 661                         if ( $slashPos === false ) {
 662                                 $output .= substr( $urlPath, $inputOffset );
 663                                 $inputOffset = $inputLength;
 664                         } else {
 665                                 $output .= substr( $urlPath, $inputOffset, $slashPos - $inputOffset );
 666                                 $inputOffset += $slashPos - $inputOffset;
 667                         }
 668                 }
 669
 670                 if ( $trimOutput ) {
 671                         $slashPos = strrpos( $output, '/' );
 672                         if ( $slashPos === false ) {
 673                                 $output = '';
 674                         } else {
 675                                 $output = substr( $output, 0, $slashPos );
 676                         }
 677                 }
 678         }
 679
 680         return $output;
 681 }
 682
 683 /**
 684  * Returns a regular expression of url protocols
 685  *
 686  * @param bool $includeProtocolRelative If false, remove '//' from the returned protocol list.
 687  *        DO NOT USE this directly, use wfUrlProtocolsWithoutProtRel() instead
 688  * @return String
 689  */
 690 function wfUrlProtocols( $includeProtocolRelative = true ) {
 691         global $wgUrlProtocols;
 692
 693         // Cache return values separately based on $includeProtocolRelative
 694         static $withProtRel = null, $withoutProtRel = null;
 695         $cachedValue = $includeProtocolRelative ? $withProtRel : $withoutProtRel;
 696         if ( !is_null( $cachedValue ) ) {
 697                 return $cachedValue;
 698         }
 699
 700         // Support old-style $wgUrlProtocols strings, for backwards compatibility
 701         // with LocalSettings files from 1.5
 702         if ( is_array( $wgUrlProtocols ) ) {
 703                 $protocols = array();
 704                 foreach ( $wgUrlProtocols as $protocol ) {
 705                         // Filter out '//' if !$includeProtocolRelative
 706                         if ( $includeProtocolRelative || $protocol !== '//' ) {
 707                                 $protocols[] = preg_quote( $protocol, '/' );
 708                         }
 709                 }
 710
 711                 $retval = implode( '|', $protocols );
 712         } else {
 713                 // Ignore $includeProtocolRelative in this case
 714                 // This case exists for pre-1.6 compatibility, and we can safely assume
 715                 // that '//' won't appear in a pre-1.6 config because protocol-relative
 716                 // URLs weren't supported until 1.18
 717                 $retval = $wgUrlProtocols;
 718         }
 719
 720         // Cache return value
 721         if ( $includeProtocolRelative ) {
 722                 $withProtRel = $retval;
 723         } else {
 724                 $withoutProtRel = $retval;
 725         }
 726         return $retval;
 727 }
 728
 729 /**
 730  * Like wfUrlProtocols(), but excludes '//' from the protocol list. Use this if
 731  * you need a regex that matches all URL protocols but does not match protocol-
 732  * relative URLs
 733  * @return String
 734  */
 735 function wfUrlProtocolsWithoutProtRel() {
 736         return wfUrlProtocols( false );
 737 }
 738
 739 /**
 740  * parse_url() work-alike, but non-broken.  Differences:
 741  *
 742  * 1) Does not raise warnings on bad URLs (just returns false)
 743  * 2) Handles protocols that don't use :// (e.g., mailto: and news: , as well as protocol-relative URLs) correctly
 744  * 3) Adds a "delimiter" element to the array, either '://', ':' or '//' (see (2))
 745  *
 746  * @param string $url a URL to parse
 747  * @return Array: bits of the URL in an associative array, per PHP docs
 748  */
 749 function wfParseUrl( $url ) {
 750         global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
 751
 752         // Protocol-relative URLs are handled really badly by parse_url(). It's so bad that the easiest
 753         // way to handle them is to just prepend 'http:' and strip the protocol out later
 754         $wasRelative = substr( $url, 0, 2 ) == '//';
 755         if ( $wasRelative ) {
 756                 $url = "http:$url";
 757         }
 758         wfSuppressWarnings();
 759         $bits = parse_url( $url );
 760         wfRestoreWarnings();
 761         // parse_url() returns an array without scheme for some invalid URLs, e.g.
 762         // parse_url("%0Ahttp://example.com") == array( 'host' => '%0Ahttp', 'path' => 'example.com' )
 763         if ( !$bits || !isset( $bits['scheme'] ) ) {
 764                 return false;
 765         }
 766
 767         // parse_url() incorrectly handles schemes case-sensitively. Convert it to lowercase.
 768         $bits['scheme'] = strtolower( $bits['scheme'] );
 769
 770         // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
 771         if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
 772                 $bits['delimiter'] = '://';
 773         } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
 774                 $bits['delimiter'] = ':';
 775                 // parse_url detects for news: and mailto: the host part of an url as path
 776                 // We have to correct this wrong detection
 777                 if ( isset( $bits['path'] ) ) {
 778                         $bits['host'] = $bits['path'];
 779                         $bits['path'] = '';
 780                 }
 781         } else {
 782                 return false;
 783         }
 784
 785         /* Provide an empty host for eg. file:/// urls (see bug 28627) */
 786         if ( !isset( $bits['host'] ) ) {
 787                 $bits['host'] = '';
 788
 789                 // bug 45069
 790                 if ( isset( $bits['path'] ) ) {
 791                         /* parse_url loses the third / for file:///c:/ urls (but not on variants) */
 792                         if ( substr( $bits['path'], 0, 1 ) !== '/' ) {
 793                                 $bits['path'] = '/' . $bits['path'];
 794                         }
 795                 } else {
 796                         $bits['path'] = '';
 797                 }
 798         }
 799
 800         // If the URL was protocol-relative, fix scheme and delimiter
 801         if ( $wasRelative ) {
 802                 $bits['scheme'] = '';
 803                 $bits['delimiter'] = '//';
 804         }
 805         return $bits;
 806 }
 807
 808 /**
 809  * Take a URL, make sure it's expanded to fully qualified, and replace any
 810  * encoded non-ASCII Unicode characters with their UTF-8 original forms
 811  * for more compact display and legibility for local audiences.
 812  *
 813  * @todo handle punycode domains too
 814  *
 815  * @param $url string
 816  * @return string
 817  */
 818 function wfExpandIRI( $url ) {
 819         return preg_replace_callback( '/((?:%[89A-F][0-9A-F])+)/i', 'wfExpandIRI_callback', wfExpandUrl( $url ) );
 820 }
 821
 822 /**
 823  * Private callback for wfExpandIRI
 824  * @param array $matches
 825  * @return string
 826  */
 827 function wfExpandIRI_callback( $matches ) {
 828         return urldecode( $matches[1] );
 829 }
 830
 831 /**
 832  * Make URL indexes, appropriate for the el_index field of externallinks.
 833  *
 834  * @param $url String
 835  * @return array
 836  */
 837 function wfMakeUrlIndexes( $url ) {
 838         $bits = wfParseUrl( $url );
 839
 840         // Reverse the labels in the hostname, convert to lower case
 841         // For emails reverse domainpart only
 842         if ( $bits['scheme'] == 'mailto' ) {
 843                 $mailparts = explode( '@', $bits['host'], 2 );
 844                 if ( count( $mailparts ) === 2 ) {
 845                         $domainpart = strtolower( implode( '.', array_reverse( explode( '.', $mailparts[1] ) ) ) );
 846                 } else {
 847                         // No domain specified, don't mangle it
 848                         $domainpart = '';
 849                 }
 850                 $reversedHost = $domainpart . '@' . $mailparts[0];
 851         } else {
 852                 $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) );
 853         }
 854         // Add an extra dot to the end
 855         // Why? Is it in wrong place in mailto links?
 856         if ( substr( $reversedHost, -1, 1 ) !== '.' ) {
 857                 $reversedHost .= '.';
 858         }
 859         // Reconstruct the pseudo-URL
 860         $prot = $bits['scheme'];
 861         $index = $prot . $bits['delimiter'] . $reversedHost;
 862         // Leave out user and password. Add the port, path, query and fragment
 863         if ( isset( $bits['port'] ) ) {
 864                 $index .= ':' . $bits['port'];
 865         }
 866         if ( isset( $bits['path'] ) ) {
 867                 $index .= $bits['path'];
 868         } else {
 869                 $index .= '/';
 870         }
 871         if ( isset( $bits['query'] ) ) {
 872                 $index .= '?' . $bits['query'];
 873         }
 874         if ( isset( $bits['fragment'] ) ) {
 875                 $index .= '#' . $bits['fragment'];
 876         }
 877
 878         if ( $prot == '' ) {
 879                 return array( "http:$index", "https:$index" );
 880         } else {
 881                 return array( $index );
 882         }
 883 }
 884
 885 /**
 886  * Check whether a given URL has a domain that occurs in a given set of domains
 887  * @param string $url URL
 888  * @param array $domains Array of domains (strings)
 889  * @return bool True if the host part of $url ends in one of the strings in $domains
 890  */
 891 function wfMatchesDomainList( $url, $domains ) {
 892         $bits = wfParseUrl( $url );
 893         if ( is_array( $bits ) && isset( $bits['host'] ) ) {
 894                 $host = '.' . $bits['host'];
 895                 foreach ( (array)$domains as $domain ) {
 896                         $domain = '.' . $domain;
 897                         if ( substr( $host, -strlen( $domain ) ) === $domain ) {
 898                                 return true;
 899                         }
 900                 }
 901         }
 902         return false;
 903 }
 904
 905 /**
 906  * Sends a line to the debug log if enabled or, optionally, to a comment in output.
 907  * In normal operation this is a NOP.
 908  *
 909  * Controlling globals:
 910  * $wgDebugLogFile - points to the log file
 911  * $wgProfileOnly - if set, normal debug messages will not be recorded.
 912  * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
 913  * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
 914  *
 915  * @param $text String
 916  * @param bool $logonly set true to avoid appearing in HTML when $wgDebugComments is set
 917  */
 918 function wfDebug( $text, $logonly = false ) {
 919         global $wgDebugLogFile, $wgProfileOnly, $wgDebugRawPage, $wgDebugLogPrefix;
 920
 921         if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
 922                 return;
 923         }
 924
 925         $timer = wfDebugTimer();
 926         if ( $timer !== '' ) {
 927                 $text = preg_replace( '/[^\n]/', $timer . '\0', $text, 1 );
 928         }
 929
 930         if ( !$logonly ) {
 931                 MWDebug::debugMsg( $text );
 932         }
 933
 934         if ( wfRunHooks( 'Debug', array( $text, null /* no log group */ ) ) ) {
 935                 if ( $wgDebugLogFile != '' && !$wgProfileOnly ) {
 936                         # Strip unprintables; they can switch terminal modes when binary data
 937                         # gets dumped, which is pretty annoying.
 938                         $text = preg_replace( '![\x00-\x08\x0b\x0c\x0e-\x1f]!', ' ', $text );
 939                         $text = $wgDebugLogPrefix . $text;
 940                         wfErrorLog( $text, $wgDebugLogFile );
 941                 }
 942         }
 943 }
 944
 945 /**
 946  * Returns true if debug logging should be suppressed if $wgDebugRawPage = false
 947  * @return bool
 948  */
 949 function wfIsDebugRawPage() {
 950         static $cache;
 951         if ( $cache !== null ) {
 952                 return $cache;
 953         }
 954         # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
 955         if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
 956                 || (
 957                         isset( $_SERVER['SCRIPT_NAME'] )
 958                         && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
 959                 ) )
 960         {
 961                 $cache = true;
 962         } else {
 963                 $cache = false;
 964         }
 965         return $cache;
 966 }
 967
 968 /**
 969  * Get microsecond timestamps for debug logs
 970  *
 971  * @return string
 972  */
 973 function wfDebugTimer() {
 974         global $wgDebugTimestamps, $wgRequestTime;
 975
 976         if ( !$wgDebugTimestamps ) {
 977                 return '';
 978         }
 979
 980         $prefix = sprintf( "%6.4f", microtime( true ) - $wgRequestTime );
 981         $mem = sprintf( "%5.1fM", ( memory_get_usage( true ) / ( 1024 * 1024 ) ) );
 982         return "$prefix $mem  ";
 983 }
 984
 985 /**
 986  * Send a line giving PHP memory usage.
 987  *
 988  * @param bool $exact print exact values instead of kilobytes (default: false)
 989  */
 990 function wfDebugMem( $exact = false ) {
 991         $mem = memory_get_usage();
 992         if ( !$exact ) {
 993                 $mem = floor( $mem / 1024 ) . ' kilobytes';
 994         } else {
 995                 $mem .= ' bytes';
 996         }
 997         wfDebug( "Memory usage: $mem\n" );
 998 }
 999
1000 /**
1001  * Send a line to a supplementary debug log file, if configured, or main debug log if not.
1002  * $wgDebugLogGroups[$logGroup] should be set to a filename to send to a separate log.
1003  *
1004  * @param $logGroup String
1005  * @param $text String
1006  * @param bool $public whether to log the event in the public log if no private
1007  *                     log file is specified, (default true)
1008  */
1009 function wfDebugLog( $logGroup, $text, $public = true ) {
1010         global $wgDebugLogGroups;
1011         $text = trim( $text ) . "\n";
1012         if ( isset( $wgDebugLogGroups[$logGroup] ) ) {
1013                 $time = wfTimestamp( TS_DB );
1014                 $wiki = wfWikiID();
1015                 $host = wfHostname();
1016                 if ( wfRunHooks( 'Debug', array( $text, $logGroup ) ) ) {
1017                         wfErrorLog( "$time $host $wiki: $text", $wgDebugLogGroups[$logGroup] );
1018                 }
1019         } elseif ( $public === true ) {
1020                 wfDebug( "[$logGroup] $text", false );
1021         }
1022 }
1023
1024 /**
1025  * Log for database errors
1026  *
1027  * @param string $text database error message.
1028  */
1029 function wfLogDBError( $text ) {
1030         global $wgDBerrorLog, $wgDBerrorLogTZ;
1031         static $logDBErrorTimeZoneObject = null;
1032
1033         if ( $wgDBerrorLog ) {
1034                 $host = wfHostname();
1035                 $wiki = wfWikiID();
1036
1037                 if ( $wgDBerrorLogTZ && !$logDBErrorTimeZoneObject ) {
1038                         $logDBErrorTimeZoneObject = new DateTimeZone( $wgDBerrorLogTZ );
1039                 }
1040
1041                 // Workaround for https://bugs.php.net/bug.php?id=52063
1042                 // Can be removed when min PHP > 5.3.2
1043                 if ( $logDBErrorTimeZoneObject === null ) {
1044                         $d = date_create( "now" );
1045                 } else {
1046                         $d = date_create( "now", $logDBErrorTimeZoneObject );
1047                 }
1048
1049                 $date = $d->format( 'D M j G:i:s T Y' );
1050
1051                 $text = "$date\t$host\t$wiki\t$text";
1052                 wfErrorLog( $text, $wgDBerrorLog );
1053         }
1054 }
1055
1056 /**
1057  * Throws a warning that $function is deprecated
1058  *
1059  * @param $function String
1060  * @param string|bool $version Version of MediaWiki that the function was deprecated in (Added in 1.19).
1061  * @param string|bool $component Added in 1.19.
1062  * @param $callerOffset integer: How far up the call stack is the original
1063  *    caller. 2 = function that called the function that called
1064  *    wfDeprecated (Added in 1.20)
1065  *
1066  * @return null
1067  */
1068 function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) {
1069         MWDebug::deprecated( $function, $version, $component, $callerOffset + 1 );
1070 }
1071
1072 /**
1073  * Send a warning either to the debug log or in a PHP error depending on
1074  * $wgDevelopmentWarnings. To log warnings in production, use wfLogWarning() instead.
1075  *
1076  * @param string $msg message to send
1077  * @param $callerOffset Integer: number of items to go back in the backtrace to
1078  *        find the correct caller (1 = function calling wfWarn, ...)
1079  * @param $level Integer: PHP error level; defaults to E_USER_NOTICE;
1080  *        only used when $wgDevelopmentWarnings is true
1081  */
1082 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE ) {
1083         MWDebug::warning( $msg, $callerOffset + 1, $level, 'auto' );
1084 }
1085
1086 /**
1087  * Send a warning as a PHP error and the debug log. This is intended for logging
1088  * warnings in production. For logging development warnings, use WfWarn instead.
1089  *
1090  * @param $msg String: message to send
1091  * @param $callerOffset Integer: number of items to go back in the backtrace to
1092  *        find the correct caller (1 = function calling wfLogWarning, ...)
1093  * @param $level Integer: PHP error level; defaults to E_USER_WARNING
1094  */
1095 function wfLogWarning( $msg, $callerOffset = 1, $level = E_USER_WARNING ) {
1096         MWDebug::warning( $msg, $callerOffset + 1, $level, 'production' );
1097 }
1098
1099 /**
1100  * Log to a file without getting "file size exceeded" signals.
1101  *
1102  * Can also log to TCP or UDP with the syntax udp://host:port/prefix. This will
1103  * send lines to the specified port, prefixed by the specified prefix and a space.
1104  *
1105  * @param $text String
1106  * @param string $file filename
1107  * @throws MWException
1108  */
1109 function wfErrorLog( $text, $file ) {
1110         if ( substr( $file, 0, 4 ) == 'udp:' ) {
1111                 # Needs the sockets extension
1112                 if ( preg_match( '!^(tcp|udp):(?://)?\[([0-9a-fA-F:]+)\]:(\d+)(?:/(.*))?$!', $file, $m ) ) {
1113                         // IPv6 bracketed host
1114                         $host = $m[2];
1115                         $port = intval( $m[3] );
1116                         $prefix = isset( $m[4] ) ? $m[4] : false;
1117                         $domain = AF_INET6;
1118                 } elseif ( preg_match( '!^(tcp|udp):(?://)?([a-zA-Z0-9.-]+):(\d+)(?:/(.*))?$!', $file, $m ) ) {
1119                         $host = $m[2];
1120                         if ( !IP::isIPv4( $host ) ) {
1121                                 $host = gethostbyname( $host );
1122                         }
1123                         $port = intval( $m[3] );
1124                         $prefix = isset( $m[4] ) ? $m[4] : false;
1125                         $domain = AF_INET;
1126                 } else {
1127                         throw new MWException( __METHOD__ . ': Invalid UDP specification' );
1128                 }
1129
1130                 // Clean it up for the multiplexer
1131                 if ( strval( $prefix ) !== '' ) {
1132                         $text = preg_replace( '/^/m', $prefix . ' ', $text );
1133
1134                         // Limit to 64KB
1135                         if ( strlen( $text ) > 65506 ) {
1136                                 $text = substr( $text, 0, 65506 );
1137                         }
1138
1139                         if ( substr( $text, -1 ) != "\n" ) {
1140                                 $text .= "\n";
1141                         }
1142                 } elseif ( strlen( $text ) > 65507 ) {
1143                         $text = substr( $text, 0, 65507 );
1144                 }
1145
1146                 $sock = socket_create( $domain, SOCK_DGRAM, SOL_UDP );
1147                 if ( !$sock ) {
1148                         return;
1149                 }
1150
1151                 socket_sendto( $sock, $text, strlen( $text ), 0, $host, $port );
1152                 socket_close( $sock );
1153         } else {
1154                 wfSuppressWarnings();
1155                 $exists = file_exists( $file );
1156                 $size = $exists ? filesize( $file ) : false;
1157                 if ( !$exists || ( $size !== false && $size + strlen( $text ) < 0x7fffffff ) ) {
1158                         file_put_contents( $file, $text, FILE_APPEND );
1159                 }
1160                 wfRestoreWarnings();
1161         }
1162 }
1163
1164 /**
1165  * @todo document
1166  */
1167 function wfLogProfilingData() {
1168         global $wgRequestTime, $wgDebugLogFile, $wgDebugRawPage, $wgRequest;
1169         global $wgProfileLimit, $wgUser;
1170
1171         StatCounter::singleton()->flush();
1172
1173         $profiler = Profiler::instance();
1174
1175         # Profiling must actually be enabled...
1176         if ( $profiler->isStub() ) {
1177                 return;
1178         }
1179
1180         // Get total page request time and only show pages that longer than
1181         // $wgProfileLimit time (default is 0)
1182         $elapsed = microtime( true ) - $wgRequestTime;
1183         if ( $elapsed <= $wgProfileLimit ) {
1184                 return;
1185         }
1186
1187         $profiler->logData();
1188
1189         // Check whether this should be logged in the debug file.
1190         if ( $wgDebugLogFile == '' || ( !$wgDebugRawPage && wfIsDebugRawPage() ) ) {
1191                 return;
1192         }
1193
1194         $forward = '';
1195         if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1196                 $forward = ' forwarded for ' . $_SERVER['HTTP_X_FORWARDED_FOR'];
1197         }
1198         if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1199                 $forward .= ' client IP ' . $_SERVER['HTTP_CLIENT_IP'];
1200         }
1201         if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1202                 $forward .= ' from ' . $_SERVER['HTTP_FROM'];
1203         }
1204         if ( $forward ) {
1205                 $forward = "\t(proxied via {$_SERVER['REMOTE_ADDR']}{$forward})";
1206         }
1207         // Don't load $wgUser at this late stage just for statistics purposes
1208         // @todo FIXME: We can detect some anons even if it is not loaded. See User::getId()
1209         if ( $wgUser->isItemLoaded( 'id' ) && $wgUser->isAnon() ) {
1210                 $forward .= ' anon';
1211         }
1212
1213         // Command line script uses a FauxRequest object which does not have
1214         // any knowledge about an URL and throw an exception instead.
1215         try {
1216                 $requestUrl = $wgRequest->getRequestURL();
1217         } catch ( MWException $e ) {
1218                 $requestUrl = 'n/a';
1219         }
1220
1221         $log = sprintf( "%s\t%04.3f\t%s\n",
1222                 gmdate( 'YmdHis' ), $elapsed,
1223                 urldecode( $requestUrl . $forward ) );
1224
1225         wfErrorLog( $log . $profiler->getOutput(), $wgDebugLogFile );
1226 }
1227
1228 /**
1229  * Increment a statistics counter
1230  *
1231  * @param $key String
1232  * @param $count Int
1233  * @return void
1234  */
1235 function wfIncrStats( $key, $count = 1 ) {
1236         StatCounter::singleton()->incr( $key, $count );
1237 }
1238
1239 /**
1240  * Check whether the wiki is in read-only mode.
1241  *
1242  * @return bool
1243  */
1244 function wfReadOnly() {
1245         return wfReadOnlyReason() !== false;
1246 }
1247
1248 /**
1249  * Get the value of $wgReadOnly or the contents of $wgReadOnlyFile.
1250  *
1251  * @return string|bool: String when in read-only mode; false otherwise
1252  */
1253 function wfReadOnlyReason() {
1254         global $wgReadOnly, $wgReadOnlyFile;
1255
1256         if ( $wgReadOnly === null ) {
1257                 // Set $wgReadOnly for faster access next time
1258                 if ( is_file( $wgReadOnlyFile ) && filesize( $wgReadOnlyFile ) > 0 ) {
1259                         $wgReadOnly = file_get_contents( $wgReadOnlyFile );
1260                 } else {
1261                         $wgReadOnly = false;
1262                 }
1263         }
1264
1265         return $wgReadOnly;
1266 }
1267
1268 /**
1269  * Return a Language object from $langcode
1270  *
1271  * @param $langcode Mixed: either:
1272  *                  - a Language object
1273  *                  - code of the language to get the message for, if it is
1274  *                    a valid code create a language for that language, if
1275  *                    it is a string but not a valid code then make a basic
1276  *                    language object
1277  *                  - a boolean: if it's false then use the global object for
1278  *                    the current user's language (as a fallback for the old parameter
1279  *                    functionality), or if it is true then use global object
1280  *                    for the wiki's content language.
1281  * @return Language object
1282  */
1283 function wfGetLangObj( $langcode = false ) {
1284         # Identify which language to get or create a language object for.
1285         # Using is_object here due to Stub objects.
1286         if ( is_object( $langcode ) ) {
1287                 # Great, we already have the object (hopefully)!
1288                 return $langcode;
1289         }
1290
1291         global $wgContLang, $wgLanguageCode;
1292         if ( $langcode === true || $langcode === $wgLanguageCode ) {
1293                 # $langcode is the language code of the wikis content language object.
1294                 # or it is a boolean and value is true
1295                 return $wgContLang;
1296         }
1297
1298         global $wgLang;
1299         if ( $langcode === false || $langcode === $wgLang->getCode() ) {
1300                 # $langcode is the language code of user language object.
1301                 # or it was a boolean and value is false
1302                 return $wgLang;
1303         }
1304
1305         $validCodes = array_keys( Language::fetchLanguageNames() );
1306         if ( in_array( $langcode, $validCodes ) ) {
1307                 # $langcode corresponds to a valid language.
1308                 return Language::factory( $langcode );
1309         }
1310
1311         # $langcode is a string, but not a valid language code; use content language.
1312         wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1313         return $wgContLang;
1314 }
1315
1316 /**
1317  * Old function when $wgBetterDirectionality existed
1318  * All usage removed, wfUILang can be removed in near future
1319  *
1320  * @deprecated since 1.18
1321  * @return Language
1322  */
1323 function wfUILang() {
1324         wfDeprecated( __METHOD__, '1.18' );
1325         global $wgLang;
1326         return $wgLang;
1327 }
1328
1329 /**
1330  * This is the function for getting translated interface messages.
1331  *
1332  * @see Message class for documentation how to use them.
1333  * @see https://www.mediawiki.org/wiki/Manual:Messages_API
1334  *
1335  * This function replaces all old wfMsg* functions.
1336  *
1337  * @param $key \string Message key.
1338  * Varargs: normal message parameters.
1339  * @return Message
1340  * @since 1.17
1341  */
1342 function wfMessage( $key /*...*/) {
1343         $params = func_get_args();
1344         array_shift( $params );
1345         if ( isset( $params[0] ) && is_array( $params[0] ) ) {
1346                 $params = $params[0];
1347         }
1348         return new Message( $key, $params );
1349 }
1350
1351 /**
1352  * This function accepts multiple message keys and returns a message instance
1353  * for the first message which is non-empty. If all messages are empty then an
1354  * instance of the first message key is returned.
1355  * @param varargs: message keys
1356  * @return Message
1357  * @since 1.18
1358  */
1359 function wfMessageFallback( /*...*/ ) {
1360         $args = func_get_args();
1361         return call_user_func_array( 'Message::newFallbackSequence', $args );
1362 }
1363
1364 /**
1365  * Get a message from anywhere, for the current user language.
1366  *
1367  * Use wfMsgForContent() instead if the message should NOT
1368  * change depending on the user preferences.
1369  *
1370  * @deprecated since 1.18
1371  *
1372  * @param string $key lookup key for the message, usually
1373  *    defined in languages/Language.php
1374  *
1375  * Parameters to the message, which can be used to insert variable text into
1376  * it, can be passed to this function in the following formats:
1377  * - One per argument, starting at the second parameter
1378  * - As an array in the second parameter
1379  * These are not shown in the function definition.
1380  *
1381  * @return String
1382  */
1383 function wfMsg( $key ) {
1384         wfDeprecated( __METHOD__, '1.21' );
1385
1386         $args = func_get_args();
1387         array_shift( $args );
1388         return wfMsgReal( $key, $args );
1389 }
1390
1391 /**
1392  * Same as above except doesn't transform the message
1393  *
1394  * @deprecated since 1.18
1395  *
1396  * @param $key String
1397  * @return String
1398  */
1399 function wfMsgNoTrans( $key ) {
1400         wfDeprecated( __METHOD__, '1.21' );
1401
1402         $args = func_get_args();
1403         array_shift( $args );
1404         return wfMsgReal( $key, $args, true, false, false );
1405 }
1406
1407 /**
1408  * Get a message from anywhere, for the current global language
1409  * set with $wgLanguageCode.
1410  *
1411  * Use this if the message should NOT change dependent on the
1412  * language set in the user's preferences. This is the case for
1413  * most text written into logs, as well as link targets (such as
1414  * the name of the copyright policy page). Link titles, on the
1415  * other hand, should be shown in the UI language.
1416  *
1417  * Note that MediaWiki allows users to change the user interface
1418  * language in their preferences, but a single installation
1419  * typically only contains content in one language.
1420  *
1421  * Be wary of this distinction: If you use wfMsg() where you should
1422  * use wfMsgForContent(), a user of the software may have to
1423  * customize potentially hundreds of messages in
1424  * order to, e.g., fix a link in every possible language.
1425  *
1426  * @deprecated since 1.18
1427  *
1428  * @param string $key lookup key for the message, usually
1429  *     defined in languages/Language.php
1430  * @return String
1431  */
1432 function wfMsgForContent( $key ) {
1433         wfDeprecated( __METHOD__, '1.21' );
1434
1435         global $wgForceUIMsgAsContentMsg;
1436         $args = func_get_args();
1437         array_shift( $args );
1438         $forcontent = true;
1439         if ( is_array( $wgForceUIMsgAsContentMsg ) &&
1440                 in_array( $key, $wgForceUIMsgAsContentMsg ) )
1441         {
1442                 $forcontent = false;
1443         }
1444         return wfMsgReal( $key, $args, true, $forcontent );
1445 }
1446
1447 /**
1448  * Same as above except doesn't transform the message
1449  *
1450  * @deprecated since 1.18
1451  *
1452  * @param $key String
1453  * @return String
1454  */
1455 function wfMsgForContentNoTrans( $key ) {
1456         wfDeprecated( __METHOD__, '1.21' );
1457
1458         global $wgForceUIMsgAsContentMsg;
1459         $args = func_get_args();
1460         array_shift( $args );
1461         $forcontent = true;
1462         if ( is_array( $wgForceUIMsgAsContentMsg ) &&
1463                 in_array( $key, $wgForceUIMsgAsContentMsg ) )
1464         {
1465                 $forcontent = false;
1466         }
1467         return wfMsgReal( $key, $args, true, $forcontent, false );
1468 }
1469
1470 /**
1471  * Really get a message
1472  *
1473  * @deprecated since 1.18
1474  *
1475  * @param string $key key to get.
1476  * @param $args
1477  * @param $useDB Boolean
1478  * @param $forContent Mixed: Language code, or false for user lang, true for content lang.
1479  * @param $transform Boolean: Whether or not to transform the message.
1480  * @return String: the requested message.
1481  */
1482 function wfMsgReal( $key, $args, $useDB = true, $forContent = false, $transform = true ) {
1483         wfDeprecated( __METHOD__, '1.21' );
1484
1485         wfProfileIn( __METHOD__ );
1486         $message = wfMsgGetKey( $key, $useDB, $forContent, $transform );
1487         $message = wfMsgReplaceArgs( $message, $args );
1488         wfProfileOut( __METHOD__ );
1489         return $message;
1490 }
1491
1492 /**
1493  * Fetch a message string value, but don't replace any keys yet.
1494  *
1495  * @deprecated since 1.18
1496  *
1497  * @param $key String
1498  * @param $useDB Bool
1499  * @param string $langCode Code of the language to get the message for, or
1500  *                  behaves as a content language switch if it is a boolean.
1501  * @param $transform Boolean: whether to parse magic words, etc.
1502  * @return string
1503  */
1504 function wfMsgGetKey( $key, $useDB = true, $langCode = false, $transform = true ) {
1505         wfDeprecated( __METHOD__, '1.21' );
1506
1507         wfRunHooks( 'NormalizeMessageKey', array( &$key, &$useDB, &$langCode, &$transform ) );
1508
1509         $cache = MessageCache::singleton();
1510         $message = $cache->get( $key, $useDB, $langCode );
1511         if ( $message === false ) {
1512                 $message = '&lt;' . htmlspecialchars( $key ) . '&gt;';
1513         } elseif ( $transform ) {
1514                 $message = $cache->transform( $message );
1515         }
1516         return $message;
1517 }
1518
1519 /**
1520  * Replace message parameter keys on the given formatted output.
1521  *
1522  * @param $message String
1523  * @param $args Array
1524  * @return string
1525  * @private
1526  */
1527 function wfMsgReplaceArgs( $message, $args ) {
1528         # Fix windows line-endings
1529         # Some messages are split with explode("\n", $msg)
1530         $message = str_replace( "\r", '', $message );
1531
1532         // Replace arguments
1533         if ( count( $args ) ) {
1534                 if ( is_array( $args[0] ) ) {
1535                         $args = array_values( $args[0] );
1536                 }
1537                 $replacementKeys = array();
1538                 foreach ( $args as $n => $param ) {
1539                         $replacementKeys['$' . ( $n + 1 )] = $param;
1540                 }
1541                 $message = strtr( $message, $replacementKeys );
1542         }
1543
1544         return $message;
1545 }
1546
1547 /**
1548  * Return an HTML-escaped version of a message.
1549  * Parameter replacements, if any, are done *after* the HTML-escaping,
1550  * so parameters may contain HTML (eg links or form controls). Be sure
1551  * to pre-escape them if you really do want plaintext, or just wrap
1552  * the whole thing in htmlspecialchars().
1553  *
1554  * @deprecated since 1.18
1555  *
1556  * @param $key String
1557  * @param string ... parameters
1558  * @return string
1559  */
1560 function wfMsgHtml( $key ) {
1561         wfDeprecated( __METHOD__, '1.21' );
1562
1563         $args = func_get_args();
1564         array_shift( $args );
1565         return wfMsgReplaceArgs( htmlspecialchars( wfMsgGetKey( $key ) ), $args );
1566 }
1567
1568 /**
1569  * Return an HTML version of message
1570  * Parameter replacements, if any, are done *after* parsing the wiki-text message,
1571  * so parameters may contain HTML (eg links or form controls). Be sure
1572  * to pre-escape them if you really do want plaintext, or just wrap
1573  * the whole thing in htmlspecialchars().
1574  *
1575  * @deprecated since 1.18
1576  *
1577  * @param $key String
1578  * @param string ... parameters
1579  * @return string
1580  */
1581 function wfMsgWikiHtml( $key ) {
1582         wfDeprecated( __METHOD__, '1.21' );
1583
1584         $args = func_get_args();
1585         array_shift( $args );
1586         return wfMsgReplaceArgs(
1587                 MessageCache::singleton()->parse( wfMsgGetKey( $key ), null,
1588                 /* can't be set to false */ true, /* interface */ true )->getText(),
1589                 $args );
1590 }
1591
1592 /**
1593  * Returns message in the requested format
1594  *
1595  * @deprecated since 1.18
1596  *
1597  * @param string $key key of the message
1598  * @param array $options processing rules. Can take the following options:
1599  *   <i>parse</i>: parses wikitext to HTML
1600  *   <i>parseinline</i>: parses wikitext to HTML and removes the surrounding
1601  *       p's added by parser or tidy
1602  *   <i>escape</i>: filters message through htmlspecialchars
1603  *   <i>escapenoentities</i>: same, but allows entity references like &#160; through
1604  *   <i>replaceafter</i>: parameters are substituted after parsing or escaping
1605  *   <i>parsemag</i>: transform the message using magic phrases
1606  *   <i>content</i>: fetch message for content language instead of interface
1607  * Also can accept a single associative argument, of the form 'language' => 'xx':
1608  *   <i>language</i>: Language object or language code to fetch message for
1609  *       (overridden by <i>content</i>).
1610  * Behavior for conflicting options (e.g., parse+parseinline) is undefined.
1611  *
1612  * @return String
1613  */
1614 function wfMsgExt( $key, $options ) {
1615         wfDeprecated( __METHOD__, '1.21' );
1616
1617         $args = func_get_args();
1618         array_shift( $args );
1619         array_shift( $args );
1620         $options = (array)$options;
1621
1622         foreach ( $options as $arrayKey => $option ) {
1623                 if ( !preg_match( '/^[0-9]+|language$/', $arrayKey ) ) {
1624                         # An unknown index, neither numeric nor "language"
1625                         wfWarn( "wfMsgExt called with incorrect parameter key $arrayKey", 1, E_USER_WARNING );
1626                 } elseif ( preg_match( '/^[0-9]+$/', $arrayKey ) && !in_array( $option,
1627                 array( 'parse', 'parseinline', 'escape', 'escapenoentities',
1628                 'replaceafter', 'parsemag', 'content' ) ) ) {
1629                         # A numeric index with unknown value
1630                         wfWarn( "wfMsgExt called with incorrect parameter $option", 1, E_USER_WARNING );
1631                 }
1632         }
1633
1634         if ( in_array( 'content', $options, true ) ) {
1635                 $forContent = true;
1636                 $langCode = true;
1637                 $langCodeObj = null;
1638         } elseif ( array_key_exists( 'language', $options ) ) {
1639                 $forContent = false;
1640                 $langCode = wfGetLangObj( $options['language'] );
1641                 $langCodeObj = $langCode;
1642         } else {
1643                 $forContent = false;
1644                 $langCode = false;
1645                 $langCodeObj = null;
1646         }
1647
1648         $string = wfMsgGetKey( $key, /*DB*/true, $langCode, /*Transform*/false );
1649
1650         if ( !in_array( 'replaceafter', $options, true ) ) {
1651                 $string = wfMsgReplaceArgs( $string, $args );
1652         }
1653
1654         $messageCache = MessageCache::singleton();
1655         $parseInline = in_array( 'parseinline', $options, true );
1656         if ( in_array( 'parse', $options, true ) || $parseInline ) {
1657                 $string = $messageCache->parse( $string, null, true, !$forContent, $langCodeObj );
1658                 if ( $string instanceof ParserOutput ) {
1659                         $string = $string->getText();
1660                 }
1661
1662                 if ( $parseInline ) {
1663                         $m = array();
1664                         if ( preg_match( '/^<p>(.*)\n?<\/p>\n?$/sU', $string, $m ) ) {
1665                                 $string = $m[1];
1666                         }
1667                 }
1668         } elseif ( in_array( 'parsemag', $options, true ) ) {
1669                 $string = $messageCache->transform( $string,
1670                                 !$forContent, $langCodeObj );
1671         }
1672
1673         if ( in_array( 'escape', $options, true ) ) {
1674                 $string = htmlspecialchars ( $string );
1675         } elseif ( in_array( 'escapenoentities', $options, true ) ) {
1676                 $string = Sanitizer::escapeHtmlAllowEntities( $string );
1677         }
1678
1679         if ( in_array( 'replaceafter', $options, true ) ) {
1680                 $string = wfMsgReplaceArgs( $string, $args );
1681         }
1682
1683         return $string;
1684 }
1685
1686 /**
1687  * Since wfMsg() and co suck, they don't return false if the message key they
1688  * looked up didn't exist but instead the key wrapped in <>'s, this function checks for the
1689  * nonexistence of messages by checking the MessageCache::get() result directly.
1690  *
1691  * @deprecated since 1.18. Use Message::isDisabled().
1692  *
1693  * @param $key      String: the message key looked up
1694  * @return Boolean True if the message *doesn't* exist.
1695  */
1696 function wfEmptyMsg( $key ) {
1697         wfDeprecated( __METHOD__, '1.21' );
1698
1699         return MessageCache::singleton()->get( $key, /*useDB*/true, /*content*/false ) === false;
1700 }
1701
1702 /**
1703  * Throw a debugging exception. This function previously once exited the process,
1704  * but now throws an exception instead, with similar results.
1705  *
1706  * @param string $msg message shown when dying.
1707  * @throws MWException
1708  */
1709 function wfDebugDieBacktrace( $msg = '' ) {
1710         throw new MWException( $msg );
1711 }
1712
1713 /**
1714  * Fetch server name for use in error reporting etc.
1715  * Use real server name if available, so we know which machine
1716  * in a server farm generated the current page.
1717  *
1718  * @return string
1719  */
1720 function wfHostname() {
1721         static $host;
1722         if ( is_null( $host ) ) {
1723
1724                 # Hostname overriding
1725                 global $wgOverrideHostname;
1726                 if ( $wgOverrideHostname !== false ) {
1727                         # Set static and skip any detection
1728                         $host = $wgOverrideHostname;
1729                         return $host;
1730                 }
1731
1732                 if ( function_exists( 'posix_uname' ) ) {
1733                         // This function not present on Windows
1734                         $uname = posix_uname();
1735                 } else {
1736                         $uname = false;
1737                 }
1738                 if ( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1739                         $host = $uname['nodename'];
1740                 } elseif ( getenv( 'COMPUTERNAME' ) ) {
1741                         # Windows computer name
1742                         $host = getenv( 'COMPUTERNAME' );
1743                 } else {
1744                         # This may be a virtual server.
1745                         $host = $_SERVER['SERVER_NAME'];
1746                 }
1747         }
1748         return $host;
1749 }
1750
1751 /**
1752  * Returns a HTML comment with the elapsed time since request.
1753  * This method has no side effects.
1754  *
1755  * @return string
1756  */
1757 function wfReportTime() {
1758         global $wgRequestTime, $wgShowHostnames;
1759
1760         $elapsed = microtime( true ) - $wgRequestTime;
1761
1762         return $wgShowHostnames
1763                 ? sprintf( '<!-- Served by %s in %01.3f secs. -->', wfHostname(), $elapsed )
1764                 : sprintf( '<!-- Served in %01.3f secs. -->', $elapsed );
1765 }
1766
1767 /**
1768  * Safety wrapper for debug_backtrace().
1769  *
1770  * With Zend Optimizer 3.2.0 loaded, this causes segfaults under somewhat
1771  * murky circumstances, which may be triggered in part by stub objects
1772  * or other fancy talking'.
1773  *
1774  * Will return an empty array if Zend Optimizer is detected or if
1775  * debug_backtrace is disabled, otherwise the output from
1776  * debug_backtrace() (trimmed).
1777  *
1778  * @param int $limit This parameter can be used to limit the number of stack frames returned
1779  *
1780  * @return array of backtrace information
1781  */
1782 function wfDebugBacktrace( $limit = 0 ) {
1783         static $disabled = null;
1784
1785         if ( extension_loaded( 'Zend Optimizer' ) ) {
1786                 wfDebug( "Zend Optimizer detected; skipping debug_backtrace for safety.\n" );
1787                 return array();
1788         }
1789
1790         if ( is_null( $disabled ) ) {
1791                 $disabled = false;
1792                 $functions = explode( ',', ini_get( 'disable_functions' ) );
1793                 $functions = array_map( 'trim', $functions );
1794                 $functions = array_map( 'strtolower', $functions );
1795                 if ( in_array( 'debug_backtrace', $functions ) ) {
1796                         wfDebug( "debug_backtrace is in disabled_functions\n" );
1797                         $disabled = true;
1798                 }
1799         }
1800         if ( $disabled ) {
1801                 return array();
1802         }
1803
1804         if ( $limit && version_compare( PHP_VERSION, '5.4.0', '>=' ) ) {
1805                 return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT, $limit + 1 ), 1 );
1806         } else {
1807                 return array_slice( debug_backtrace(), 1 );
1808         }
1809 }
1810
1811 /**
1812  * Get a debug backtrace as a string
1813  *
1814  * @return string
1815  */
1816 function wfBacktrace() {
1817         global $wgCommandLineMode;
1818
1819         if ( $wgCommandLineMode ) {
1820                 $msg = '';
1821         } else {
1822                 $msg = "<ul>\n";
1823         }
1824         $backtrace = wfDebugBacktrace();
1825         foreach ( $backtrace as $call ) {
1826                 if ( isset( $call['file'] ) ) {
1827                         $f = explode( DIRECTORY_SEPARATOR, $call['file'] );
1828                         $file = $f[count( $f ) - 1];
1829                 } else {
1830                         $file = '-';
1831                 }
1832                 if ( isset( $call['line'] ) ) {
1833                         $line = $call['line'];
1834                 } else {
1835                         $line = '-';
1836                 }
1837                 if ( $wgCommandLineMode ) {
1838                         $msg .= "$file line $line calls ";
1839                 } else {
1840                         $msg .= '<li>' . $file . ' line ' . $line . ' calls ';
1841                 }
1842                 if ( !empty( $call['class'] ) ) {
1843                         $msg .= $call['class'] . $call['type'];
1844                 }
1845                 $msg .= $call['function'] . '()';
1846
1847                 if ( $wgCommandLineMode ) {
1848                         $msg .= "\n";
1849                 } else {
1850                         $msg .= "</li>\n";
1851                 }
1852         }
1853         if ( $wgCommandLineMode ) {
1854                 $msg .= "\n";
1855         } else {
1856                 $msg .= "</ul>\n";
1857         }
1858
1859         return $msg;
1860 }
1861
1862 /**
1863  * Get the name of the function which called this function
1864  * wfGetCaller( 1 ) is the function with the wfGetCaller() call (ie. __FUNCTION__)
1865  * wfGetCaller( 2 ) [default] is the caller of the function running wfGetCaller()
1866  * wfGetCaller( 3 ) is the parent of that.
1867  *
1868  * @param $level Int
1869  * @return string
1870  */
1871 function wfGetCaller( $level = 2 ) {
1872         $backtrace = wfDebugBacktrace( $level + 1 );
1873         if ( isset( $backtrace[$level] ) ) {
1874                 return wfFormatStackFrame( $backtrace[$level] );
1875         } else {
1876                 return 'unknown';
1877         }
1878 }
1879
1880 /**
1881  * Return a string consisting of callers in the stack. Useful sometimes
1882  * for profiling specific points.
1883  *
1884  * @param int $limit The maximum depth of the stack frame to return, or false for
1885  *               the entire stack.
1886  * @return String
1887  */
1888 function wfGetAllCallers( $limit = 3 ) {
1889         $trace = array_reverse( wfDebugBacktrace() );
1890         if ( !$limit || $limit > count( $trace ) - 1 ) {
1891                 $limit = count( $trace ) - 1;
1892         }
1893         $trace = array_slice( $trace, -$limit - 1, $limit );
1894         return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1895 }
1896
1897 /**
1898  * Return a string representation of frame
1899  *
1900  * @param $frame Array
1901  * @return string
1902  */
1903 function wfFormatStackFrame( $frame ) {
1904         return isset( $frame['class'] ) ?
1905                 $frame['class'] . '::' . $frame['function'] :
1906                 $frame['function'];
1907 }
1908
1909 /* Some generic result counters, pulled out of SearchEngine */
1910
1911 /**
1912  * @todo document
1913  *
1914  * @param $offset Int
1915  * @param $limit Int
1916  * @return String
1917  */
1918 function wfShowingResults( $offset, $limit ) {
1919         return wfMessage( 'showingresults' )->numParams( $limit, $offset + 1 )->parse();
1920 }
1921
1922 /**
1923  * Generate (prev x| next x) (20|50|100...) type links for paging
1924  *
1925  * @param $offset String
1926  * @param $limit Integer
1927  * @param $link String
1928  * @param string $query optional URL query parameter string
1929  * @param bool $atend optional param for specified if this is the last page
1930  * @return String
1931  * @deprecated in 1.19; use Language::viewPrevNext() instead
1932  */
1933 function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) {
1934         wfDeprecated( __METHOD__, '1.19' );
1935
1936         global $wgLang;
1937
1938         $query = wfCgiToArray( $query );
1939
1940         if ( is_object( $link ) ) {
1941                 $title = $link;
1942         } else {
1943                 $title = Title::newFromText( $link );
1944                 if ( is_null( $title ) ) {
1945                         return false;
1946                 }
1947         }
1948
1949         return $wgLang->viewPrevNext( $title, $offset, $limit, $query, $atend );
1950 }
1951
1952 /**
1953  * Make a list item, used by various special pages
1954  *
1955  * @param string $page Page link
1956  * @param string $details Text between brackets
1957  * @param $oppositedm Boolean   Add the direction mark opposite to your
1958  *                                                              language, to display text properly
1959  * @return String
1960  * @deprecated since 1.19; use Language::specialList() instead
1961  */
1962 function wfSpecialList( $page, $details, $oppositedm = true ) {
1963         wfDeprecated( __METHOD__, '1.19' );
1964
1965         global $wgLang;
1966         return $wgLang->specialList( $page, $details, $oppositedm );
1967 }
1968
1969 /**
1970  * @todo document
1971  * @todo FIXME: We may want to blacklist some broken browsers
1972  *
1973  * @param $force Bool
1974  * @return bool Whereas client accept gzip compression
1975  */
1976 function wfClientAcceptsGzip( $force = false ) {
1977         static $result = null;
1978         if ( $result === null || $force ) {
1979                 $result = false;
1980                 if ( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
1981                         # @todo FIXME: We may want to blacklist some broken browsers
1982                         $m = array();
1983                         if ( preg_match(
1984                                 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
1985                                 $_SERVER['HTTP_ACCEPT_ENCODING'],
1986                                 $m )
1987                         )
1988                         {
1989                                 if ( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
1990                                         $result = false;
1991                                         return $result;
1992                                 }
1993                                 wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
1994                                 $result = true;
1995                         }
1996                 }
1997         }
1998         return $result;
1999 }
2000
2001 /**
2002  * Obtain the offset and limit values from the request string;
2003  * used in special pages
2004  *
2005  * @param int $deflimit default limit if none supplied
2006  * @param string $optionname Name of a user preference to check against
2007  * @return array
2008  *
2009  */
2010 function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
2011         global $wgRequest;
2012         return $wgRequest->getLimitOffset( $deflimit, $optionname );
2013 }
2014
2015 /**
2016  * Escapes the given text so that it may be output using addWikiText()
2017  * without any linking, formatting, etc. making its way through. This
2018  * is achieved by substituting certain characters with HTML entities.
2019  * As required by the callers, "<nowiki>" is not used.
2020  *
2021  * @param string $text text to be escaped
2022  * @return String
2023  */
2024 function wfEscapeWikiText( $text ) {
2025         static $repl = null, $repl2 = null;
2026         if ( $repl === null ) {
2027                 $repl = array(
2028                         '"' => '&#34;', '&' => '&#38;', "'" => '&#39;', '<' => '&#60;',
2029                         '=' => '&#61;', '>' => '&#62;', '[' => '&#91;', ']' => '&#93;',
2030                         '{' => '&#123;', '|' => '&#124;', '}' => '&#125;', ';' => '&#59;',
2031                         "\n#" => "\n&#35;", "\r#" => "\r&#35;",
2032                         "\n*" => "\n&#42;", "\r*" => "\r&#42;",
2033                         "\n:" => "\n&#58;", "\r:" => "\r&#58;",
2034                         "\n " => "\n&#32;", "\r " => "\r&#32;",
2035                         "\n\n" => "\n&#10;", "\r\n" => "&#13;\n",
2036                         "\n\r" => "\n&#13;", "\r\r" => "\r&#13;",
2037                         "\n\t" => "\n&#9;", "\r\t" => "\r&#9;", // "\n\t\n" is treated like "\n\n"
2038                         "\n----" => "\n&#45;---", "\r----" => "\r&#45;---",
2039                         '__' => '_&#95;', '://' => '&#58;//',
2040                 );
2041
2042                 // We have to catch everything "\s" matches in PCRE
2043                 foreach ( array( 'ISBN', 'RFC', 'PMID' ) as $magic ) {
2044                         $repl["$magic "] = "$magic&#32;";
2045                         $repl["$magic\t"] = "$magic&#9;";
2046                         $repl["$magic\r"] = "$magic&#13;";
2047                         $repl["$magic\n"] = "$magic&#10;";
2048                         $repl["$magic\f"] = "$magic&#12;";
2049                 }
2050
2051                 // And handle protocols that don't use "://"
2052                 global $wgUrlProtocols;
2053                 $repl2 = array();
2054                 foreach ( $wgUrlProtocols as $prot ) {
2055                         if ( substr( $prot, -1 ) === ':' ) {
2056                                 $repl2[] = preg_quote( substr( $prot, 0, -1 ), '/' );
2057                         }
2058                 }
2059                 $repl2 = $repl2 ? '/\b(' . join( '|', $repl2 ) . '):/i' : '/^(?!)/';
2060         }
2061         $text = substr( strtr( "\n$text", $repl ), 1 );
2062         $text = preg_replace( $repl2, '$1&#58;', $text );
2063         return $text;
2064 }
2065
2066 /**
2067  * Get the current unix timestamp with microseconds.  Useful for profiling
2068  * @deprecated since 1.22; call microtime() directly
2069  * @return Float
2070  */
2071 function wfTime() {
2072         wfDeprecated( __FUNCTION__, '1.22' );
2073         return microtime( true );
2074 }
2075
2076 /**
2077  * Sets dest to source and returns the original value of dest
2078  * If source is NULL, it just returns the value, it doesn't set the variable
2079  * If force is true, it will set the value even if source is NULL
2080  *
2081  * @param $dest Mixed
2082  * @param $source Mixed
2083  * @param $force Bool
2084  * @return Mixed
2085  */
2086 function wfSetVar( &$dest, $source, $force = false ) {
2087         $temp = $dest;
2088         if ( !is_null( $source ) || $force ) {
2089                 $dest = $source;
2090         }
2091         return $temp;
2092 }
2093
2094 /**
2095  * As for wfSetVar except setting a bit
2096  *
2097  * @param $dest Int
2098  * @param $bit Int
2099  * @param $state Bool
2100  *
2101  * @return bool
2102  */
2103 function wfSetBit( &$dest, $bit, $state = true ) {
2104         $temp = (bool)( $dest & $bit );
2105         if ( !is_null( $state ) ) {
2106                 if ( $state ) {
2107                         $dest |= $bit;
2108                 } else {
2109                         $dest &= ~$bit;
2110                 }
2111         }
2112         return $temp;
2113 }
2114
2115 /**
2116  * A wrapper around the PHP function var_export().
2117  * Either print it or add it to the regular output ($wgOut).
2118  *
2119  * @param $var mixed A PHP variable to dump.
2120  */
2121 function wfVarDump( $var ) {
2122         global $wgOut;
2123         $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
2124         if ( headers_sent() || !isset( $wgOut ) || !is_object( $wgOut ) ) {
2125                 print $s;
2126         } else {
2127                 $wgOut->addHTML( $s );
2128         }
2129 }
2130
2131 /**
2132  * Provide a simple HTTP error.
2133  *
2134  * @param $code Int|String
2135  * @param $label String
2136  * @param $desc String
2137  */
2138 function wfHttpError( $code, $label, $desc ) {
2139         global $wgOut;
2140         $wgOut->disable();
2141         header( "HTTP/1.0 $code $label" );
2142         header( "Status: $code $label" );
2143         $wgOut->sendCacheControl();
2144
2145         header( 'Content-type: text/html; charset=utf-8' );
2146         print "<!doctype html>" .
2147                 '<html><head><title>' .
2148                 htmlspecialchars( $label ) .
2149                 '</title></head><body><h1>' .
2150                 htmlspecialchars( $label ) .
2151                 '</h1><p>' .
2152                 nl2br( htmlspecialchars( $desc ) ) .
2153                 "</p></body></html>\n";
2154 }
2155
2156 /**
2157  * Clear away any user-level output buffers, discarding contents.
2158  *
2159  * Suitable for 'starting afresh', for instance when streaming
2160  * relatively large amounts of data without buffering, or wanting to
2161  * output image files without ob_gzhandler's compression.
2162  *
2163  * The optional $resetGzipEncoding parameter controls suppression of
2164  * the Content-Encoding header sent by ob_gzhandler; by default it
2165  * is left. See comments for wfClearOutputBuffers() for why it would
2166  * be used.
2167  *
2168  * Note that some PHP configuration options may add output buffer
2169  * layers which cannot be removed; these are left in place.
2170  *
2171  * @param $resetGzipEncoding Bool
2172  */
2173 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
2174         if ( $resetGzipEncoding ) {
2175                 // Suppress Content-Encoding and Content-Length
2176                 // headers from 1.10+s wfOutputHandler
2177                 global $wgDisableOutputCompression;
2178                 $wgDisableOutputCompression = true;
2179         }
2180         while ( $status = ob_get_status() ) {
2181                 if ( $status['type'] == 0 /* PHP_OUTPUT_HANDLER_INTERNAL */ ) {
2182                         // Probably from zlib.output_compression or other
2183                         // PHP-internal setting which can't be removed.
2184                         //
2185                         // Give up, and hope the result doesn't break
2186                         // output behavior.
2187                         break;
2188                 }
2189                 if ( !ob_end_clean() ) {
2190                         // Could not remove output buffer handler; abort now
2191                         // to avoid getting in some kind of infinite loop.
2192                         break;
2193                 }
2194                 if ( $resetGzipEncoding ) {
2195                         if ( $status['name'] == 'ob_gzhandler' ) {
2196                                 // Reset the 'Content-Encoding' field set by this handler
2197                                 // so we can start fresh.
2198                                 header_remove( 'Content-Encoding' );
2199                                 break;
2200                         }
2201                 }
2202         }
2203 }
2204
2205 /**
2206  * More legible than passing a 'false' parameter to wfResetOutputBuffers():
2207  *
2208  * Clear away output buffers, but keep the Content-Encoding header
2209  * produced by ob_gzhandler, if any.
2210  *
2211  * This should be used for HTTP 304 responses, where you need to
2212  * preserve the Content-Encoding header of the real result, but
2213  * also need to suppress the output of ob_gzhandler to keep to spec
2214  * and avoid breaking Firefox in rare cases where the headers and
2215  * body are broken over two packets.
2216  */
2217 function wfClearOutputBuffers() {
2218         wfResetOutputBuffers( false );
2219 }
2220
2221 /**
2222  * Converts an Accept-* header into an array mapping string values to quality
2223  * factors
2224  *
2225  * @param $accept String
2226  * @param string $def default
2227  * @return Array
2228  */
2229 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
2230         # No arg means accept anything (per HTTP spec)
2231         if ( !$accept ) {
2232                 return array( $def => 1.0 );
2233         }
2234
2235         $prefs = array();
2236
2237         $parts = explode( ',', $accept );
2238
2239         foreach ( $parts as $part ) {
2240                 # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
2241                 $values = explode( ';', trim( $part ) );
2242                 $match = array();
2243                 if ( count( $values ) == 1 ) {
2244                         $prefs[$values[0]] = 1.0;
2245                 } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
2246                         $prefs[$values[0]] = floatval( $match[1] );
2247                 }
2248         }
2249
2250         return $prefs;
2251 }
2252
2253 /**
2254  * Checks if a given MIME type matches any of the keys in the given
2255  * array. Basic wildcards are accepted in the array keys.
2256  *
2257  * Returns the matching MIME type (or wildcard) if a match, otherwise
2258  * NULL if no match.
2259  *
2260  * @param $type String
2261  * @param $avail Array
2262  * @return string
2263  * @private
2264  */
2265 function mimeTypeMatch( $type, $avail ) {
2266         if ( array_key_exists( $type, $avail ) ) {
2267                 return $type;
2268         } else {
2269                 $parts = explode( '/', $type );
2270                 if ( array_key_exists( $parts[0] . '/*', $avail ) ) {
2271                         return $parts[0] . '/*';
2272                 } elseif ( array_key_exists( '*/*', $avail ) ) {
2273                         return '*/*';
2274                 } else {
2275                         return null;
2276                 }
2277         }
2278 }
2279
2280 /**
2281  * Returns the 'best' match between a client's requested internet media types
2282  * and the server's list of available types. Each list should be an associative
2283  * array of type to preference (preference is a float between 0.0 and 1.0).
2284  * Wildcards in the types are acceptable.
2285  *
2286  * @param array $cprefs client's acceptable type list
2287  * @param array $sprefs server's offered types
2288  * @return string
2289  *
2290  * @todo FIXME: Doesn't handle params like 'text/plain; charset=UTF-8'
2291  * XXX: generalize to negotiate other stuff
2292  */
2293 function wfNegotiateType( $cprefs, $sprefs ) {
2294         $combine = array();
2295
2296         foreach ( array_keys( $sprefs ) as $type ) {
2297                 $parts = explode( '/', $type );
2298                 if ( $parts[1] != '*' ) {
2299                         $ckey = mimeTypeMatch( $type, $cprefs );
2300                         if ( $ckey ) {
2301                                 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
2302                         }
2303                 }
2304         }
2305
2306         foreach ( array_keys( $cprefs ) as $type ) {
2307                 $parts = explode( '/', $type );
2308                 if ( $parts[1] != '*' && !array_key_exists( $type, $sprefs ) ) {
2309                         $skey = mimeTypeMatch( $type, $sprefs );
2310                         if ( $skey ) {
2311                                 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
2312                         }
2313                 }
2314         }
2315
2316         $bestq = 0;
2317         $besttype = null;
2318
2319         foreach ( array_keys( $combine ) as $type ) {
2320                 if ( $combine[$type] > $bestq ) {
2321                         $besttype = $type;
2322                         $bestq = $combine[$type];
2323                 }
2324         }
2325
2326         return $besttype;
2327 }
2328
2329 /**
2330  * Reference-counted warning suppression
2331  *
2332  * @param $end Bool
2333  */
2334 function wfSuppressWarnings( $end = false ) {
2335         static $suppressCount = 0;
2336         static $originalLevel = false;
2337
2338         if ( $end ) {
2339                 if ( $suppressCount ) {
2340                         --$suppressCount;
2341                         if ( !$suppressCount ) {
2342                                 error_reporting( $originalLevel );
2343                         }
2344                 }
2345         } else {
2346                 if ( !$suppressCount ) {
2347                         $originalLevel = error_reporting( E_ALL & ~( E_WARNING | E_NOTICE | E_USER_WARNING | E_USER_NOTICE | E_DEPRECATED | E_USER_DEPRECATED | E_STRICT ) );
2348                 }
2349                 ++$suppressCount;
2350         }
2351 }
2352
2353 /**
2354  * Restore error level to previous value
2355  */
2356 function wfRestoreWarnings() {
2357         wfSuppressWarnings( true );
2358 }
2359
2360 # Autodetect, convert and provide timestamps of various types
2361
2362 /**
2363  * Unix time - the number of seconds since 1970-01-01 00:00:00 UTC
2364  */
2365 define( 'TS_UNIX', 0 );
2366
2367 /**
2368  * MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
2369  */
2370 define( 'TS_MW', 1 );
2371
2372 /**
2373  * MySQL DATETIME (YYYY-MM-DD HH:MM:SS)
2374  */
2375 define( 'TS_DB', 2 );
2376
2377 /**
2378  * RFC 2822 format, for E-mail and HTTP headers
2379  */
2380 define( 'TS_RFC2822', 3 );
2381
2382 /**
2383  * ISO 8601 format with no timezone: 1986-02-09T20:00:00Z
2384  *
2385  * This is used by Special:Export
2386  */
2387 define( 'TS_ISO_8601', 4 );
2388
2389 /**
2390  * An Exif timestamp (YYYY:MM:DD HH:MM:SS)
2391  *
2392  * @see http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the
2393  *       DateTime tag and page 36 for the DateTimeOriginal and
2394  *       DateTimeDigitized tags.
2395  */
2396 define( 'TS_EXIF', 5 );
2397
2398 /**
2399  * Oracle format time.
2400  */
2401 define( 'TS_ORACLE', 6 );
2402
2403 /**
2404  * Postgres format time.
2405  */
2406 define( 'TS_POSTGRES', 7 );
2407
2408 /**
2409  * ISO 8601 basic format with no timezone: 19860209T200000Z.  This is used by ResourceLoader
2410  */
2411 define( 'TS_ISO_8601_BASIC', 9 );
2412
2413 /**
2414  * Get a timestamp string in one of various formats
2415  *
2416  * @param $outputtype Mixed: A timestamp in one of the supported formats, the
2417  *                    function will autodetect which format is supplied and act
2418  *                    accordingly.
2419  * @param $ts Mixed: optional timestamp to convert, default 0 for the current time
2420  * @return Mixed: String / false The same date in the format specified in $outputtype or false
2421  */
2422 function wfTimestamp( $outputtype = TS_UNIX, $ts = 0 ) {
2423         try {
2424                 $timestamp = new MWTimestamp( $ts );
2425                 return $timestamp->getTimestamp( $outputtype );
2426         } catch ( TimestampException $e ) {
2427                 wfDebug( "wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n" );
2428                 return false;
2429         }
2430 }
2431
2432 /**
2433  * Return a formatted timestamp, or null if input is null.
2434  * For dealing with nullable timestamp columns in the database.
2435  *
2436  * @param $outputtype Integer
2437  * @param $ts String
2438  * @return String
2439  */
2440 function wfTimestampOrNull( $outputtype = TS_UNIX, $ts = null ) {
2441         if ( is_null( $ts ) ) {
2442                 return null;
2443         } else {
2444                 return wfTimestamp( $outputtype, $ts );
2445         }
2446 }
2447
2448 /**
2449  * Convenience function; returns MediaWiki timestamp for the present time.
2450  *
2451  * @return string
2452  */
2453 function wfTimestampNow() {
2454         # return NOW
2455         return wfTimestamp( TS_MW, time() );
2456 }
2457
2458 /**
2459  * Check if the operating system is Windows
2460  *
2461  * @return Bool: true if it's Windows, False otherwise.
2462  */
2463 function wfIsWindows() {
2464         static $isWindows = null;
2465         if ( $isWindows === null ) {
2466                 $isWindows = substr( php_uname(), 0, 7 ) == 'Windows';
2467         }
2468         return $isWindows;
2469 }
2470
2471 /**
2472  * Check if we are running under HipHop
2473  *
2474  * @return Bool
2475  */
2476 function wfIsHipHop() {
2477         return function_exists( 'hphp_thread_set_warmup_enabled' );
2478 }
2479
2480 /**
2481  * Swap two variables
2482  *
2483  * @param $x Mixed
2484  * @param $y Mixed
2485  */
2486 function swap( &$x, &$y ) {
2487         $z = $x;
2488         $x = $y;
2489         $y = $z;
2490 }
2491
2492 /**
2493  * Tries to get the system directory for temporary files. First
2494  * $wgTmpDirectory is checked, and then the TMPDIR, TMP, and TEMP
2495  * environment variables are then checked in sequence, and if none are
2496  * set try sys_get_temp_dir().
2497  *
2498  * NOTE: When possible, use instead the tmpfile() function to create
2499  * temporary files to avoid race conditions on file creation, etc.
2500  *
2501  * @return String
2502  */
2503 function wfTempDir() {
2504         global $wgTmpDirectory;
2505
2506         if ( $wgTmpDirectory !== false ) {
2507                 return $wgTmpDirectory;
2508         }
2509
2510         $tmpDir = array_map( "getenv", array( 'TMPDIR', 'TMP', 'TEMP' ) );
2511
2512         foreach ( $tmpDir as $tmp ) {
2513                 if ( $tmp && file_exists( $tmp ) && is_dir( $tmp ) && is_writable( $tmp ) ) {
2514                         return $tmp;
2515                 }
2516         }
2517         return sys_get_temp_dir();
2518 }
2519
2520 /**
2521  * Make directory, and make all parent directories if they don't exist
2522  *
2523  * @param string $dir full path to directory to create
2524  * @param $mode Integer: chmod value to use, default is $wgDirectoryMode
2525  * @param string $caller optional caller param for debugging.
2526  * @throws MWException
2527  * @return bool
2528  */
2529 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2530         global $wgDirectoryMode;
2531
2532         if ( FileBackend::isStoragePath( $dir ) ) { // sanity
2533                 throw new MWException( __FUNCTION__ . " given storage path '$dir'." );
2534         }
2535
2536         if ( !is_null( $caller ) ) {
2537                 wfDebug( "$caller: called wfMkdirParents($dir)\n" );
2538         }
2539
2540         if ( strval( $dir ) === '' || ( file_exists( $dir ) && is_dir( $dir ) ) ) {
2541                 return true;
2542         }
2543
2544         $dir = str_replace( array( '\\', '/' ), DIRECTORY_SEPARATOR, $dir );
2545
2546         if ( is_null( $mode ) ) {
2547                 $mode = $wgDirectoryMode;
2548         }
2549
2550         // Turn off the normal warning, we're doing our own below
2551         wfSuppressWarnings();
2552         $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2553         wfRestoreWarnings();
2554
2555         if ( !$ok ) {
2556                 //directory may have been created on another request since we last checked
2557                 if ( is_dir( $dir ) ) {
2558                         return true;
2559                 }
2560
2561                 // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2562                 wfLogWarning( sprintf( "failed to mkdir \"%s\" mode 0%o", $dir, $mode ) );
2563         }
2564         return $ok;
2565 }
2566
2567 /**
2568  * Remove a directory and all its content.
2569  * Does not hide error.
2570  */
2571 function wfRecursiveRemoveDir( $dir ) {
2572         wfDebug( __FUNCTION__ . "( $dir )\n" );
2573         // taken from http://de3.php.net/manual/en/function.rmdir.php#98622
2574         if ( is_dir( $dir ) ) {
2575                 $objects = scandir( $dir );
2576                 foreach ( $objects as $object ) {
2577                         if ( $object != "." && $object != ".." ) {
2578                                 if ( filetype( $dir . '/' . $object ) == "dir" ) {
2579                                         wfRecursiveRemoveDir( $dir . '/' . $object );
2580                                 } else {
2581                                         unlink( $dir . '/' . $object );
2582                                 }
2583                         }
2584                 }
2585                 reset( $objects );
2586                 rmdir( $dir );
2587         }
2588 }
2589
2590 /**
2591  * @param $nr Mixed: the number to format
2592  * @param $acc Integer: the number of digits after the decimal point, default 2
2593  * @param $round Boolean: whether or not to round the value, default true
2594  * @return float
2595  */
2596 function wfPercent( $nr, $acc = 2, $round = true ) {
2597         $ret = sprintf( "%.${acc}f", $nr );
2598         return $round ? round( $ret, $acc ) . '%' : "$ret%";
2599 }
2600
2601 /**
2602  * Find out whether or not a mixed variable exists in a string
2603  *
2604  * @deprecated Just use str(i)pos
2605  * @param $needle String
2606  * @param $str String
2607  * @param $insensitive Boolean
2608  * @return Boolean
2609  */
2610 function in_string( $needle, $str, $insensitive = false ) {
2611         wfDeprecated( __METHOD__, '1.21' );
2612         $func = 'strpos';
2613         if ( $insensitive ) {
2614                 $func = 'stripos';
2615         }
2616
2617         return $func( $str, $needle ) !== false;
2618 }
2619
2620 /**
2621  * Safety wrapper around ini_get() for boolean settings.
2622  * The values returned from ini_get() are pre-normalized for settings
2623  * set via php.ini or php_flag/php_admin_flag... but *not*
2624  * for those set via php_value/php_admin_value.
2625  *
2626  * It's fairly common for people to use php_value instead of php_flag,
2627  * which can leave you with an 'off' setting giving a false positive
2628  * for code that just takes the ini_get() return value as a boolean.
2629  *
2630  * To make things extra interesting, setting via php_value accepts
2631  * "true" and "yes" as true, but php.ini and php_flag consider them false. :)
2632  * Unrecognized values go false... again opposite PHP's own coercion
2633  * from string to bool.
2634  *
2635  * Luckily, 'properly' set settings will always come back as '0' or '1',
2636  * so we only have to worry about them and the 'improper' settings.
2637  *
2638  * I frickin' hate PHP... :P
2639  *
2640  * @param $setting String
2641  * @return Bool
2642  */
2643 function wfIniGetBool( $setting ) {
2644         $val = strtolower( ini_get( $setting ) );
2645         // 'on' and 'true' can't have whitespace around them, but '1' can.
2646         return $val == 'on'
2647                 || $val == 'true'
2648                 || $val == 'yes'
2649                 || preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2650 }
2651
2652 /**
2653  * Wrapper function for PHP's dl(). This doesn't work in most situations from
2654  * PHP 5.3 onward, and is usually disabled in shared environments anyway.
2655  *
2656  * @param string $extension A PHP extension. The file suffix (.so or .dll)
2657  *                          should be omitted
2658  * @param string $fileName Name of the library, if not $extension.suffix
2659  * @return Bool - Whether or not the extension is loaded
2660  */
2661 function wfDl( $extension, $fileName = null ) {
2662         if ( extension_loaded( $extension ) ) {
2663                 return true;
2664         }
2665
2666         $canDl = false;
2667         if ( PHP_SAPI == 'cli' || PHP_SAPI == 'cgi' || PHP_SAPI == 'embed' ) {
2668                 $canDl = ( function_exists( 'dl' ) && is_callable( 'dl' )
2669                 && wfIniGetBool( 'enable_dl' ) && !wfIniGetBool( 'safe_mode' ) );
2670         }
2671
2672         if ( $canDl ) {
2673                 $fileName = $fileName ? $fileName : $extension;
2674                 if ( wfIsWindows() ) {
2675                         $fileName = 'php_' . $fileName;
2676                 }
2677                 wfSuppressWarnings();
2678                 dl( $fileName . '.' . PHP_SHLIB_SUFFIX );
2679                 wfRestoreWarnings();
2680         }
2681         return extension_loaded( $extension );
2682 }
2683
2684 /**
2685  * Windows-compatible version of escapeshellarg()
2686  * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
2687  * function puts single quotes in regardless of OS.
2688  *
2689  * Also fixes the locale problems on Linux in PHP 5.2.6+ (bug backported to
2690  * earlier distro releases of PHP)
2691  *
2692  * @param varargs
2693  * @return String
2694  */
2695 function wfEscapeShellArg() {
2696         wfInitShellLocale();
2697
2698         $args = func_get_args();
2699         $first = true;
2700         $retVal = '';
2701         foreach ( $args as $arg ) {
2702                 if ( !$first ) {
2703                         $retVal .= ' ';
2704                 } else {
2705                         $first = false;
2706                 }
2707
2708                 if ( wfIsWindows() ) {
2709                         // Escaping for an MSVC-style command line parser and CMD.EXE
2710                         // Refs:
2711                         //  * http://web.archive.org/web/20020708081031/http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
2712                         //  * http://technet.microsoft.com/en-us/library/cc723564.aspx
2713                         //  * Bug #13518
2714                         //  * CR r63214
2715                         // Double the backslashes before any double quotes. Escape the double quotes.
2716                         $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE );
2717                         $arg = '';
2718                         $iteration = 0;
2719                         foreach ( $tokens as $token ) {
2720                                 if ( $iteration % 2 == 1 ) {
2721                                         // Delimiter, a double quote preceded by zero or more slashes
2722                                         $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
2723                                 } elseif ( $iteration % 4 == 2 ) {
2724                                         // ^ in $token will be outside quotes, need to be escaped
2725                                         $arg .= str_replace( '^', '^^', $token );
2726                                 } else { // $iteration % 4 == 0
2727                                         // ^ in $token will appear inside double quotes, so leave as is
2728                                         $arg .= $token;
2729                                 }
2730                                 $iteration++;
2731                         }
2732                         // Double the backslashes before the end of the string, because
2733                         // we will soon add a quote
2734                         $m = array();
2735                         if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
2736                                 $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
2737                         }
2738
2739                         // Add surrounding quotes
2740                         $retVal .= '"' . $arg . '"';
2741                 } else {
2742                         $retVal .= escapeshellarg( $arg );
2743                 }
2744         }
2745         return $retVal;
2746 }
2747
2748 /**
2749  * Check if wfShellExec() is effectively disabled via php.ini config
2750  * @return bool|string False or one of (safemode,disabled)
2751  * @since 1.22
2752  */
2753 function wfShellExecDisabled() {
2754         static $disabled = null;
2755         if ( is_null( $disabled ) ) {
2756                 $disabled = false;
2757                 if ( wfIniGetBool( 'safe_mode' ) ) {
2758                         wfDebug( "wfShellExec can't run in safe_mode, PHP's exec functions are too broken.\n" );
2759                         $disabled = 'safemode';
2760                 } else {
2761                         $functions = explode( ',', ini_get( 'disable_functions' ) );
2762                         $functions = array_map( 'trim', $functions );
2763                         $functions = array_map( 'strtolower', $functions );
2764                         if ( in_array( 'passthru', $functions ) ) {
2765                                 wfDebug( "passthru is in disabled_functions\n" );
2766                                 $disabled = 'passthru';
2767                         }
2768                 }
2769         }
2770         return $disabled;
2771 }
2772
2773 /**
2774  * Execute a shell command, with time and memory limits mirrored from the PHP
2775  * configuration if supported.
2776  * @param string $cmd Command line, properly escaped for shell.
2777  * @param &$retval null|Mixed optional, will receive the program's exit code.
2778  *                 (non-zero is usually failure)
2779  * @param array $environ optional environment variables which should be
2780  *                 added to the executed command environment.
2781  * @param array $limits optional array with limits(filesize, memory, time, walltime)
2782  *                 this overwrites the global wgShellMax* limits.
2783  * @return string collected stdout as a string (trailing newlines stripped)
2784  */
2785 function wfShellExec( $cmd, &$retval = null, $environ = array(), $limits = array() ) {
2786         global $IP, $wgMaxShellMemory, $wgMaxShellFileSize, $wgMaxShellTime,
2787                 $wgMaxShellWallClockTime, $wgShellCgroup;
2788
2789         $disabled = wfShellExecDisabled();
2790         if ( $disabled ) {
2791                 $retval = 1;
2792                 return $disabled == 'safemode' ?
2793                         'Unable to run external programs in safe mode.' :
2794                         'Unable to run external programs, passthru() is disabled.';
2795         }
2796
2797         wfInitShellLocale();
2798
2799         $envcmd = '';
2800         foreach ( $environ as $k => $v ) {
2801                 if ( wfIsWindows() ) {
2802                         /* Surrounding a set in quotes (method used by wfEscapeShellArg) makes the quotes themselves
2803                          * appear in the environment variable, so we must use carat escaping as documented in
2804                          * http://technet.microsoft.com/en-us/library/cc723564.aspx
2805                          * Note however that the quote isn't listed there, but is needed, and the parentheses
2806                          * are listed there but doesn't appear to need it.
2807                          */
2808                         $envcmd .= "set $k=" . preg_replace( '/([&|()<>^"])/', '^\\1', $v ) . '&& ';
2809                 } else {
2810                         /* Assume this is a POSIX shell, thus required to accept variable assignments before the command
2811                          * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_09_01
2812                          */
2813                         $envcmd .= "$k=" . escapeshellarg( $v ) . ' ';
2814                 }
2815         }
2816         $cmd = $envcmd . $cmd;
2817
2818         if ( php_uname( 's' ) == 'Linux' ) {
2819                 $time = intval ( isset( $limits['time'] ) ? $limits['time'] : $wgMaxShellTime );
2820                 if ( isset( $limits['walltime'] ) ) {
2821                         $wallTime = intval( $limits['walltime'] );
2822                 } elseif ( isset( $limits['time'] ) ) {
2823                         $wallTime = $time;
2824                 } else {
2825                         $wallTime = intval( $wgMaxShellWallClockTime );
2826                 }
2827                 $mem = intval ( isset( $limits['memory'] ) ? $limits['memory'] : $wgMaxShellMemory );
2828                 $filesize = intval ( isset( $limits['filesize'] ) ? $limits['filesize'] : $wgMaxShellFileSize );
2829
2830                 if ( $time > 0 || $mem > 0 || $filesize > 0 || $wallTime > 0 ) {
2831                         $cmd = '/bin/bash ' . escapeshellarg( "$IP/includes/limit.sh" ) . ' ' .
2832                                 escapeshellarg( $cmd ) . ' ' .
2833                                 escapeshellarg(
2834                                         "MW_CPU_LIMIT=$time; " .
2835                                         'MW_CGROUP=' . escapeshellarg( $wgShellCgroup ) . '; ' .
2836                                         "MW_MEM_LIMIT=$mem; " .
2837                                         "MW_FILE_SIZE_LIMIT=$filesize; " .
2838                                         "MW_WALL_CLOCK_LIMIT=$wallTime"
2839                                 );
2840                 }
2841         }
2842         wfDebug( "wfShellExec: $cmd\n" );
2843
2844         $retval = 1; // error by default?
2845         ob_start();
2846         passthru( $cmd, $retval );
2847         $output = ob_get_contents();
2848         ob_end_clean();
2849
2850         if ( $retval == 127 ) {
2851                 wfDebugLog( 'exec', "Possibly missing executable file: $cmd\n" );
2852         }
2853         return $output;
2854 }
2855
2856 /**
2857  * Workaround for http://bugs.php.net/bug.php?id=45132
2858  * escapeshellarg() destroys non-ASCII characters if LANG is not a UTF-8 locale
2859  */
2860 function wfInitShellLocale() {
2861         static $done = false;
2862         if ( $done ) {
2863                 return;
2864         }
2865         $done = true;
2866         global $wgShellLocale;
2867         if ( !wfIniGetBool( 'safe_mode' ) ) {
2868                 putenv( "LC_CTYPE=$wgShellLocale" );
2869                 setlocale( LC_CTYPE, $wgShellLocale );
2870         }
2871 }
2872
2873 /**
2874  * Alias to wfShellWikiCmd()
2875  * @see wfShellWikiCmd()
2876  */
2877 function wfShellMaintenanceCmd( $script, array $parameters = array(), array $options = array() ) {
2878         return wfShellWikiCmd( $script, $parameters, $options );
2879 }
2880
2881 /**
2882  * Generate a shell-escaped command line string to run a MediaWiki cli script.
2883  * Note that $parameters should be a flat array and an option with an argument
2884  * should consist of two consecutive items in the array (do not use "--option value").
2885  * @param string $script MediaWiki cli script path
2886  * @param array $parameters Arguments and options to the script
2887  * @param array $options Associative array of options:
2888  *              'php': The path to the php executable
2889  *              'wrapper': Path to a PHP wrapper to handle the maintenance script
2890  * @return Array
2891  */
2892 function wfShellWikiCmd( $script, array $parameters = array(), array $options = array() ) {
2893         global $wgPhpCli;
2894         // Give site config file a chance to run the script in a wrapper.
2895         // The caller may likely want to call wfBasename() on $script.
2896         wfRunHooks( 'wfShellWikiCmd', array( &$script, &$parameters, &$options ) );
2897         $cmd = isset( $options['php'] ) ? array( $options['php'] ) : array( $wgPhpCli );
2898         if ( isset( $options['wrapper'] ) ) {
2899                 $cmd[] = $options['wrapper'];
2900         }
2901         $cmd[] = $script;
2902         // Escape each parameter for shell
2903         return implode( " ", array_map( 'wfEscapeShellArg', array_merge( $cmd, $parameters ) ) );
2904 }
2905
2906 /**
2907  * wfMerge attempts to merge differences between three texts.
2908  * Returns true for a clean merge and false for failure or a conflict.
2909  *
2910  * @param $old String
2911  * @param $mine String
2912  * @param $yours String
2913  * @param $result String
2914  * @return Bool
2915  */
2916 function wfMerge( $old, $mine, $yours, &$result ) {
2917         global $wgDiff3;
2918
2919         # This check may also protect against code injection in
2920         # case of broken installations.
2921         wfSuppressWarnings();
2922         $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
2923         wfRestoreWarnings();
2924
2925         if ( !$haveDiff3 ) {
2926                 wfDebug( "diff3 not found\n" );
2927                 return false;
2928         }
2929
2930         # Make temporary files
2931         $td = wfTempDir();
2932         $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2933         $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
2934         $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
2935
2936         # NOTE: diff3 issues a warning to stderr if any of the files does not end with
2937         #       a newline character. To avoid this, we normalize the trailing whitespace before
2938         #       creating the diff.
2939
2940         fwrite( $oldtextFile, rtrim( $old ) . "\n" );
2941         fclose( $oldtextFile );
2942         fwrite( $mytextFile, rtrim( $mine ) . "\n" );
2943         fclose( $mytextFile );
2944         fwrite( $yourtextFile, rtrim( $yours ) . "\n" );
2945         fclose( $yourtextFile );
2946
2947         # Check for a conflict
2948         $cmd = wfEscapeShellArg( $wgDiff3 ) . ' -a --overlap-only ' .
2949                 wfEscapeShellArg( $mytextName ) . ' ' .
2950                 wfEscapeShellArg( $oldtextName ) . ' ' .
2951                 wfEscapeShellArg( $yourtextName );
2952         $handle = popen( $cmd, 'r' );
2953
2954         if ( fgets( $handle, 1024 ) ) {
2955                 $conflict = true;
2956         } else {
2957                 $conflict = false;
2958         }
2959         pclose( $handle );
2960
2961         # Merge differences
2962         $cmd = wfEscapeShellArg( $wgDiff3 ) . ' -a -e --merge ' .
2963                 wfEscapeShellArg( $mytextName, $oldtextName, $yourtextName );
2964         $handle = popen( $cmd, 'r' );
2965         $result = '';
2966         do {
2967                 $data = fread( $handle, 8192 );
2968                 if ( strlen( $data ) == 0 ) {
2969                         break;
2970                 }
2971                 $result .= $data;
2972         } while ( true );
2973         pclose( $handle );
2974         unlink( $mytextName );
2975         unlink( $oldtextName );
2976         unlink( $yourtextName );
2977
2978         if ( $result === '' && $old !== '' && !$conflict ) {
2979                 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
2980                 $conflict = true;
2981         }
2982         return !$conflict;
2983 }
2984
2985 /**
2986  * Returns unified plain-text diff of two texts.
2987  * Useful for machine processing of diffs.
2988  *
2989  * @param string $before the text before the changes.
2990  * @param string $after the text after the changes.
2991  * @param string $params command-line options for the diff command.
2992  * @return String: unified diff of $before and $after
2993  */
2994 function wfDiff( $before, $after, $params = '-u' ) {
2995         if ( $before == $after ) {
2996                 return '';
2997         }
2998
2999         global $wgDiff;
3000         wfSuppressWarnings();
3001         $haveDiff = $wgDiff && file_exists( $wgDiff );
3002         wfRestoreWarnings();
3003
3004         # This check may also protect against code injection in
3005         # case of broken installations.
3006         if ( !$haveDiff ) {
3007                 wfDebug( "diff executable not found\n" );
3008                 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
3009                 $format = new UnifiedDiffFormatter();
3010                 return $format->format( $diffs );
3011         }
3012
3013         # Make temporary files
3014         $td = wfTempDir();
3015         $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
3016         $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
3017
3018         fwrite( $oldtextFile, $before );
3019         fclose( $oldtextFile );
3020         fwrite( $newtextFile, $after );
3021         fclose( $newtextFile );
3022
3023         // Get the diff of the two files
3024         $cmd = "$wgDiff " . $params . ' ' . wfEscapeShellArg( $oldtextName, $newtextName );
3025
3026         $h = popen( $cmd, 'r' );
3027
3028         $diff = '';
3029
3030         do {
3031                 $data = fread( $h, 8192 );
3032                 if ( strlen( $data ) == 0 ) {
3033                         break;
3034                 }
3035                 $diff .= $data;
3036         } while ( true );
3037
3038         // Clean up
3039         pclose( $h );
3040         unlink( $oldtextName );
3041         unlink( $newtextName );
3042
3043         // Kill the --- and +++ lines. They're not useful.
3044         $diff_lines = explode( "\n", $diff );
3045         if ( strpos( $diff_lines[0], '---' ) === 0 ) {
3046                 unset( $diff_lines[0] );
3047         }
3048         if ( strpos( $diff_lines[1], '+++' ) === 0 ) {
3049                 unset( $diff_lines[1] );
3050         }
3051
3052         $diff = implode( "\n", $diff_lines );
3053
3054         return $diff;
3055 }
3056
3057 /**
3058  * This function works like "use VERSION" in Perl, the program will die with a
3059  * backtrace if the current version of PHP is less than the version provided
3060  *
3061  * This is useful for extensions which due to their nature are not kept in sync
3062  * with releases, and might depend on other versions of PHP than the main code
3063  *
3064  * Note: PHP might die due to parsing errors in some cases before it ever
3065  *       manages to call this function, such is life
3066  *
3067  * @see perldoc -f use
3068  *
3069  * @param $req_ver Mixed: the version to check, can be a string, an integer, or
3070  *                 a float
3071  * @throws MWException
3072  */
3073 function wfUsePHP( $req_ver ) {
3074         $php_ver = PHP_VERSION;
3075
3076         if ( version_compare( $php_ver, (string)$req_ver, '<' ) ) {
3077                 throw new MWException( "PHP $req_ver required--this is only $php_ver" );
3078         }
3079 }
3080
3081 /**
3082  * This function works like "use VERSION" in Perl except it checks the version
3083  * of MediaWiki, the program will die with a backtrace if the current version
3084  * of MediaWiki is less than the version provided.
3085  *
3086  * This is useful for extensions which due to their nature are not kept in sync
3087  * with releases
3088  *
3089  * @see perldoc -f use
3090  *
3091  * @param $req_ver Mixed: the version to check, can be a string, an integer, or
3092  *                 a float
3093  * @throws MWException
3094  */
3095 function wfUseMW( $req_ver ) {
3096         global $wgVersion;
3097
3098         if ( version_compare( $wgVersion, (string)$req_ver, '<' ) ) {
3099                 throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
3100         }
3101 }
3102
3103 /**
3104  * Return the final portion of a pathname.
3105  * Reimplemented because PHP5's "basename()" is buggy with multibyte text.
3106  * http://bugs.php.net/bug.php?id=33898
3107  *
3108  * PHP's basename() only considers '\' a pathchar on Windows and Netware.
3109  * We'll consider it so always, as we don't want '\s' in our Unix paths either.
3110  *
3111  * @param $path String
3112  * @param string $suffix to remove if present
3113  * @return String
3114  */
3115 function wfBaseName( $path, $suffix = '' ) {
3116         $encSuffix = ( $suffix == '' )
3117                 ? ''
3118                 : ( '(?:' . preg_quote( $suffix, '#' ) . ')?' );
3119         $matches = array();
3120         if ( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
3121                 return $matches[1];
3122         } else {
3123                 return '';
3124         }
3125 }
3126
3127 /**
3128  * Generate a relative path name to the given file.
3129  * May explode on non-matching case-insensitive paths,
3130  * funky symlinks, etc.
3131  *
3132  * @param string $path absolute destination path including target filename
3133  * @param string $from Absolute source path, directory only
3134  * @return String
3135  */
3136 function wfRelativePath( $path, $from ) {
3137         // Normalize mixed input on Windows...
3138         $path = str_replace( '/', DIRECTORY_SEPARATOR, $path );
3139         $from = str_replace( '/', DIRECTORY_SEPARATOR, $from );
3140
3141         // Trim trailing slashes -- fix for drive root
3142         $path = rtrim( $path, DIRECTORY_SEPARATOR );
3143         $from = rtrim( $from, DIRECTORY_SEPARATOR );
3144
3145         $pieces = explode( DIRECTORY_SEPARATOR, dirname( $path ) );
3146         $against = explode( DIRECTORY_SEPARATOR, $from );
3147
3148         if ( $pieces[0] !== $against[0] ) {
3149                 // Non-matching Windows drive letters?
3150                 // Return a full path.
3151                 return $path;
3152         }
3153
3154         // Trim off common prefix
3155         while ( count( $pieces ) && count( $against )
3156                 && $pieces[0] == $against[0] ) {
3157                 array_shift( $pieces );
3158                 array_shift( $against );
3159         }
3160
3161         // relative dots to bump us to the parent
3162         while ( count( $against ) ) {
3163                 array_unshift( $pieces, '..' );
3164                 array_shift( $against );
3165         }
3166
3167         array_push( $pieces, wfBaseName( $path ) );
3168
3169         return implode( DIRECTORY_SEPARATOR, $pieces );
3170 }
3171
3172 /**
3173  * Do any deferred updates and clear the list
3174  *
3175  * @deprecated since 1.19
3176  * @see DeferredUpdates::doUpdate()
3177  * @param $commit string
3178  */
3179 function wfDoUpdates( $commit = '' ) {
3180         wfDeprecated( __METHOD__, '1.19' );
3181         DeferredUpdates::doUpdates( $commit );
3182 }
3183
3184 /**
3185  * Convert an arbitrarily-long digit string from one numeric base
3186  * to another, optionally zero-padding to a minimum column width.
3187  *
3188  * Supports base 2 through 36; digit values 10-36 are represented
3189  * as lowercase letters a-z. Input is case-insensitive.
3190  *
3191  * @param string $input Input number
3192  * @param int $sourceBase Base of the input number
3193  * @param int $destBase Desired base of the output
3194  * @param int $pad Minimum number of digits in the output (pad with zeroes)
3195  * @param bool $lowercase Whether to output in lowercase or uppercase
3196  * @param string $engine Either "gmp", "bcmath", or "php"
3197  * @return string|bool The output number as a string, or false on error
3198  */
3199 function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1, $lowercase = true, $engine = 'auto' ) {
3200         $input = (string)$input;
3201         if (
3202                 $sourceBase < 2 ||
3203                 $sourceBase > 36 ||
3204                 $destBase < 2 ||
3205                 $destBase > 36 ||
3206                 $sourceBase != (int)$sourceBase ||
3207                 $destBase != (int)$destBase ||
3208                 $pad != (int)$pad ||
3209                 !preg_match( "/^[" . substr( '0123456789abcdefghijklmnopqrstuvwxyz', 0, $sourceBase ) . "]+$/i", $input )
3210         ) {
3211                 return false;
3212         }
3213
3214         static $baseChars = array(
3215                 10 => 'a', 11 => 'b', 12 => 'c', 13 => 'd', 14 => 'e', 15 => 'f',
3216                 16 => 'g', 17 => 'h', 18 => 'i', 19 => 'j', 20 => 'k', 21 => 'l',
3217                 22 => 'm', 23 => 'n', 24 => 'o', 25 => 'p', 26 => 'q', 27 => 'r',
3218                 28 => 's', 29 => 't', 30 => 'u', 31 => 'v', 32 => 'w', 33 => 'x',
3219                 34 => 'y', 35 => 'z',
3220
3221                 '0' => 0,  '1' => 1,  '2' => 2,  '3' => 3,  '4' => 4,  '5' => 5,
3222                 '6' => 6,  '7' => 7,  '8' => 8,  '9' => 9,  'a' => 10, 'b' => 11,
3223                 'c' => 12, 'd' => 13, 'e' => 14, 'f' => 15, 'g' => 16, 'h' => 17,
3224                 'i' => 18, 'j' => 19, 'k' => 20, 'l' => 21, 'm' => 22, 'n' => 23,
3225                 'o' => 24, 'p' => 25, 'q' => 26, 'r' => 27, 's' => 28, 't' => 29,
3226                 'u' => 30, 'v' => 31, 'w' => 32, 'x' => 33, 'y' => 34, 'z' => 35
3227         );
3228
3229         if ( extension_loaded( 'gmp' ) && ( $engine == 'auto' || $engine == 'gmp' ) ) {
3230                 $result = gmp_strval( gmp_init( $input, $sourceBase ), $destBase );
3231         } elseif ( extension_loaded( 'bcmath' ) && ( $engine == 'auto' || $engine == 'bcmath' ) ) {
3232                 $decimal = '0';
3233                 foreach ( str_split( strtolower( $input ) ) as $char ) {
3234                         $decimal = bcmul( $decimal, $sourceBase );
3235                         $decimal = bcadd( $decimal, $baseChars[$char] );
3236                 }
3237
3238                 for ( $result = ''; bccomp( $decimal, 0 ); $decimal = bcdiv( $decimal, $destBase, 0 ) ) {
3239                         $result .= $baseChars[bcmod( $decimal, $destBase )];
3240                 }
3241
3242                 $result = strrev( $result );
3243         } else {
3244                 $inDigits = array();
3245                 foreach ( str_split( strtolower( $input ) ) as $char ) {
3246                         $inDigits[] = $baseChars[$char];
3247                 }
3248
3249                 // Iterate over the input, modulo-ing out an output digit
3250                 // at a time until input is gone.
3251                 $result = '';
3252                 while ( $inDigits ) {
3253                         $work = 0;
3254                         $workDigits = array();
3255
3256                         // Long division...
3257                         foreach ( $inDigits as $digit ) {
3258                                 $work *= $sourceBase;
3259                                 $work += $digit;
3260
3261                                 if ( $workDigits || $work >= $destBase ) {
3262                                         $workDigits[] = (int)( $work / $destBase );
3263                                 }
3264                                 $work %= $destBase;
3265                         }
3266
3267                         // All that division leaves us with a remainder,
3268                         // which is conveniently our next output digit.
3269                         $result .= $baseChars[$work];
3270
3271                         // And we continue!
3272                         $inDigits = $workDigits;
3273                 }
3274
3275                 $result = strrev( $result );
3276         }
3277
3278         if ( !$lowercase ) {
3279                 $result = strtoupper( $result );
3280         }
3281
3282         return str_pad( $result, $pad, '0', STR_PAD_LEFT );
3283 }
3284
3285 /**
3286  * Create an object with a given name and an array of construct parameters
3287  *
3288  * @param $name String
3289  * @param array $p parameters
3290  * @return object
3291  * @deprecated since 1.18, warnings in 1.18, removal in 1.20
3292  */
3293 function wfCreateObject( $name, $p ) {
3294         wfDeprecated( __FUNCTION__, '1.18' );
3295         return MWFunction::newObj( $name, $p );
3296 }
3297
3298 /**
3299  * @return bool
3300  */
3301 function wfHttpOnlySafe() {
3302         global $wgHttpOnlyBlacklist;
3303
3304         if ( isset( $_SERVER['HTTP_USER_AGENT'] ) ) {
3305                 foreach ( $wgHttpOnlyBlacklist as $regex ) {
3306                         if ( preg_match( $regex, $_SERVER['HTTP_USER_AGENT'] ) ) {
3307                                 return false;
3308                         }
3309                 }
3310         }
3311
3312         return true;
3313 }
3314
3315 /**
3316  * Check if there is sufficient entropy in php's built-in session generation
3317  * @return bool true = there is sufficient entropy
3318  */
3319 function wfCheckEntropy() {
3320         return (
3321                         ( wfIsWindows() && version_compare( PHP_VERSION, '5.3.3', '>=' ) )
3322                         || ini_get( 'session.entropy_file' )
3323                 )
3324                 && intval( ini_get( 'session.entropy_length' ) ) >= 32;
3325 }
3326
3327 /**
3328  * Override session_id before session startup if php's built-in
3329  * session generation code is not secure.
3330  */
3331 function wfFixSessionID() {
3332         // If the cookie or session id is already set we already have a session and should abort
3333         if ( isset( $_COOKIE[session_name()] ) || session_id() ) {
3334                 return;
3335         }
3336
3337         // PHP's built-in session entropy is enabled if:
3338         // - entropy_file is set or you're on Windows with php 5.3.3+
3339         // - AND entropy_length is > 0
3340         // We treat it as disabled if it doesn't have an entropy length of at least 32
3341         $entropyEnabled = wfCheckEntropy();
3342
3343         // If built-in entropy is not enabled or not sufficient override php's built in session id generation code
3344         if ( !$entropyEnabled ) {
3345                 wfDebug( __METHOD__ . ": PHP's built in entropy is disabled or not sufficient, overriding session id generation using our cryptrand source.\n" );
3346                 session_id( MWCryptRand::generateHex( 32 ) );
3347         }
3348 }
3349
3350 /**
3351  * Reset the session_id
3352  * @since 1.22
3353  */
3354 function wfResetSessionID() {
3355         global $wgCookieSecure;
3356         $oldSessionId = session_id();
3357         $cookieParams = session_get_cookie_params();
3358         if ( wfCheckEntropy() && $wgCookieSecure == $cookieParams['secure'] ) {
3359                 session_regenerate_id( false );
3360         } else {
3361                 $tmp = $_SESSION;
3362                 session_destroy();
3363                 wfSetupSession( MWCryptRand::generateHex( 32 ) );
3364                 $_SESSION = $tmp;
3365         }
3366         $newSessionId = session_id();
3367         wfRunHooks( 'ResetSessionID', array( $oldSessionId, $newSessionId ) );
3368 }
3369
3370
3371 /**
3372  * Initialise php session
3373  *
3374  * @param $sessionId Bool
3375  */
3376 function wfSetupSession( $sessionId = false ) {
3377         global $wgSessionsInMemcached, $wgSessionsInObjectCache, $wgCookiePath, $wgCookieDomain,
3378                         $wgCookieSecure, $wgCookieHttpOnly, $wgSessionHandler;
3379         if ( $wgSessionsInObjectCache || $wgSessionsInMemcached ) {
3380                 ObjectCacheSessionHandler::install();
3381         } elseif ( $wgSessionHandler && $wgSessionHandler != ini_get( 'session.save_handler' ) ) {
3382                 # Only set this if $wgSessionHandler isn't null and session.save_handler
3383                 # hasn't already been set to the desired value (that causes errors)
3384                 ini_set( 'session.save_handler', $wgSessionHandler );
3385         }
3386         $httpOnlySafe = wfHttpOnlySafe() && $wgCookieHttpOnly;
3387         wfDebugLog( 'cookie',
3388                 'session_set_cookie_params: "' . implode( '", "',
3389                         array(
3390                                 0,
3391                                 $wgCookiePath,
3392                                 $wgCookieDomain,
3393                                 $wgCookieSecure,
3394                                 $httpOnlySafe ) ) . '"' );
3395         session_set_cookie_params( 0, $wgCookiePath, $wgCookieDomain, $wgCookieSecure, $httpOnlySafe );
3396         session_cache_limiter( 'private, must-revalidate' );
3397         if ( $sessionId ) {
3398                 session_id( $sessionId );
3399         } else {
3400                 wfFixSessionID();
3401         }
3402         wfSuppressWarnings();
3403         session_start();
3404         wfRestoreWarnings();
3405 }
3406
3407 /**
3408  * Get an object from the precompiled serialized directory
3409  *
3410  * @param $name String
3411  * @return Mixed: the variable on success, false on failure
3412  */
3413 function wfGetPrecompiledData( $name ) {
3414         global $IP;
3415
3416         $file = "$IP/serialized/$name";
3417         if ( file_exists( $file ) ) {
3418                 $blob = file_get_contents( $file );
3419                 if ( $blob ) {
3420                         return unserialize( $blob );
3421                 }
3422         }
3423         return false;
3424 }
3425
3426 /**
3427  * Get a cache key
3428  *
3429  * @param varargs
3430  * @return String
3431  */
3432 function wfMemcKey( /*... */ ) {
3433         global $wgCachePrefix;
3434         $prefix = $wgCachePrefix === false ? wfWikiID() : $wgCachePrefix;
3435         $args = func_get_args();
3436         $key = $prefix . ':' . implode( ':', $args );
3437         $key = str_replace( ' ', '_', $key );
3438         return $key;
3439 }
3440
3441 /**
3442  * Get a cache key for a foreign DB
3443  *
3444  * @param $db String
3445  * @param $prefix String
3446  * @param varargs String
3447  * @return String
3448  */
3449 function wfForeignMemcKey( $db, $prefix /*, ... */ ) {
3450         $args = array_slice( func_get_args(), 2 );
3451         if ( $prefix ) {
3452                 $key = "$db-$prefix:" . implode( ':', $args );
3453         } else {
3454                 $key = $db . ':' . implode( ':', $args );
3455         }
3456         return str_replace( ' ', '_', $key );
3457 }
3458
3459 /**
3460  * Get an ASCII string identifying this wiki
3461  * This is used as a prefix in memcached keys
3462  *
3463  * @return String
3464  */
3465 function wfWikiID() {
3466         global $wgDBprefix, $wgDBname;
3467         if ( $wgDBprefix ) {
3468                 return "$wgDBname-$wgDBprefix";
3469         } else {
3470                 return $wgDBname;
3471         }
3472 }
3473
3474 /**
3475  * Split a wiki ID into DB name and table prefix
3476  *
3477  * @param $wiki String
3478  *
3479  * @return array
3480  */
3481 function wfSplitWikiID( $wiki ) {
3482         $bits = explode( '-', $wiki, 2 );
3483         if ( count( $bits ) < 2 ) {
3484                 $bits[] = '';
3485         }
3486         return $bits;
3487 }
3488
3489 /**
3490  * Get a Database object.
3491  *
3492  * @param $db Integer: index of the connection to get. May be DB_MASTER for the
3493  *            master (for write queries), DB_SLAVE for potentially lagged read
3494  *            queries, or an integer >= 0 for a particular server.
3495  *
3496  * @param $groups Mixed: query groups. An array of group names that this query
3497  *                belongs to. May contain a single string if the query is only
3498  *                in one group.
3499  *
3500  * @param string $wiki the wiki ID, or false for the current wiki
3501  *
3502  * Note: multiple calls to wfGetDB(DB_SLAVE) during the course of one request
3503  * will always return the same object, unless the underlying connection or load
3504  * balancer is manually destroyed.
3505  *
3506  * Note 2: use $this->getDB() in maintenance scripts that may be invoked by
3507  * updater to ensure that a proper database is being updated.
3508  *
3509  * @return DatabaseBase
3510  */
3511 function &wfGetDB( $db, $groups = array(), $wiki = false ) {
3512         return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
3513 }
3514
3515 /**
3516  * Get a load balancer object.
3517  *
3518  * @param string $wiki wiki ID, or false for the current wiki
3519  * @return LoadBalancer
3520  */
3521 function wfGetLB( $wiki = false ) {
3522         return wfGetLBFactory()->getMainLB( $wiki );
3523 }
3524
3525 /**
3526  * Get the load balancer factory object
3527  *
3528  * @return LBFactory
3529  */
3530 function &wfGetLBFactory() {
3531         return LBFactory::singleton();
3532 }
3533
3534 /**
3535  * Find a file.
3536  * Shortcut for RepoGroup::singleton()->findFile()
3537  *
3538  * @param string $title or Title object
3539  * @param array $options Associative array of options:
3540  *     time:           requested time for an archived image, or false for the
3541  *                     current version. An image object will be returned which was
3542  *                     created at the specified time.
3543  *
3544  *     ignoreRedirect: If true, do not follow file redirects
3545  *
3546  *     private:        If true, return restricted (deleted) files if the current
3547  *                     user is allowed to view them. Otherwise, such files will not
3548  *                     be found.
3549  *
3550  *     bypassCache:    If true, do not use the process-local cache of File objects
3551  *
3552  * @return File, or false if the file does not exist
3553  */
3554 function wfFindFile( $title, $options = array() ) {
3555         return RepoGroup::singleton()->findFile( $title, $options );
3556 }
3557
3558 /**
3559  * Get an object referring to a locally registered file.
3560  * Returns a valid placeholder object if the file does not exist.
3561  *
3562  * @param $title Title|String
3563  * @return LocalFile|null A File, or null if passed an invalid Title
3564  */
3565 function wfLocalFile( $title ) {
3566         return RepoGroup::singleton()->getLocalRepo()->newFile( $title );
3567 }
3568
3569 /**
3570  * Stream a file to the browser. Back-compat alias for StreamFile::stream()
3571  * @deprecated since 1.19
3572  */
3573 function wfStreamFile( $fname, $headers = array() ) {
3574         wfDeprecated( __FUNCTION__, '1.19' );
3575         StreamFile::stream( $fname, $headers );
3576 }
3577
3578 /**
3579  * Should low-performance queries be disabled?
3580  *
3581  * @return Boolean
3582  * @codeCoverageIgnore
3583  */
3584 function wfQueriesMustScale() {
3585         global $wgMiserMode;
3586         return $wgMiserMode
3587                 || ( SiteStats::pages() > 100000
3588                 && SiteStats::edits() > 1000000
3589                 && SiteStats::users() > 10000 );
3590 }
3591
3592 /**
3593  * Get the path to a specified script file, respecting file
3594  * extensions; this is a wrapper around $wgScriptExtension etc.
3595  * except for 'index' and 'load' which use $wgScript/$wgLoadScript
3596  *
3597  * @param string $script script filename, sans extension
3598  * @return String
3599  */
3600 function wfScript( $script = 'index' ) {
3601         global $wgScriptPath, $wgScriptExtension, $wgScript, $wgLoadScript;
3602         if ( $script === 'index' ) {
3603                 return $wgScript;
3604         } elseif ( $script === 'load' ) {
3605                 return $wgLoadScript;
3606         } else {
3607                 return "{$wgScriptPath}/{$script}{$wgScriptExtension}";
3608         }
3609 }
3610
3611 /**
3612  * Get the script URL.
3613  *
3614  * @return string script URL
3615  */
3616 function wfGetScriptUrl() {
3617         if ( isset( $_SERVER['SCRIPT_NAME'] ) ) {
3618                 #
3619                 # as it was called, minus the query string.
3620                 #
3621                 # Some sites use Apache rewrite rules to handle subdomains,
3622                 # and have PHP set up in a weird way that causes PHP_SELF
3623                 # to contain the rewritten URL instead of the one that the
3624                 # outside world sees.
3625                 #
3626                 # If in this mode, use SCRIPT_URL instead, which mod_rewrite
3627                 # provides containing the "before" URL.
3628                 return $_SERVER['SCRIPT_NAME'];
3629         } else {
3630                 return $_SERVER['URL'];
3631         }
3632 }
3633
3634 /**
3635  * Convenience function converts boolean values into "true"
3636  * or "false" (string) values
3637  *
3638  * @param $value Boolean
3639  * @return String
3640  */
3641 function wfBoolToStr( $value ) {
3642         return $value ? 'true' : 'false';
3643 }
3644
3645 /**
3646  * Get a platform-independent path to the null file, e.g. /dev/null
3647  *
3648  * @return string
3649  */
3650 function wfGetNull() {
3651         return wfIsWindows()
3652                 ? 'NUL'
3653                 : '/dev/null';
3654 }
3655
3656 /**
3657  * Modern version of wfWaitForSlaves(). Instead of looking at replication lag
3658  * and waiting for it to go down, this waits for the slaves to catch up to the
3659  * master position. Use this when updating very large numbers of rows, as
3660  * in maintenance scripts, to avoid causing too much lag.  Of course, this is
3661  * a no-op if there are no slaves.
3662  *
3663  * @param $maxLag Integer (deprecated)
3664  * @param $wiki mixed Wiki identifier accepted by wfGetLB
3665  * @param $cluster string cluster name accepted by LBFactory
3666  */
3667 function wfWaitForSlaves( $maxLag = false, $wiki = false, $cluster = false ) {
3668         $lb = ( $cluster !== false )
3669                 ? wfGetLBFactory()->getExternalLB( $cluster )
3670                 : wfGetLB( $wiki );
3671         // bug 27975 - Don't try to wait for slaves if there are none
3672         // Prevents permission error when getting master position
3673         if ( $lb->getServerCount() > 1 ) {
3674                 $dbw = $lb->getConnection( DB_MASTER, array(), $wiki );
3675                 $pos = $dbw->getMasterPos();
3676                 // The DBMS may not support getMasterPos() or the whole
3677                 // load balancer might be fake (e.g. $wgAllDBsAreLocalhost).
3678                 if ( $pos !== false ) {
3679                         $lb->waitForAll( $pos );
3680                 }
3681         }
3682 }
3683
3684 /**
3685  * Used to be used for outputting text in the installer/updater
3686  * @deprecated since 1.18, warnings in 1.18, remove in 1.20
3687  */
3688 function wfOut( $s ) {
3689         wfDeprecated( __FUNCTION__, '1.18' );
3690         global $wgCommandLineMode;
3691         if ( $wgCommandLineMode ) {
3692                 echo $s;
3693         } else {
3694                 echo htmlspecialchars( $s );
3695         }
3696         flush();
3697 }
3698
3699 /**
3700  * Count down from $n to zero on the terminal, with a one-second pause
3701  * between showing each number. For use in command-line scripts.
3702  * @codeCoverageIgnore
3703  * @param $n int
3704  */
3705 function wfCountDown( $n ) {
3706         for ( $i = $n; $i >= 0; $i-- ) {
3707                 if ( $i != $n ) {
3708                         echo str_repeat( "\x08", strlen( $i + 1 ) );
3709                 }
3710                 echo $i;
3711                 flush();
3712                 if ( $i ) {
3713                         sleep( 1 );
3714                 }
3715         }
3716         echo "\n";
3717 }
3718
3719 /**
3720  * Generate a random 32-character hexadecimal token.
3721  * @param $salt Mixed: some sort of salt, if necessary, to add to random
3722  *              characters before hashing.
3723  * @return string
3724  * @codeCoverageIgnore
3725  * @deprecated since 1.20; Please use MWCryptRand for security purposes and wfRandomString for pseudo-random strings
3726  * @warning This method is NOT secure. Additionally it has many callers that use it for pseudo-random purposes.
3727  */
3728 function wfGenerateToken( $salt = '' ) {
3729         wfDeprecated( __METHOD__, '1.20' );
3730         $salt = serialize( $salt );
3731         return md5( mt_rand( 0, 0x7fffffff ) . $salt );
3732 }
3733
3734 /**
3735  * Replace all invalid characters with -
3736  * Additional characters can be defined in $wgIllegalFileChars (see bug 20489)
3737  * By default, $wgIllegalFileChars = ':'
3738  *
3739  * @param $name Mixed: filename to process
3740  * @return String
3741  */
3742 function wfStripIllegalFilenameChars( $name ) {
3743         global $wgIllegalFileChars;
3744         $illegalFileChars = $wgIllegalFileChars ? "|[" . $wgIllegalFileChars . "]" : '';
3745         $name = wfBaseName( $name );
3746         $name = preg_replace(
3747                 "/[^" . Title::legalChars() . "]" . $illegalFileChars . "/",
3748                 '-',
3749                 $name
3750         );
3751         return $name;
3752 }
3753
3754 /**
3755  * Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit;
3756  *
3757  * @return Integer value memory was set to.
3758  */
3759 function wfMemoryLimit() {
3760         global $wgMemoryLimit;
3761         $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
3762         if ( $memlimit != -1 ) {
3763                 $conflimit = wfShorthandToInteger( $wgMemoryLimit );
3764                 if ( $conflimit == -1 ) {
3765                         wfDebug( "Removing PHP's memory limit\n" );
3766                         wfSuppressWarnings();
3767                         ini_set( 'memory_limit', $conflimit );
3768                         wfRestoreWarnings();
3769                         return $conflimit;
3770                 } elseif ( $conflimit > $memlimit ) {
3771                         wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
3772                         wfSuppressWarnings();
3773                         ini_set( 'memory_limit', $conflimit );
3774                         wfRestoreWarnings();
3775                         return $conflimit;
3776                 }
3777         }
3778         return $memlimit;
3779 }
3780
3781 /**
3782  * Converts shorthand byte notation to integer form
3783  *
3784  * @param $string String
3785  * @return Integer
3786  */
3787 function wfShorthandToInteger( $string = '' ) {
3788         $string = trim( $string );
3789         if ( $string === '' ) {
3790                 return -1;
3791         }
3792         $last = $string[strlen( $string ) - 1];
3793         $val = intval( $string );
3794         switch ( $last ) {
3795                 case 'g':
3796                 case 'G':
3797                         $val *= 1024;
3798                         // break intentionally missing
3799                 case 'm':
3800                 case 'M':
3801                         $val *= 1024;
3802                         // break intentionally missing
3803                 case 'k':
3804                 case 'K':
3805                         $val *= 1024;
3806         }
3807
3808         return $val;
3809 }
3810
3811 /**
3812  * Get the normalised IETF language tag
3813  * See unit test for examples.
3814  *
3815  * @param string $code The language code.
3816  * @return String: The language code which complying with BCP 47 standards.
3817  */
3818 function wfBCP47( $code ) {
3819         $codeSegment = explode( '-', $code );
3820         $codeBCP = array();
3821         foreach ( $codeSegment as $segNo => $seg ) {
3822                 // when previous segment is x, it is a private segment and should be lc
3823                 if ( $segNo > 0 && strtolower( $codeSegment[( $segNo - 1 )] ) == 'x' ) {
3824                         $codeBCP[$segNo] = strtolower( $seg );
3825                 // ISO 3166 country code
3826                 } elseif ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) {
3827                         $codeBCP[$segNo] = strtoupper( $seg );
3828                 // ISO 15924 script code
3829                 } elseif ( ( strlen( $seg ) == 4 ) && ( $segNo > 0 ) ) {
3830                         $codeBCP[$segNo] = ucfirst( strtolower( $seg ) );
3831                 // Use lowercase for other cases
3832                 } else {
3833                         $codeBCP[$segNo] = strtolower( $seg );
3834                 }
3835         }
3836         $langCode = implode( '-', $codeBCP );
3837         return $langCode;
3838 }
3839
3840 /**
3841  * Get a cache object.
3842  *
3843  * @param $inputType integer Cache type, one the the CACHE_* constants.
3844  * @return BagOStuff
3845  */
3846 function wfGetCache( $inputType ) {
3847         return ObjectCache::getInstance( $inputType );
3848 }
3849
3850 /**
3851  * Get the main cache object
3852  *
3853  * @return BagOStuff
3854  */
3855 function wfGetMainCache() {
3856         global $wgMainCacheType;
3857         return ObjectCache::getInstance( $wgMainCacheType );
3858 }
3859
3860 /**
3861  * Get the cache object used by the message cache
3862  *
3863  * @return BagOStuff
3864  */
3865 function wfGetMessageCacheStorage() {
3866         global $wgMessageCacheType;
3867         return ObjectCache::getInstance( $wgMessageCacheType );
3868 }
3869
3870 /**
3871  * Get the cache object used by the parser cache
3872  *
3873  * @return BagOStuff
3874  */
3875 function wfGetParserCacheStorage() {
3876         global $wgParserCacheType;
3877         return ObjectCache::getInstance( $wgParserCacheType );
3878 }
3879
3880 /**
3881  * Get the cache object used by the language converter
3882  *
3883  * @return BagOStuff
3884  */
3885 function wfGetLangConverterCacheStorage() {
3886         global $wgLanguageConverterCacheType;
3887         return ObjectCache::getInstance( $wgLanguageConverterCacheType );
3888 }
3889
3890 /**
3891  * Call hook functions defined in $wgHooks
3892  *
3893  * @param string $event event name
3894  * @param array $args parameters passed to hook functions
3895  * @return Boolean True if no handler aborted the hook
3896  */
3897 function wfRunHooks( $event, array $args = array() ) {
3898         return Hooks::run( $event, $args );
3899 }
3900
3901 /**
3902  * Wrapper around php's unpack.
3903  *
3904  * @param string $format The format string (See php's docs)
3905  * @param $data: A binary string of binary data
3906  * @param $length integer or false: The minimum length of $data. This is to
3907  *      prevent reading beyond the end of $data. false to disable the check.
3908  *
3909  * Also be careful when using this function to read unsigned 32 bit integer
3910  * because php might make it negative.
3911  *
3912  * @throws MWException if $data not long enough, or if unpack fails
3913  * @return array Associative array of the extracted data
3914  */
3915 function wfUnpack( $format, $data, $length = false ) {
3916         if ( $length !== false ) {
3917                 $realLen = strlen( $data );
3918                 if ( $realLen < $length ) {
3919                         throw new MWException( "Tried to use wfUnpack on a "
3920                                 . "string of length $realLen, but needed one "
3921                                 . "of at least length $length."
3922                         );
3923                 }
3924         }
3925
3926         wfSuppressWarnings();
3927         $result = unpack( $format, $data );
3928         wfRestoreWarnings();
3929
3930         if ( $result === false ) {
3931                 // If it cannot extract the packed data.
3932                 throw new MWException( "unpack could not unpack binary data" );
3933         }
3934         return $result;
3935 }
3936
3937 /**
3938  * Determine if an image exists on the 'bad image list'.
3939  *
3940  * The format of MediaWiki:Bad_image_list is as follows:
3941  *    * Only list items (lines starting with "*") are considered
3942  *    * The first link on a line must be a link to a bad image
3943  *    * Any subsequent links on the same line are considered to be exceptions,
3944  *      i.e. articles where the image may occur inline.
3945  *
3946  * @param string $name the image name to check
3947  * @param $contextTitle Title|bool the page on which the image occurs, if known
3948  * @param string $blacklist wikitext of a file blacklist
3949  * @return bool
3950  */
3951 function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
3952         static $badImageCache = null; // based on bad_image_list msg
3953         wfProfileIn( __METHOD__ );
3954
3955         # Handle redirects
3956         $redirectTitle = RepoGroup::singleton()->checkRedirect( Title::makeTitle( NS_FILE, $name ) );
3957         if ( $redirectTitle ) {
3958                 $name = $redirectTitle->getDBkey();
3959         }
3960
3961         # Run the extension hook
3962         $bad = false;
3963         if ( !wfRunHooks( 'BadImage', array( $name, &$bad ) ) ) {
3964                 wfProfileOut( __METHOD__ );
3965                 return $bad;
3966         }
3967
3968         $cacheable = ( $blacklist === null );
3969         if ( $cacheable && $badImageCache !== null ) {
3970                 $badImages = $badImageCache;
3971         } else { // cache miss
3972                 if ( $blacklist === null ) {
3973                         $blacklist = wfMessage( 'bad_image_list' )->inContentLanguage()->plain(); // site list
3974                 }
3975                 # Build the list now
3976                 $badImages = array();
3977                 $lines = explode( "\n", $blacklist );
3978                 foreach ( $lines as $line ) {
3979                         # List items only
3980                         if ( substr( $line, 0, 1 ) !== '*' ) {
3981                                 continue;
3982                         }
3983
3984                         # Find all links
3985                         $m = array();
3986                         if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
3987                                 continue;
3988                         }
3989
3990                         $exceptions = array();
3991                         $imageDBkey = false;
3992                         foreach ( $m[1] as $i => $titleText ) {
3993                                 $title = Title::newFromText( $titleText );
3994                                 if ( !is_null( $title ) ) {
3995                                         if ( $i == 0 ) {
3996                                                 $imageDBkey = $title->getDBkey();
3997                                         } else {
3998                                                 $exceptions[$title->getPrefixedDBkey()] = true;
3999                                         }
4000                                 }
4001                         }
4002
4003                         if ( $imageDBkey !== false ) {
4004                                 $badImages[$imageDBkey] = $exceptions;
4005                         }
4006                 }
4007                 if ( $cacheable ) {
4008                         $badImageCache = $badImages;
4009                 }
4010         }
4011
4012         $contextKey = $contextTitle ? $contextTitle->getPrefixedDBkey() : false;
4013         $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
4014         wfProfileOut( __METHOD__ );
4015         return $bad;
4016 }
4017
4018 /**
4019  * Determine whether the client at a given source IP is likely to be able to
4020  * access the wiki via HTTPS.
4021  *
4022  * @param string $ip The IPv4/6 address in the normal human-readable form
4023  * @return boolean
4024  */
4025 function wfCanIPUseHTTPS( $ip ) {
4026         $canDo = true;
4027         wfRunHooks( 'CanIPUseHTTPS', array( $ip, &$canDo ) );
4028         return !!$canDo;
4029 }