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