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