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