includes/GlobalFunctions.php

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