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