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