includes/GlobalFunctions.php

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