includes/GlobalFunctions.php

   1 <?php
   2
   3 if ( !defined( 'MEDIAWIKI' ) ) {
   4         die( "This file is part of MediaWiki, it is not a valid entry point" );
   5 }
   6
   7 /**
   8  * Global functions used everywhere
   9  */
  10
  11 require_once dirname(__FILE__) . '/LogPage.php';
  12 require_once dirname(__FILE__) . '/normal/UtfNormalUtil.php';
  13 require_once dirname(__FILE__) . '/XmlFunctions.php';
  14
  15 // Hide compatibility functions from Doxygen
  16 /// @cond
  17
  18 /**
  19  * Compatibility functions
  20  *
  21  * We more or less support PHP 5.0.x and up.
  22  * Re-implementations of newer functions or functions in non-standard
  23  * PHP extensions may be included here.
  24  */
  25 if( !function_exists('iconv') ) {
  26         # iconv support is not in the default configuration and so may not be present.
  27         # Assume will only ever use utf-8 and iso-8859-1.
  28         # This will *not* work in all circumstances.
  29         function iconv( $from, $to, $string ) {
  30                 if(strcasecmp( $from, $to ) == 0) return $string;
  31                 if(strcasecmp( $from, 'utf-8' ) == 0) return utf8_decode( $string );
  32                 if(strcasecmp( $to, 'utf-8' ) == 0) return utf8_encode( $string );
  33                 return $string;
  34         }
  35 }
  36
  37 # UTF-8 substr function based on a PHP manual comment
  38 if ( !function_exists( 'mb_substr' ) ) {
  39         function mb_substr( $str, $start ) {
  40                 $ar = array();
  41                 preg_match_all( '/./us', $str, $ar );
  42
  43                 if( func_num_args() >= 3 ) {
  44                         $end = func_get_arg( 2 );
  45                         return join( '', array_slice( $ar[0], $start, $end ) );
  46                 } else {
  47                         return join( '', array_slice( $ar[0], $start ) );
  48                 }
  49         }
  50 }
  51
  52 if ( !function_exists( 'mb_strlen' ) ) {
  53         /**
  54          * Fallback implementation of mb_strlen, hardcoded to UTF-8.
  55          * @param string $str
  56          * @param string $enc optional encoding; ignored
  57          * @return int
  58          */
  59         function mb_strlen( $str, $enc="" ) {
  60                 $counts = count_chars( $str );
  61                 $total = 0;
  62
  63                 // Count ASCII bytes
  64                 for( $i = 0; $i < 0x80; $i++ ) {
  65                         $total += $counts[$i];
  66                 }
  67
  68                 // Count multibyte sequence heads
  69                 for( $i = 0xc0; $i < 0xff; $i++ ) {
  70                         $total += $counts[$i];
  71                 }
  72                 return $total;
  73         }
  74 }
  75
  76 if ( !function_exists( 'array_diff_key' ) ) {
  77         /**
  78          * Exists in PHP 5.1.0+
  79          * Not quite compatible, two-argument version only
  80          * Null values will cause problems due to this use of isset()
  81          */
  82         function array_diff_key( $left, $right ) {
  83                 $result = $left;
  84                 foreach ( $left as $key => $unused ) {
  85                         if ( isset( $right[$key] ) ) {
  86                                 unset( $result[$key] );
  87                         }
  88                 }
  89                 return $result;
  90         }
  91 }
  92
  93 /// @endcond
  94
  95
  96 /**
  97  * Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
  98  */
  99 function wfArrayDiff2( $a, $b ) {
 100         return array_udiff( $a, $b, 'wfArrayDiff2_cmp' );
 101 }
 102 function wfArrayDiff2_cmp( $a, $b ) {
 103         if ( !is_array( $a ) ) {
 104                 return strcmp( $a, $b );
 105         } elseif ( count( $a ) !== count( $b ) ) {
 106                 return count( $a ) < count( $b ) ? -1 : 1;
 107         } else {
 108                 reset( $a );
 109                 reset( $b );
 110                 while( ( list( $keyA, $valueA ) = each( $a ) ) && ( list( $keyB, $valueB ) = each( $b ) ) ) {
 111                         $cmp = strcmp( $valueA, $valueB );
 112                         if ( $cmp !== 0 ) {
 113                                 return $cmp;
 114                         }
 115                 }
 116                 return 0;
 117         }
 118 }
 119
 120 /**
 121  * Wrapper for clone(), for compatibility with PHP4-friendly extensions.
 122  * PHP 5 won't let you declare a 'clone' function, even conditionally,
 123  * so it has to be a wrapper with a different name.
 124  */
 125 function wfClone( $object ) {
 126         return clone( $object );
 127 }
 128
 129 /**
 130  * Seed Mersenne Twister
 131  * No-op for compatibility; only necessary in PHP < 4.2.0
 132  */
 133 function wfSeedRandom() {
 134         /* No-op */
 135 }
 136
 137 /**
 138  * Get a random decimal value between 0 and 1, in a way
 139  * not likely to give duplicate values for any realistic
 140  * number of articles.
 141  *
 142  * @return string
 143  */
 144 function wfRandom() {
 145         # The maximum random value is "only" 2^31-1, so get two random
 146         # values to reduce the chance of dupes
 147         $max = mt_getrandmax() + 1;
 148         $rand = number_format( (mt_rand() * $max + mt_rand())
 149                 / $max / $max, 12, '.', '' );
 150         return $rand;
 151 }
 152
 153 /**
 154  * We want some things to be included as literal characters in our title URLs
 155  * for prettiness, which urlencode encodes by default.  According to RFC 1738,
 156  * all of the following should be safe:
 157  *
 158  * ;:@&=$-_.+!*'(),
 159  *
 160  * But + is not safe because it's used to indicate a space; &= are only safe in
 161  * paths and not in queries (and we don't distinguish here); ' seems kind of
 162  * scary; and urlencode() doesn't touch -_. to begin with.  Plus, although /
 163  * is reserved, we don't care.  So the list we unescape is:
 164  *
 165  * ;:@$!*(),/
 166  *
 167  * %2F in the page titles seems to fatally break for some reason.
 168  *
 169  * @param $s String:
 170  * @return string
 171 */
 172 function wfUrlencode( $s ) {
 173         $s = urlencode( $s );
 174         $s = str_ireplace(
 175                 array( '%3B','%3A','%40','%24','%21','%2A','%28','%29','%2C','%2F' ),
 176                 array(   ';',  ':',  '@',  '$',  '!',  '*',  '(',  ')',  ',',  '/' ),
 177                 $s
 178         );
 179
 180         return $s;
 181 }
 182
 183 /**
 184  * Sends a line to the debug log if enabled or, optionally, to a comment in output.
 185  * In normal operation this is a NOP.
 186  *
 187  * Controlling globals:
 188  * $wgDebugLogFile - points to the log file
 189  * $wgProfileOnly - if set, normal debug messages will not be recorded.
 190  * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
 191  * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
 192  *
 193  * @param $text String
 194  * @param $logonly Bool: set true to avoid appearing in HTML when $wgDebugComments is set
 195  */
 196 function wfDebug( $text, $logonly = false ) {
 197         global $wgOut, $wgDebugLogFile, $wgDebugComments, $wgProfileOnly, $wgDebugRawPage;
 198         global $wgDebugLogPrefix;
 199         static $recursion = 0;
 200
 201         static $cache = array(); // Cache of unoutputted messages
 202
 203         # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
 204         if ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' && !$wgDebugRawPage ) {
 205                 return;
 206         }
 207
 208         if ( $wgDebugComments && !$logonly ) {
 209                 $cache[] = $text;
 210
 211                 if ( !isset( $wgOut ) ) {
 212                         return;
 213                 }
 214                 if ( !StubObject::isRealObject( $wgOut ) ) {
 215                         if ( $recursion ) {
 216                                 return;
 217                         }
 218                         $recursion++;
 219                         $wgOut->_unstub();
 220                         $recursion--;
 221                 }
 222
 223                 // add the message and possible cached ones to the output
 224                 array_map( array( $wgOut, 'debug' ), $cache );
 225                 $cache = array();
 226         }
 227         if ( '' != $wgDebugLogFile && !$wgProfileOnly ) {
 228                 # Strip unprintables; they can switch terminal modes when binary data
 229                 # gets dumped, which is pretty annoying.
 230                 $text = preg_replace( '![\x00-\x08\x0b\x0c\x0e-\x1f]!', ' ', $text );
 231                 $text = $wgDebugLogPrefix . $text;
 232                 wfErrorLog( $text, $wgDebugLogFile );
 233         }
 234 }
 235
 236 /**
 237  * Send a line giving PHP memory usage.
 238  * @param $exact Bool : print exact values instead of kilobytes (default: false)
 239  */
 240 function wfDebugMem( $exact = false ) {
 241         $mem = memory_get_usage();
 242         if( !$exact ) {
 243                 $mem = floor( $mem / 1024 ) . ' kilobytes';
 244         } else {
 245                 $mem .= ' bytes';
 246         }
 247         wfDebug( "Memory usage: $mem\n" );
 248 }
 249
 250 /**
 251  * Send a line to a supplementary debug log file, if configured, or main debug log if not.
 252  * $wgDebugLogGroups[$logGroup] should be set to a filename to send to a separate log.
 253  *
 254  * @param $logGroup String
 255  * @param $text String
 256  * @param $public Bool: whether to log the event in the public log if no private
 257  *                     log file is specified, (default true)
 258  */
 259 function wfDebugLog( $logGroup, $text, $public = true ) {
 260         global $wgDebugLogGroups, $wgShowHostnames;
 261         if( $text{strlen( $text ) - 1} != "\n" ) $text .= "\n";
 262         if( isset( $wgDebugLogGroups[$logGroup] ) ) {
 263                 $time = wfTimestamp( TS_DB );
 264                 $wiki = wfWikiID();
 265                 if ( $wgShowHostnames ) {
 266                         $host = wfHostname();
 267                 } else {
 268                         $host = '';
 269                 }
 270                 wfErrorLog( "$time $host $wiki: $text", $wgDebugLogGroups[$logGroup] );
 271         } else if ( $public === true ) {
 272                 wfDebug( $text, true );
 273         }
 274 }
 275
 276 /**
 277  * Log for database errors
 278  * @param $text String: database error message.
 279  */
 280 function wfLogDBError( $text ) {
 281         global $wgDBerrorLog, $wgDBname;
 282         if ( $wgDBerrorLog ) {
 283                 $host = trim(`hostname`);
 284                 $text = date('D M j G:i:s T Y') . "\t$host\t$wgDBname\t$text";
 285                 wfErrorLog( $text, $wgDBerrorLog );
 286         }
 287 }
 288
 289 /**
 290  * Log to a file without getting "file size exceeded" signals.
 291  *
 292  * Can also log to TCP or UDP with the syntax udp://host:port/prefix. This will
 293  * send lines to the specified port, prefixed by the specified prefix and a space.
 294  */
 295 function wfErrorLog( $text, $file ) {
 296         if ( substr( $file, 0, 4 ) == 'udp:' ) {
 297                 if ( preg_match( '!^(tcp|udp):(?://)?\[([0-9a-fA-F:]+)\]:(\d+)(?:/(.*))?$!', $file, $m ) ) {
 298                         // IPv6 bracketed host
 299                         $protocol = $m[1];
 300                         $host = $m[2];
 301                         $port = $m[3];
 302                         $prefix = isset( $m[4] ) ? $m[4] : false;
 303                 } elseif ( preg_match( '!^(tcp|udp):(?://)?([a-zA-Z0-9.-]+):(\d+)(?:/(.*))?$!', $file, $m ) ) {
 304                         $protocol = $m[1];
 305                         $host = $m[2];
 306                         $port = $m[3];
 307                         $prefix = isset( $m[4] ) ? $m[4] : false;
 308                 } else {
 309                         throw new MWException( __METHOD__.": Invalid UDP specification" );
 310                 }
 311                 // Clean it up for the multiplexer
 312                 if ( strval( $prefix ) !== '' ) {
 313                         $text = preg_replace( '/^/m', $prefix . ' ', $text );
 314                         if ( substr( $text, -1 ) != "\n" ) {
 315                                 $text .= "\n";
 316                         }
 317                 }
 318
 319                 $sock = fsockopen( "$protocol://$host", $port );
 320                 if ( !$sock ) {
 321                         return;
 322                 }
 323                 fwrite( $sock, $text );
 324                 fclose( $sock );
 325         } else {
 326                 wfSuppressWarnings();
 327                 $exists = file_exists( $file );
 328                 $size = $exists ? filesize( $file ) : false;
 329                 if ( !$exists || ( $size !== false && $size + strlen( $text ) < 0x7fffffff ) ) {
 330                         error_log( $text, 3, $file );
 331                 }
 332                 wfRestoreWarnings();
 333         }
 334 }
 335
 336 /**
 337  * @todo document
 338  */
 339 function wfLogProfilingData() {
 340         global $wgRequestTime, $wgDebugLogFile, $wgDebugRawPage, $wgRequest;
 341         global $wgProfiler, $wgUser;
 342         if ( !isset( $wgProfiler ) )
 343                 return;
 344
 345         $now = wfTime();
 346         $elapsed = $now - $wgRequestTime;
 347         $prof = wfGetProfilingOutput( $wgRequestTime, $elapsed );
 348         $forward = '';
 349         if( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) )
 350                 $forward = ' forwarded for ' . $_SERVER['HTTP_X_FORWARDED_FOR'];
 351         if( !empty( $_SERVER['HTTP_CLIENT_IP'] ) )
 352                 $forward .= ' client IP ' . $_SERVER['HTTP_CLIENT_IP'];
 353         if( !empty( $_SERVER['HTTP_FROM'] ) )
 354                 $forward .= ' from ' . $_SERVER['HTTP_FROM'];
 355         if( $forward )
 356                 $forward = "\t(proxied via {$_SERVER['REMOTE_ADDR']}{$forward})";
 357         // Don't unstub $wgUser at this late stage just for statistics purposes
 358         if( StubObject::isRealObject($wgUser) && $wgUser->isAnon() )
 359                 $forward .= ' anon';
 360         $log = sprintf( "%s\t%04.3f\t%s\n",
 361           gmdate( 'YmdHis' ), $elapsed,
 362           urldecode( $wgRequest->getRequestURL() . $forward ) );
 363         if ( '' != $wgDebugLogFile && ( $wgRequest->getVal('action') != 'raw' || $wgDebugRawPage ) ) {
 364                 wfErrorLog( $log . $prof, $wgDebugLogFile );
 365         }
 366 }
 367
 368 /**
 369  * Check if the wiki read-only lock file is present. This can be used to lock
 370  * off editing functions, but doesn't guarantee that the database will not be
 371  * modified.
 372  * @return bool
 373  */
 374 function wfReadOnly() {
 375         global $wgReadOnlyFile, $wgReadOnly;
 376
 377         if ( !is_null( $wgReadOnly ) ) {
 378                 return (bool)$wgReadOnly;
 379         }
 380         if ( '' == $wgReadOnlyFile ) {
 381                 return false;
 382         }
 383         // Set $wgReadOnly for faster access next time
 384         if ( is_file( $wgReadOnlyFile ) ) {
 385                 $wgReadOnly = file_get_contents( $wgReadOnlyFile );
 386         } else {
 387                 $wgReadOnly = false;
 388         }
 389         return (bool)$wgReadOnly;
 390 }
 391
 392 function wfReadOnlyReason() {
 393         global $wgReadOnly;
 394         wfReadOnly();
 395         return $wgReadOnly;
 396 }
 397
 398 /**
 399  * Return a Language object from $langcode
 400  * @param $langcode Mixed: either:
 401  *                  - a Language object
 402  *                  - code of the language to get the message for, if it is
 403  *                    a valid code create a language for that language, if
 404  *                    it is a string but not a valid code then make a basic
 405  *                    language object
 406  *                  - a boolean: if it's false then use the current users
 407  *                    language (as a fallback for the old parameter
 408  *                    functionality), or if it is true then use the wikis
 409  * @return Language object
 410  */
 411 function wfGetLangObj( $langcode = false ){
 412         # Identify which language to get or create a language object for.
 413         if( $langcode instanceof Language )
 414                 # Great, we already have the object!
 415                 return $langcode;
 416
 417         global $wgContLang;
 418         if( $langcode === $wgContLang->getCode() || $langcode === true )
 419                 # $langcode is the language code of the wikis content language object.
 420                 # or it is a boolean and value is true
 421                 return $wgContLang;
 422
 423         global $wgLang;
 424         if( $langcode === $wgLang->getCode() || $langcode === false )
 425                 # $langcode is the language code of user language object.
 426                 # or it was a boolean and value is false
 427                 return $wgLang;
 428
 429         $validCodes = array_keys( Language::getLanguageNames() );
 430         if( in_array( $langcode, $validCodes ) )
 431                 # $langcode corresponds to a valid language.
 432                 return Language::factory( $langcode );
 433
 434         # $langcode is a string, but not a valid language code; use content language.
 435         wfDebug( 'Invalid language code passed to wfGetLangObj, falling back to content language.' );
 436         return $wgContLang;
 437 }
 438
 439 /**
 440  * Get a message from anywhere, for the current user language.
 441  *
 442  * Use wfMsgForContent() instead if the message should NOT
 443  * change depending on the user preferences.
 444  *
 445  * @param $key String: lookup key for the message, usually
 446  *    defined in languages/Language.php
 447  *
 448  * This function also takes extra optional parameters (not
 449  * shown in the function definition), which can by used to
 450  * insert variable text into the predefined message.
 451  */
 452 function wfMsg( $key ) {
 453         $args = func_get_args();
 454         array_shift( $args );
 455         return wfMsgReal( $key, $args, true );
 456 }
 457
 458 /**
 459  * Same as above except doesn't transform the message
 460  */
 461 function wfMsgNoTrans( $key ) {
 462         $args = func_get_args();
 463         array_shift( $args );
 464         return wfMsgReal( $key, $args, true, false, false );
 465 }
 466
 467 /**
 468  * Get a message from anywhere, for the current global language
 469  * set with $wgLanguageCode.
 470  *
 471  * Use this if the message should NOT change  dependent on the
 472  * language set in the user's preferences. This is the case for
 473  * most text written into logs, as well as link targets (such as
 474  * the name of the copyright policy page). Link titles, on the
 475  * other hand, should be shown in the UI language.
 476  *
 477  * Note that MediaWiki allows users to change the user interface
 478  * language in their preferences, but a single installation
 479  * typically only contains content in one language.
 480  *
 481  * Be wary of this distinction: If you use wfMsg() where you should
 482  * use wfMsgForContent(), a user of the software may have to
 483  * customize over 70 messages in order to, e.g., fix a link in every
 484  * possible language.
 485  *
 486  * @param $key String: lookup key for the message, usually
 487  *    defined in languages/Language.php
 488  */
 489 function wfMsgForContent( $key ) {
 490         global $wgForceUIMsgAsContentMsg;
 491         $args = func_get_args();
 492         array_shift( $args );
 493         $forcontent = true;
 494         if( is_array( $wgForceUIMsgAsContentMsg ) &&
 495                 in_array( $key, $wgForceUIMsgAsContentMsg ) )
 496                 $forcontent = false;
 497         return wfMsgReal( $key, $args, true, $forcontent );
 498 }
 499
 500 /**
 501  * Same as above except doesn't transform the message
 502  */
 503 function wfMsgForContentNoTrans( $key ) {
 504         global $wgForceUIMsgAsContentMsg;
 505         $args = func_get_args();
 506         array_shift( $args );
 507         $forcontent = true;
 508         if( is_array( $wgForceUIMsgAsContentMsg ) &&
 509                 in_array( $key, $wgForceUIMsgAsContentMsg ) )
 510                 $forcontent = false;
 511         return wfMsgReal( $key, $args, true, $forcontent, false );
 512 }
 513
 514 /**
 515  * Get a message from the language file, for the UI elements
 516  */
 517 function wfMsgNoDB( $key ) {
 518         $args = func_get_args();
 519         array_shift( $args );
 520         return wfMsgReal( $key, $args, false );
 521 }
 522
 523 /**
 524  * Get a message from the language file, for the content
 525  */
 526 function wfMsgNoDBForContent( $key ) {
 527         global $wgForceUIMsgAsContentMsg;
 528         $args = func_get_args();
 529         array_shift( $args );
 530         $forcontent = true;
 531         if( is_array( $wgForceUIMsgAsContentMsg ) &&
 532                 in_array( $key, $wgForceUIMsgAsContentMsg ) )
 533                 $forcontent = false;
 534         return wfMsgReal( $key, $args, false, $forcontent );
 535 }
 536
 537
 538 /**
 539  * Really get a message
 540  * @param $key String: key to get.
 541  * @param $args
 542  * @param $useDB Boolean
 543  * @param $transform Boolean: Whether or not to transform the message.
 544  * @param $forContent Boolean
 545  * @return String: the requested message.
 546  */
 547 function wfMsgReal( $key, $args, $useDB = true, $forContent=false, $transform = true ) {
 548         wfProfileIn( __METHOD__ );
 549         $message = wfMsgGetKey( $key, $useDB, $forContent, $transform );
 550         $message = wfMsgReplaceArgs( $message, $args );
 551         wfProfileOut( __METHOD__ );
 552         return $message;
 553 }
 554
 555 /**
 556  * This function provides the message source for messages to be edited which are *not* stored in the database.
 557  * @param $key String:
 558  */
 559 function wfMsgWeirdKey ( $key ) {
 560         $source = wfMsgGetKey( $key, false, true, false );
 561         if ( wfEmptyMsg( $key, $source ) )
 562                 return "";
 563         else
 564                 return $source;
 565 }
 566
 567 /**
 568  * Fetch a message string value, but don't replace any keys yet.
 569  * @param string $key
 570  * @param bool $useDB
 571  * @param string $langcode Code of the language to get the message for, or
 572  *                         behaves as a content language switch if it is a
 573  *                         boolean.
 574  * @return string
 575  * @private
 576  */
 577 function wfMsgGetKey( $key, $useDB, $langCode = false, $transform = true ) {
 578         global $wgContLang, $wgMessageCache;
 579
 580         wfRunHooks('NormalizeMessageKey', array(&$key, &$useDB, &$langCode, &$transform));
 581
 582         # If $wgMessageCache isn't initialised yet, try to return something sensible.
 583         if( is_object( $wgMessageCache ) ) {
 584                 $message = $wgMessageCache->get( $key, $useDB, $langCode );
 585                 if ( $transform ) {
 586                         $message = $wgMessageCache->transform( $message );
 587                 }
 588         } else {
 589                 $lang = wfGetLangObj( $langCode );
 590
 591                 # MessageCache::get() does this already, Language::getMessage() doesn't
 592                 # ISSUE: Should we try to handle "message/lang" here too?
 593                 $key = str_replace( ' ' , '_' , $wgContLang->lcfirst( $key ) );
 594
 595                 if( is_object( $lang ) ) {
 596                         $message = $lang->getMessage( $key );
 597                 } else {
 598                         $message = false;
 599                 }
 600         }
 601
 602         return $message;
 603 }
 604
 605 /**
 606  * Replace message parameter keys on the given formatted output.
 607  *
 608  * @param string $message
 609  * @param array $args
 610  * @return string
 611  * @private
 612  */
 613 function wfMsgReplaceArgs( $message, $args ) {
 614         # Fix windows line-endings
 615         # Some messages are split with explode("\n", $msg)
 616         $message = str_replace( "\r", '', $message );
 617
 618         // Replace arguments
 619         if ( count( $args ) ) {
 620                 if ( is_array( $args[0] ) ) {
 621                         $args = array_values( $args[0] );
 622                 }
 623                 $replacementKeys = array();
 624                 foreach( $args as $n => $param ) {
 625                         $replacementKeys['$' . ($n + 1)] = $param;
 626                 }
 627                 $message = strtr( $message, $replacementKeys );
 628         }
 629
 630         return $message;
 631 }
 632
 633 /**
 634  * Return an HTML-escaped version of a message.
 635  * Parameter replacements, if any, are done *after* the HTML-escaping,
 636  * so parameters may contain HTML (eg links or form controls). Be sure
 637  * to pre-escape them if you really do want plaintext, or just wrap
 638  * the whole thing in htmlspecialchars().
 639  *
 640  * @param string $key
 641  * @param string ... parameters
 642  * @return string
 643  */
 644 function wfMsgHtml( $key ) {
 645         $args = func_get_args();
 646         array_shift( $args );
 647         return wfMsgReplaceArgs( htmlspecialchars( wfMsgGetKey( $key, true ) ), $args );
 648 }
 649
 650 /**
 651  * Return an HTML version of message
 652  * Parameter replacements, if any, are done *after* parsing the wiki-text message,
 653  * so parameters may contain HTML (eg links or form controls). Be sure
 654  * to pre-escape them if you really do want plaintext, or just wrap
 655  * the whole thing in htmlspecialchars().
 656  *
 657  * @param string $key
 658  * @param string ... parameters
 659  * @return string
 660  */
 661 function wfMsgWikiHtml( $key ) {
 662         global $wgOut;
 663         $args = func_get_args();
 664         array_shift( $args );
 665         return wfMsgReplaceArgs( $wgOut->parse( wfMsgGetKey( $key, true ), /* can't be set to false */ true ), $args );
 666 }
 667
 668 /**
 669  * Returns message in the requested format
 670  * @param string $key Key of the message
 671  * @param array $options Processing rules.  Can take the following options:
 672  *   <i>parse</i>: parses wikitext to html
 673  *   <i>parseinline</i>: parses wikitext to html and removes the surrounding
 674  *       p's added by parser or tidy
 675  *   <i>escape</i>: filters message through htmlspecialchars
 676  *   <i>escapenoentities</i>: same, but allows entity references like &nbsp; through
 677  *   <i>replaceafter</i>: parameters are substituted after parsing or escaping
 678  *   <i>parsemag</i>: transform the message using magic phrases
 679  *   <i>content</i>: fetch message for content language instead of interface
 680  * Also can accept a single associative argument, of the form 'language' => 'xx':
 681  *   <i>language</i>: Language object or language code to fetch message for
 682  *       (overriden by <i>content</i>), its behaviour with parser, parseinline
 683  *       and parsemag is undefined.
 684  * Behavior for conflicting options (e.g., parse+parseinline) is undefined.
 685  */
 686 function wfMsgExt( $key, $options ) {
 687         global $wgOut;
 688
 689         $args = func_get_args();
 690         array_shift( $args );
 691         array_shift( $args );
 692         $options = (array)$options;
 693
 694         foreach( $options as $arrayKey => $option ) {
 695                 if( !preg_match( '/^[0-9]+|language$/', $arrayKey ) ) {
 696                         # An unknown index, neither numeric nor "language"
 697                         trigger_error( "wfMsgExt called with incorrect parameter key $arrayKey", E_USER_WARNING );
 698                 } elseif( preg_match( '/^[0-9]+$/', $arrayKey ) && !in_array( $option,
 699                 array( 'parse', 'parseinline', 'escape', 'escapenoentities',
 700                 'replaceafter', 'parsemag', 'content' ) ) ) {
 701                         # A numeric index with unknown value
 702                         trigger_error( "wfMsgExt called with incorrect parameter $option", E_USER_WARNING );
 703                 }
 704         }
 705
 706         if( in_array('content', $options) ) {
 707                 $forContent = true;
 708                 $langCode = true;
 709         } elseif( array_key_exists('language', $options) ) {
 710                 $forContent = false;
 711                 $langCode = wfGetLangObj( $options['language'] );
 712         } else {
 713                 $forContent = false;
 714                 $langCode = false;
 715         }
 716
 717         $string = wfMsgGetKey( $key, /*DB*/true, $langCode, /*Transform*/false );
 718
 719         if( !in_array('replaceafter', $options) ) {
 720                 $string = wfMsgReplaceArgs( $string, $args );
 721         }
 722
 723         if( in_array('parse', $options) ) {
 724                 $string = $wgOut->parse( $string, true, !$forContent );
 725         } elseif ( in_array('parseinline', $options) ) {
 726                 $string = $wgOut->parse( $string, true, !$forContent );
 727                 $m = array();
 728                 if( preg_match( '/^<p>(.*)\n?<\/p>\n?$/sU', $string, $m ) ) {
 729                         $string = $m[1];
 730                 }
 731         } elseif ( in_array('parsemag', $options) ) {
 732                 global $wgMessageCache;
 733                 if ( isset( $wgMessageCache ) ) {
 734                         $string = $wgMessageCache->transform( $string, !$forContent );
 735                 }
 736         }
 737
 738         if ( in_array('escape', $options) ) {
 739                 $string = htmlspecialchars ( $string );
 740         } elseif ( in_array( 'escapenoentities', $options ) ) {
 741                 $string = Sanitizer::escapeHtmlAllowEntities( $string );
 742         }
 743
 744         if( in_array('replaceafter', $options) ) {
 745                 $string = wfMsgReplaceArgs( $string, $args );
 746         }
 747
 748         return $string;
 749 }
 750
 751
 752 /**
 753  * Just like exit() but makes a note of it.
 754  * Commits open transactions except if the error parameter is set
 755  *
 756  * @deprecated Please return control to the caller or throw an exception
 757  */
 758 function wfAbruptExit( $error = false ){
 759         static $called = false;
 760         if ( $called ){
 761                 exit( -1 );
 762         }
 763         $called = true;
 764
 765         $bt = wfDebugBacktrace();
 766         if( $bt ) {
 767                 for($i = 0; $i < count($bt) ; $i++){
 768                         $file = isset($bt[$i]['file']) ? $bt[$i]['file'] : "unknown";
 769                         $line = isset($bt[$i]['line']) ? $bt[$i]['line'] : "unknown";
 770                         wfDebug("WARNING: Abrupt exit in $file at line $line\n");
 771                 }
 772         } else {
 773                 wfDebug('WARNING: Abrupt exit\n');
 774         }
 775
 776         wfLogProfilingData();
 777
 778         if ( !$error ) {
 779                 wfGetLB()->closeAll();
 780         }
 781         exit( -1 );
 782 }
 783
 784 /**
 785  * @deprecated Please return control the caller or throw an exception
 786  */
 787 function wfErrorExit() {
 788         wfAbruptExit( true );
 789 }
 790
 791 /**
 792  * Print a simple message and die, returning nonzero to the shell if any.
 793  * Plain die() fails to return nonzero to the shell if you pass a string.
 794  * @param string $msg
 795  */
 796 function wfDie( $msg='' ) {
 797         echo $msg;
 798         die( 1 );
 799 }
 800
 801 /**
 802  * Throw a debugging exception. This function previously once exited the process,
 803  * but now throws an exception instead, with similar results.
 804  *
 805  * @param string $msg Message shown when dieing.
 806  */
 807 function wfDebugDieBacktrace( $msg = '' ) {
 808         throw new MWException( $msg );
 809 }
 810
 811 /**
 812  * Fetch server name for use in error reporting etc.
 813  * Use real server name if available, so we know which machine
 814  * in a server farm generated the current page.
 815  * @return string
 816  */
 817 function wfHostname() {
 818         static $host;
 819         if ( is_null( $host ) ) {
 820                 if ( function_exists( 'posix_uname' ) ) {
 821                         // This function not present on Windows
 822                         $uname = @posix_uname();
 823                 } else {
 824                         $uname = false;
 825                 }
 826                 if( is_array( $uname ) && isset( $uname['nodename'] ) ) {
 827                         $host = $uname['nodename'];
 828                 } elseif ( getenv( 'COMPUTERNAME' ) ) {
 829                         # Windows computer name
 830                         $host = getenv( 'COMPUTERNAME' );
 831                 } else {
 832                         # This may be a virtual server.
 833                         $host = $_SERVER['SERVER_NAME'];
 834                 }
 835         }
 836         return $host;
 837 }
 838
 839         /**
 840          * Returns a HTML comment with the elapsed time since request.
 841          * This method has no side effects.
 842          * @return string
 843          */
 844         function wfReportTime() {
 845                 global $wgRequestTime, $wgShowHostnames;
 846
 847                 $now = wfTime();
 848                 $elapsed = $now - $wgRequestTime;
 849
 850                 return $wgShowHostnames
 851                         ? sprintf( "<!-- Served by %s in %01.3f secs. -->", wfHostname(), $elapsed )
 852                         : sprintf( "<!-- Served in %01.3f secs. -->", $elapsed );
 853         }
 854
 855 /**
 856  * Safety wrapper for debug_backtrace().
 857  *
 858  * With Zend Optimizer 3.2.0 loaded, this causes segfaults under somewhat
 859  * murky circumstances, which may be triggered in part by stub objects
 860  * or other fancy talkin'.
 861  *
 862  * Will return an empty array if Zend Optimizer is detected, otherwise
 863  * the output from debug_backtrace() (trimmed).
 864  *
 865  * @return array of backtrace information
 866  */
 867 function wfDebugBacktrace() {
 868         if( extension_loaded( 'Zend Optimizer' ) ) {
 869                 wfDebug( "Zend Optimizer detected; skipping debug_backtrace for safety.\n" );
 870                 return array();
 871         } else {
 872                 return array_slice( debug_backtrace(), 1 );
 873         }
 874 }
 875
 876 function wfBacktrace() {
 877         global $wgCommandLineMode;
 878
 879         if ( $wgCommandLineMode ) {
 880                 $msg = '';
 881         } else {
 882                 $msg = "<ul>\n";
 883         }
 884         $backtrace = wfDebugBacktrace();
 885         foreach( $backtrace as $call ) {
 886                 if( isset( $call['file'] ) ) {
 887                         $f = explode( DIRECTORY_SEPARATOR, $call['file'] );
 888                         $file = $f[count($f)-1];
 889                 } else {
 890                         $file = '-';
 891                 }
 892                 if( isset( $call['line'] ) ) {
 893                         $line = $call['line'];
 894                 } else {
 895                         $line = '-';
 896                 }
 897                 if ( $wgCommandLineMode ) {
 898                         $msg .= "$file line $line calls ";
 899                 } else {
 900                         $msg .= '<li>' . $file . ' line ' . $line . ' calls ';
 901                 }
 902                 if( !empty( $call['class'] ) ) $msg .= $call['class'] . '::';
 903                 $msg .= $call['function'] . '()';
 904
 905                 if ( $wgCommandLineMode ) {
 906                         $msg .= "\n";
 907                 } else {
 908                         $msg .= "</li>\n";
 909                 }
 910         }
 911         if ( $wgCommandLineMode ) {
 912                 $msg .= "\n";
 913         } else {
 914                 $msg .= "</ul>\n";
 915         }
 916
 917         return $msg;
 918 }
 919
 920
 921 /* Some generic result counters, pulled out of SearchEngine */
 922
 923
 924 /**
 925  * @todo document
 926  */
 927 function wfShowingResults( $offset, $limit ) {
 928         global $wgLang;
 929         return wfMsgExt( 'showingresults', array( 'parseinline' ), $wgLang->formatNum( $limit ), $wgLang->formatNum( $offset+1 ) );
 930 }
 931
 932 /**
 933  * @todo document
 934  */
 935 function wfShowingResultsNum( $offset, $limit, $num ) {
 936         global $wgLang;
 937         return wfMsgExt( 'showingresultsnum', array( 'parseinline' ), $wgLang->formatNum( $limit ), $wgLang->formatNum( $offset+1 ), $wgLang->formatNum( $num ) );
 938 }
 939
 940 /**
 941  * @todo document
 942  */
 943 function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) {
 944         global $wgLang;
 945         $fmtLimit = $wgLang->formatNum( $limit );
 946         $prev = wfMsg( 'prevn', $fmtLimit );
 947         $next = wfMsg( 'nextn', $fmtLimit );
 948
 949         if( is_object( $link ) ) {
 950                 $title =& $link;
 951         } else {
 952                 $title = Title::newFromText( $link );
 953                 if( is_null( $title ) ) {
 954                         return false;
 955                 }
 956         }
 957
 958         if ( 0 != $offset ) {
 959                 $po = $offset - $limit;
 960                 if ( $po < 0 ) { $po = 0; }
 961                 $q = "limit={$limit}&offset={$po}";
 962                 if ( '' != $query ) { $q .= '&'.$query; }
 963                 $plink = '<a href="' . $title->escapeLocalUrl( $q ) . "\" class=\"mw-prevlink\">{$prev}</a>";
 964         } else { $plink = $prev; }
 965
 966         $no = $offset + $limit;
 967         $q = 'limit='.$limit.'&offset='.$no;
 968         if ( '' != $query ) { $q .= '&'.$query; }
 969
 970         if ( $atend ) {
 971                 $nlink = $next;
 972         } else {
 973                 $nlink = '<a href="' . $title->escapeLocalUrl( $q ) . "\" class=\"mw-nextlink\">{$next}</a>";
 974         }
 975         $nums = wfNumLink( $offset, 20, $title, $query ) . ' | ' .
 976           wfNumLink( $offset, 50, $title, $query ) . ' | ' .
 977           wfNumLink( $offset, 100, $title, $query ) . ' | ' .
 978           wfNumLink( $offset, 250, $title, $query ) . ' | ' .
 979           wfNumLink( $offset, 500, $title, $query );
 980
 981         return wfMsg( 'viewprevnext', $plink, $nlink, $nums );
 982 }
 983
 984 /**
 985  * @todo document
 986  */
 987 function wfNumLink( $offset, $limit, &$title, $query = '' ) {
 988         global $wgLang;
 989         if ( '' == $query ) { $q = ''; }
 990         else { $q = $query.'&'; }
 991         $q .= 'limit='.$limit.'&offset='.$offset;
 992
 993         $fmtLimit = $wgLang->formatNum( $limit );
 994         $s = '<a href="' . $title->escapeLocalUrl( $q ) . "\" class=\"mw-numlink\">{$fmtLimit}</a>";
 995         return $s;
 996 }
 997
 998 /**
 999  * @todo document
1000  * @todo FIXME: we may want to blacklist some broken browsers
1001  *
1002  * @return bool Whereas client accept gzip compression
1003  */
1004 function wfClientAcceptsGzip() {
1005         global $wgUseGzip;
1006         if( $wgUseGzip ) {
1007                 # FIXME: we may want to blacklist some broken browsers
1008                 $m = array();
1009                 if( preg_match(
1010                         '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
1011                         $_SERVER['HTTP_ACCEPT_ENCODING'],
1012                         $m ) ) {
1013                         if( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) return false;
1014                         wfDebug( " accepts gzip\n" );
1015                         return true;
1016                 }
1017         }
1018         return false;
1019 }
1020
1021 /**
1022  * Obtain the offset and limit values from the request string;
1023  * used in special pages
1024  *
1025  * @param $deflimit Default limit if none supplied
1026  * @param $optionname Name of a user preference to check against
1027  * @return array
1028  *
1029  */
1030 function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
1031         global $wgRequest;
1032         return $wgRequest->getLimitOffset( $deflimit, $optionname );
1033 }
1034
1035 /**
1036  * Escapes the given text so that it may be output using addWikiText()
1037  * without any linking, formatting, etc. making its way through. This
1038  * is achieved by substituting certain characters with HTML entities.
1039  * As required by the callers, <nowiki> is not used. It currently does
1040  * not filter out characters which have special meaning only at the
1041  * start of a line, such as "*".
1042  *
1043  * @param string $text Text to be escaped
1044  */
1045 function wfEscapeWikiText( $text ) {
1046         $text = str_replace(
1047                 array( '[',     '|',      ']',     '\'',    'ISBN ',     'RFC ',     '://',     "\n=",     '{{' ),
1048                 array( '&#91;', '&#124;', '&#93;', '&#39;', 'ISBN&#32;', 'RFC&#32;', '&#58;//', "\n&#61;", '&#123;&#123;' ),
1049                 htmlspecialchars($text) );
1050         return $text;
1051 }
1052
1053 /**
1054  * @todo document
1055  */
1056 function wfQuotedPrintable( $string, $charset = '' ) {
1057         # Probably incomplete; see RFC 2045
1058         if( empty( $charset ) ) {
1059                 global $wgInputEncoding;
1060                 $charset = $wgInputEncoding;
1061         }
1062         $charset = strtoupper( $charset );
1063         $charset = str_replace( 'ISO-8859', 'ISO8859', $charset ); // ?
1064
1065         $illegal = '\x00-\x08\x0b\x0c\x0e-\x1f\x7f-\xff=';
1066         $replace = $illegal . '\t ?_';
1067         if( !preg_match( "/[$illegal]/", $string ) ) return $string;
1068         $out = "=?$charset?Q?";
1069         $out .= preg_replace( "/([$replace])/e", 'sprintf("=%02X",ord("$1"))', $string );
1070         $out .= '?=';
1071         return $out;
1072 }
1073
1074
1075 /**
1076  * @todo document
1077  * @return float
1078  */
1079 function wfTime() {
1080         return microtime(true);
1081 }
1082
1083 /**
1084  * Sets dest to source and returns the original value of dest
1085  * If source is NULL, it just returns the value, it doesn't set the variable
1086  */
1087 function wfSetVar( &$dest, $source ) {
1088         $temp = $dest;
1089         if ( !is_null( $source ) ) {
1090                 $dest = $source;
1091         }
1092         return $temp;
1093 }
1094
1095 /**
1096  * As for wfSetVar except setting a bit
1097  */
1098 function wfSetBit( &$dest, $bit, $state = true ) {
1099         $temp = (bool)($dest & $bit );
1100         if ( !is_null( $state ) ) {
1101                 if ( $state ) {
1102                         $dest |= $bit;
1103                 } else {
1104                         $dest &= ~$bit;
1105                 }
1106         }
1107         return $temp;
1108 }
1109
1110 /**
1111  * This function takes two arrays as input, and returns a CGI-style string, e.g.
1112  * "days=7&limit=100". Options in the first array override options in the second.
1113  * Options set to "" will not be output.
1114  */
1115 function wfArrayToCGI( $array1, $array2 = NULL )
1116 {
1117         if ( !is_null( $array2 ) ) {
1118                 $array1 = $array1 + $array2;
1119         }
1120
1121         $cgi = '';
1122         foreach ( $array1 as $key => $value ) {
1123                 if ( '' !== $value ) {
1124                         if ( '' != $cgi ) {
1125                                 $cgi .= '&';
1126                         }
1127                         if(is_array($value))
1128                         {
1129                                 $firstTime = true;
1130                                 foreach($value as $v)
1131                                 {
1132                                         $cgi .= ($firstTime ? '' : '&') .
1133                                                 urlencode( $key . '[]' ) . '=' .
1134                                                 urlencode( $v );
1135                                         $firstTime = false;
1136                                 }
1137                         }
1138                         else
1139                                 $cgi .= urlencode( $key ) . '=' .
1140                                         urlencode( $value );
1141                 }
1142         }
1143         return $cgi;
1144 }
1145
1146 /**
1147  * This is the logical opposite of wfArrayToCGI(): it accepts a query string as
1148  * its argument and returns the same string in array form.  This allows compa-
1149  * tibility with legacy functions that accept raw query strings instead of nice
1150  * arrays.  Of course, keys and values are urldecode()d.  Don't try passing in-
1151  * valid query strings, or it will explode.
1152  *
1153  * @param $query string Query string
1154  * @return array Array version of input
1155  */
1156 function wfCgiToArray( $query ) {
1157         if( isset( $query[0] ) and $query[0] == '?' ) {
1158                 $query = substr( $query, 1 );
1159         }
1160         $bits = explode( '&', $query );
1161         $ret = array();
1162         foreach( $bits as $bit ) {
1163                 if( $bit === '' ) {
1164                         continue;
1165                 }
1166                 list( $key, $value ) = explode( '=', $bit );
1167                 $key = urldecode( $key );
1168                 $value = urldecode( $value );
1169                 $ret[$key] = $value;
1170         }
1171         return $ret;
1172 }
1173
1174 /**
1175  * Append a query string to an existing URL, which may or may not already
1176  * have query string parameters already. If so, they will be combined.
1177  *
1178  * @param string $url
1179  * @param string $query
1180  * @return string
1181  */
1182 function wfAppendQuery( $url, $query ) {
1183         if( $query != '' ) {
1184                 if( false === strpos( $url, '?' ) ) {
1185                         $url .= '?';
1186                 } else {
1187                         $url .= '&';
1188                 }
1189                 $url .= $query;
1190         }
1191         return $url;
1192 }
1193
1194 /**
1195  * Expand a potentially local URL to a fully-qualified URL.
1196  * Assumes $wgServer is correct. :)
1197  * @param string $url, either fully-qualified or a local path + query
1198  * @return string Fully-qualified URL
1199  */
1200 function wfExpandUrl( $url ) {
1201         if( substr( $url, 0, 1 ) == '/' ) {
1202                 global $wgServer;
1203                 return $wgServer . $url;
1204         } else {
1205                 return $url;
1206         }
1207 }
1208
1209 /**
1210  * This is obsolete, use SquidUpdate::purge()
1211  * @deprecated
1212  */
1213 function wfPurgeSquidServers ($urlArr) {
1214         SquidUpdate::purge( $urlArr );
1215 }
1216
1217 /**
1218  * Windows-compatible version of escapeshellarg()
1219  * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
1220  * function puts single quotes in regardless of OS.
1221  *
1222  * Also fixes the locale problems on Linux in PHP 5.2.6+ (bug backported to
1223  * earlier distro releases of PHP)
1224  */
1225 function wfEscapeShellArg( ) {
1226         wfInitShellLocale();
1227
1228         $args = func_get_args();
1229         $first = true;
1230         $retVal = '';
1231         foreach ( $args as $arg ) {
1232                 if ( !$first ) {
1233                         $retVal .= ' ';
1234                 } else {
1235                         $first = false;
1236                 }
1237
1238                 if ( wfIsWindows() ) {
1239                         // Escaping for an MSVC-style command line parser
1240                         // Ref: http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
1241                         // Double the backslashes before any double quotes. Escape the double quotes.
1242                         $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE );
1243                         $arg = '';
1244                         $delim = false;
1245                         foreach ( $tokens as $token ) {
1246                                 if ( $delim ) {
1247                                         $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
1248                                 } else {
1249                                         $arg .= $token;
1250                                 }
1251                                 $delim = !$delim;
1252                         }
1253                         // Double the backslashes before the end of the string, because
1254                         // we will soon add a quote
1255                         $m = array();
1256                         if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
1257                                 $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
1258                         }
1259
1260                         // Add surrounding quotes
1261                         $retVal .= '"' . $arg . '"';
1262                 } else {
1263                         $retVal .= escapeshellarg( $arg );
1264                 }
1265         }
1266         return $retVal;
1267 }
1268
1269 /**
1270  * wfMerge attempts to merge differences between three texts.
1271  * Returns true for a clean merge and false for failure or a conflict.
1272  */
1273 function wfMerge( $old, $mine, $yours, &$result ){
1274         global $wgDiff3;
1275
1276         # This check may also protect against code injection in
1277         # case of broken installations.
1278         if( !$wgDiff3 || !file_exists( $wgDiff3 ) ) {
1279                 wfDebug( "diff3 not found\n" );
1280                 return false;
1281         }
1282
1283         # Make temporary files
1284         $td = wfTempDir();
1285         $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
1286         $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
1287         $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
1288
1289         fwrite( $oldtextFile, $old ); fclose( $oldtextFile );
1290         fwrite( $mytextFile, $mine ); fclose( $mytextFile );
1291         fwrite( $yourtextFile, $yours ); fclose( $yourtextFile );
1292
1293         # Check for a conflict
1294         $cmd = $wgDiff3 . ' -a --overlap-only ' .
1295           wfEscapeShellArg( $mytextName ) . ' ' .
1296           wfEscapeShellArg( $oldtextName ) . ' ' .
1297           wfEscapeShellArg( $yourtextName );
1298         $handle = popen( $cmd, 'r' );
1299
1300         if( fgets( $handle, 1024 ) ){
1301                 $conflict = true;
1302         } else {
1303                 $conflict = false;
1304         }
1305         pclose( $handle );
1306
1307         # Merge differences
1308         $cmd = $wgDiff3 . ' -a -e --merge ' .
1309           wfEscapeShellArg( $mytextName, $oldtextName, $yourtextName );
1310         $handle = popen( $cmd, 'r' );
1311         $result = '';
1312         do {
1313                 $data = fread( $handle, 8192 );
1314                 if ( strlen( $data ) == 0 ) {
1315                         break;
1316                 }
1317                 $result .= $data;
1318         } while ( true );
1319         pclose( $handle );
1320         unlink( $mytextName ); unlink( $oldtextName ); unlink( $yourtextName );
1321
1322         if ( $result === '' && $old !== '' && $conflict == false ) {
1323                 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
1324                 $conflict = true;
1325         }
1326         return ! $conflict;
1327 }
1328
1329 /**
1330  * Returns unified plain-text diff of two texts.
1331  * Useful for machine processing of diffs.
1332  * @param $before string The text before the changes.
1333  * @param $after string The text after the changes.
1334  * @param $params string Command-line options for the diff command.
1335  * @return string Unified diff of $before and $after
1336  */
1337 function wfDiff( $before, $after, $params = '-u' ) {
1338         global $wgDiff;
1339
1340         # This check may also protect against code injection in
1341         # case of broken installations.
1342         if( !file_exists( $wgDiff ) ){
1343                 wfDebug( "diff executable not found\n" );
1344                 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
1345                 $format = new UnifiedDiffFormatter();
1346                 return $format->format( $diffs );
1347         }
1348
1349         # Make temporary files
1350         $td = wfTempDir();
1351         $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
1352         $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
1353
1354         fwrite( $oldtextFile, $before ); fclose( $oldtextFile );
1355         fwrite( $newtextFile, $after ); fclose( $newtextFile );
1356
1357         // Get the diff of the two files
1358         $cmd = "$wgDiff " . $params . ' ' .wfEscapeShellArg( $oldtextName, $newtextName );
1359
1360         $h = popen( $cmd, 'r' );
1361
1362         $diff = '';
1363
1364         do {
1365                 $data = fread( $h, 8192 );
1366                 if ( strlen( $data ) == 0 ) {
1367                         break;
1368                 }
1369                 $diff .= $data;
1370         } while ( true );
1371
1372         // Clean up
1373         pclose( $h );
1374         unlink( $oldtextName );
1375         unlink( $newtextName );
1376
1377         // Kill the --- and +++ lines. They're not useful.
1378         $diff_lines = explode( "\n", $diff );
1379         if (strpos( $diff_lines[0], '---' ) === 0) {
1380                 unset($diff_lines[0]);
1381         }
1382         if (strpos( $diff_lines[1], '+++' ) === 0) {
1383                 unset($diff_lines[1]);
1384         }
1385
1386         $diff = implode( "\n", $diff_lines );
1387
1388         return $diff;
1389 }
1390
1391 /**
1392  * A wrapper around the PHP function var_export().
1393  * Either print it or add it to the regular output ($wgOut).
1394  *
1395  * @param $var A PHP variable to dump.
1396  */
1397 function wfVarDump( $var ) {
1398         global $wgOut;
1399         $s = str_replace("\n","<br />\n", var_export( $var, true ) . "\n");
1400         if ( headers_sent() || !@is_object( $wgOut ) ) {
1401                 print $s;
1402         } else {
1403                 $wgOut->addHTML( $s );
1404         }
1405 }
1406
1407 /**
1408  * Provide a simple HTTP error.
1409  */
1410 function wfHttpError( $code, $label, $desc ) {
1411         global $wgOut;
1412         $wgOut->disable();
1413         header( "HTTP/1.0 $code $label" );
1414         header( "Status: $code $label" );
1415         $wgOut->sendCacheControl();
1416
1417         header( 'Content-type: text/html; charset=utf-8' );
1418         print "<!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML 2.0//EN\">".
1419                 "<html><head><title>" .
1420                 htmlspecialchars( $label ) .
1421                 "</title></head><body><h1>" .
1422                 htmlspecialchars( $label ) .
1423                 "</h1><p>" .
1424                 nl2br( htmlspecialchars( $desc ) ) .
1425                 "</p></body></html>\n";
1426 }
1427
1428 /**
1429  * Clear away any user-level output buffers, discarding contents.
1430  *
1431  * Suitable for 'starting afresh', for instance when streaming
1432  * relatively large amounts of data without buffering, or wanting to
1433  * output image files without ob_gzhandler's compression.
1434  *
1435  * The optional $resetGzipEncoding parameter controls suppression of
1436  * the Content-Encoding header sent by ob_gzhandler; by default it
1437  * is left. See comments for wfClearOutputBuffers() for why it would
1438  * be used.
1439  *
1440  * Note that some PHP configuration options may add output buffer
1441  * layers which cannot be removed; these are left in place.
1442  *
1443  * @param bool $resetGzipEncoding
1444  */
1445 function wfResetOutputBuffers( $resetGzipEncoding=true ) {
1446         if( $resetGzipEncoding ) {
1447                 // Suppress Content-Encoding and Content-Length
1448                 // headers from 1.10+s wfOutputHandler
1449                 global $wgDisableOutputCompression;
1450                 $wgDisableOutputCompression = true;
1451         }
1452         while( $status = ob_get_status() ) {
1453                 if( $status['type'] == 0 /* PHP_OUTPUT_HANDLER_INTERNAL */ ) {
1454                         // Probably from zlib.output_compression or other
1455                         // PHP-internal setting which can't be removed.
1456                         //
1457                         // Give up, and hope the result doesn't break
1458                         // output behavior.
1459                         break;
1460                 }
1461                 if( !ob_end_clean() ) {
1462                         // Could not remove output buffer handler; abort now
1463                         // to avoid getting in some kind of infinite loop.
1464                         break;
1465                 }
1466                 if( $resetGzipEncoding ) {
1467                         if( $status['name'] == 'ob_gzhandler' ) {
1468                                 // Reset the 'Content-Encoding' field set by this handler
1469                                 // so we can start fresh.
1470                                 header( 'Content-Encoding:' );
1471                                 break;
1472                         }
1473                 }
1474         }
1475 }
1476
1477 /**
1478  * More legible than passing a 'false' parameter to wfResetOutputBuffers():
1479  *
1480  * Clear away output buffers, but keep the Content-Encoding header
1481  * produced by ob_gzhandler, if any.
1482  *
1483  * This should be used for HTTP 304 responses, where you need to
1484  * preserve the Content-Encoding header of the real result, but
1485  * also need to suppress the output of ob_gzhandler to keep to spec
1486  * and avoid breaking Firefox in rare cases where the headers and
1487  * body are broken over two packets.
1488  */
1489 function wfClearOutputBuffers() {
1490         wfResetOutputBuffers( false );
1491 }
1492
1493 /**
1494  * Converts an Accept-* header into an array mapping string values to quality
1495  * factors
1496  */
1497 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
1498         # No arg means accept anything (per HTTP spec)
1499         if( !$accept ) {
1500                 return array( $def => 1.0 );
1501         }
1502
1503         $prefs = array();
1504
1505         $parts = explode( ',', $accept );
1506
1507         foreach( $parts as $part ) {
1508                 # FIXME: doesn't deal with params like 'text/html; level=1'
1509                 @list( $value, $qpart ) = explode( ';', trim( $part ) );
1510                 $match = array();
1511                 if( !isset( $qpart ) ) {
1512                         $prefs[$value] = 1.0;
1513                 } elseif( preg_match( '/q\s*=\s*(\d*\.\d+)/', $qpart, $match ) ) {
1514                         $prefs[$value] = floatval($match[1]);
1515                 }
1516         }
1517
1518         return $prefs;
1519 }
1520
1521 /**
1522  * Checks if a given MIME type matches any of the keys in the given
1523  * array. Basic wildcards are accepted in the array keys.
1524  *
1525  * Returns the matching MIME type (or wildcard) if a match, otherwise
1526  * NULL if no match.
1527  *
1528  * @param string $type
1529  * @param array $avail
1530  * @return string
1531  * @private
1532  */
1533 function mimeTypeMatch( $type, $avail ) {
1534         if( array_key_exists($type, $avail) ) {
1535                 return $type;
1536         } else {
1537                 $parts = explode( '/', $type );
1538                 if( array_key_exists( $parts[0] . '/*', $avail ) ) {
1539                         return $parts[0] . '/*';
1540                 } elseif( array_key_exists( '*/*', $avail ) ) {
1541                         return '*/*';
1542                 } else {
1543                         return NULL;
1544                 }
1545         }
1546 }
1547
1548 /**
1549  * Returns the 'best' match between a client's requested internet media types
1550  * and the server's list of available types. Each list should be an associative
1551  * array of type to preference (preference is a float between 0.0 and 1.0).
1552  * Wildcards in the types are acceptable.
1553  *
1554  * @param array $cprefs Client's acceptable type list
1555  * @param array $sprefs Server's offered types
1556  * @return string
1557  *
1558  * @todo FIXME: doesn't handle params like 'text/plain; charset=UTF-8'
1559  * XXX: generalize to negotiate other stuff
1560  */
1561 function wfNegotiateType( $cprefs, $sprefs ) {
1562         $combine = array();
1563
1564         foreach( array_keys($sprefs) as $type ) {
1565                 $parts = explode( '/', $type );
1566                 if( $parts[1] != '*' ) {
1567                         $ckey = mimeTypeMatch( $type, $cprefs );
1568                         if( $ckey ) {
1569                                 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1570                         }
1571                 }
1572         }
1573
1574         foreach( array_keys( $cprefs ) as $type ) {
1575                 $parts = explode( '/', $type );
1576                 if( $parts[1] != '*' && !array_key_exists( $type, $sprefs ) ) {
1577                         $skey = mimeTypeMatch( $type, $sprefs );
1578                         if( $skey ) {
1579                                 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1580                         }
1581                 }
1582         }
1583
1584         $bestq = 0;
1585         $besttype = NULL;
1586
1587         foreach( array_keys( $combine ) as $type ) {
1588                 if( $combine[$type] > $bestq ) {
1589                         $besttype = $type;
1590                         $bestq = $combine[$type];
1591                 }
1592         }
1593
1594         return $besttype;
1595 }
1596
1597 /**
1598  * Array lookup
1599  * Returns an array where the values in the first array are replaced by the
1600  * values in the second array with the corresponding keys
1601  *
1602  * @return array
1603  */
1604 function wfArrayLookup( $a, $b ) {
1605         return array_flip( array_intersect( array_flip( $a ), array_keys( $b ) ) );
1606 }
1607
1608 /**
1609  * Convenience function; returns MediaWiki timestamp for the present time.
1610  * @return string
1611  */
1612 function wfTimestampNow() {
1613         # return NOW
1614         return wfTimestamp( TS_MW, time() );
1615 }
1616
1617 /**
1618  * Reference-counted warning suppression
1619  */
1620 function wfSuppressWarnings( $end = false ) {
1621         static $suppressCount = 0;
1622         static $originalLevel = false;
1623
1624         if ( $end ) {
1625                 if ( $suppressCount ) {
1626                         --$suppressCount;
1627                         if ( !$suppressCount ) {
1628                                 error_reporting( $originalLevel );
1629                         }
1630                 }
1631         } else {
1632                 if ( !$suppressCount ) {
1633                         $originalLevel = error_reporting( E_ALL & ~( E_WARNING | E_NOTICE ) );
1634                 }
1635                 ++$suppressCount;
1636         }
1637 }
1638
1639 /**
1640  * Restore error level to previous value
1641  */
1642 function wfRestoreWarnings() {
1643         wfSuppressWarnings( true );
1644 }
1645
1646 # Autodetect, convert and provide timestamps of various types
1647
1648 /**
1649  * Unix time - the number of seconds since 1970-01-01 00:00:00 UTC
1650  */
1651 define('TS_UNIX', 0);
1652
1653 /**
1654  * MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
1655  */
1656 define('TS_MW', 1);
1657
1658 /**
1659  * MySQL DATETIME (YYYY-MM-DD HH:MM:SS)
1660  */
1661 define('TS_DB', 2);
1662
1663 /**
1664  * RFC 2822 format, for E-mail and HTTP headers
1665  */
1666 define('TS_RFC2822', 3);
1667
1668 /**
1669  * ISO 8601 format with no timezone: 1986-02-09T20:00:00Z
1670  *
1671  * This is used by Special:Export
1672  */
1673 define('TS_ISO_8601', 4);
1674
1675 /**
1676  * An Exif timestamp (YYYY:MM:DD HH:MM:SS)
1677  *
1678  * @see http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the
1679  *       DateTime tag and page 36 for the DateTimeOriginal and
1680  *       DateTimeDigitized tags.
1681  */
1682 define('TS_EXIF', 5);
1683
1684 /**
1685  * Oracle format time.
1686  */
1687 define('TS_ORACLE', 6);
1688
1689 /**
1690  * Postgres format time.
1691  */
1692 define('TS_POSTGRES', 7);
1693
1694 /**
1695  * @param mixed $outputtype A timestamp in one of the supported formats, the
1696  *                          function will autodetect which format is supplied
1697  *                          and act accordingly.
1698  * @return string Time in the format specified in $outputtype
1699  */
1700 function wfTimestamp($outputtype=TS_UNIX,$ts=0) {
1701         $uts = 0;
1702         $da = array();
1703         if ($ts==0) {
1704                 $uts=time();
1705         } elseif (preg_match('/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)$/D',$ts,$da)) {
1706                 # TS_DB
1707         } elseif (preg_match('/^(\d{4}):(\d\d):(\d\d) (\d\d):(\d\d):(\d\d)$/D',$ts,$da)) {
1708                 # TS_EXIF
1709         } elseif (preg_match('/^(\d{4})(\d\d)(\d\d)(\d\d)(\d\d)(\d\d)$/D',$ts,$da)) {
1710                 # TS_MW
1711         } elseif (preg_match('/^\d{1,13}$/D',$ts)) {
1712                 # TS_UNIX
1713                 $uts = $ts;
1714         } elseif (preg_match('/^\d{1,2}-...-\d\d(?:\d\d)? \d\d\.\d\d\.\d\d/', $ts)) {
1715                 # TS_ORACLE
1716                 $uts = strtotime(preg_replace('/(\d\d)\.(\d\d)\.(\d\d)(\.(\d+))?/', "$1:$2:$3",
1717                                 str_replace("+00:00", "UTC", $ts)));
1718         } elseif (preg_match('/^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})(?:\.*\d*)?Z$/', $ts, $da)) {
1719                 # TS_ISO_8601
1720         } elseif (preg_match('/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)\.*\d*[\+\- ](\d\d)$/',$ts,$da)) {
1721                 # TS_POSTGRES
1722         } elseif (preg_match('/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)\.*\d* GMT$/',$ts,$da)) {
1723                 # TS_POSTGRES
1724         } else {
1725                 # Bogus value; fall back to the epoch...
1726                 wfDebug("wfTimestamp() fed bogus time value: $outputtype; $ts\n");
1727                 $uts = 0;
1728         }
1729
1730         if (count( $da ) ) {
1731                 // Warning! gmmktime() acts oddly if the month or day is set to 0
1732                 // We may want to handle that explicitly at some point
1733                 $uts=gmmktime((int)$da[4],(int)$da[5],(int)$da[6],
1734                         (int)$da[2],(int)$da[3],(int)$da[1]);
1735         }
1736
1737         switch($outputtype) {
1738                 case TS_UNIX:
1739                         return $uts;
1740                 case TS_MW:
1741                         return gmdate( 'YmdHis', $uts );
1742                 case TS_DB:
1743                         return gmdate( 'Y-m-d H:i:s', $uts );
1744                 case TS_ISO_8601:
1745                         return gmdate( 'Y-m-d\TH:i:s\Z', $uts );
1746                 // This shouldn't ever be used, but is included for completeness
1747                 case TS_EXIF:
1748                         return gmdate(  'Y:m:d H:i:s', $uts );
1749                 case TS_RFC2822:
1750                         return gmdate( 'D, d M Y H:i:s', $uts ) . ' GMT';
1751                 case TS_ORACLE:
1752                         return gmdate( 'd-M-y h.i.s A', $uts) . ' +00:00';
1753                 case TS_POSTGRES:
1754                         return gmdate( 'Y-m-d H:i:s', $uts) . ' GMT';
1755                 default:
1756                         throw new MWException( 'wfTimestamp() called with illegal output type.');
1757         }
1758 }
1759
1760 /**
1761  * Return a formatted timestamp, or null if input is null.
1762  * For dealing with nullable timestamp columns in the database.
1763  * @param int $outputtype
1764  * @param string $ts
1765  * @return string
1766  */
1767 function wfTimestampOrNull( $outputtype = TS_UNIX, $ts = null ) {
1768         if( is_null( $ts ) ) {
1769                 return null;
1770         } else {
1771                 return wfTimestamp( $outputtype, $ts );
1772         }
1773 }
1774
1775 /**
1776  * Check if the operating system is Windows
1777  *
1778  * @return bool True if it's Windows, False otherwise.
1779  */
1780 function wfIsWindows() {
1781         if (substr(php_uname(), 0, 7) == 'Windows') {
1782                 return true;
1783         } else {
1784                 return false;
1785         }
1786 }
1787
1788 /**
1789  * Swap two variables
1790  */
1791 function swap( &$x, &$y ) {
1792         $z = $x;
1793         $x = $y;
1794         $y = $z;
1795 }
1796
1797 function wfGetCachedNotice( $name ) {
1798         global $wgOut, $wgRenderHashAppend, $parserMemc;
1799         $fname = 'wfGetCachedNotice';
1800         wfProfileIn( $fname );
1801
1802         $needParse = false;
1803
1804         if( $name === 'default' ) {
1805                 // special case
1806                 global $wgSiteNotice;
1807                 $notice = $wgSiteNotice;
1808                 if( empty( $notice ) ) {
1809                         wfProfileOut( $fname );
1810                         return false;
1811                 }
1812         } else {
1813                 $notice = wfMsgForContentNoTrans( $name );
1814                 if( wfEmptyMsg( $name, $notice ) || $notice == '-' ) {
1815                         wfProfileOut( $fname );
1816                         return( false );
1817                 }
1818         }
1819
1820         // Use the extra hash appender to let eg SSL variants separately cache.
1821         $key = wfMemcKey( $name . $wgRenderHashAppend );
1822         $cachedNotice = $parserMemc->get( $key );
1823         if( is_array( $cachedNotice ) ) {
1824                 if( md5( $notice ) == $cachedNotice['hash'] ) {
1825                         $notice = $cachedNotice['html'];
1826                 } else {
1827                         $needParse = true;
1828                 }
1829         } else {
1830                 $needParse = true;
1831         }
1832
1833         if( $needParse ) {
1834                 if( is_object( $wgOut ) ) {
1835                         $parsed = $wgOut->parse( $notice );
1836                         $parserMemc->set( $key, array( 'html' => $parsed, 'hash' => md5( $notice ) ), 600 );
1837                         $notice = $parsed;
1838                 } else {
1839                         wfDebug( 'wfGetCachedNotice called for ' . $name . ' with no $wgOut available' );
1840                         $notice = '';
1841                 }
1842         }
1843
1844         wfProfileOut( $fname );
1845         return $notice;
1846 }
1847
1848 function wfGetNamespaceNotice() {
1849         global $wgTitle;
1850
1851         # Paranoia
1852         if ( !isset( $wgTitle ) || !is_object( $wgTitle ) )
1853                 return "";
1854
1855         $fname = 'wfGetNamespaceNotice';
1856         wfProfileIn( $fname );
1857
1858         $key = "namespacenotice-" . $wgTitle->getNsText();
1859         $namespaceNotice = wfGetCachedNotice( $key );
1860         if ( $namespaceNotice && substr ( $namespaceNotice , 0 ,7 ) != "<p>&lt;" ) {
1861                  $namespaceNotice = '<div id="namespacebanner">' . $namespaceNotice . "</div>";
1862         } else {
1863                 $namespaceNotice = "";
1864         }
1865
1866         wfProfileOut( $fname );
1867         return $namespaceNotice;
1868 }
1869
1870 function wfGetSiteNotice() {
1871         global $wgUser, $wgSiteNotice;
1872         $fname = 'wfGetSiteNotice';
1873         wfProfileIn( $fname );
1874         $siteNotice = '';
1875
1876         if( wfRunHooks( 'SiteNoticeBefore', array( &$siteNotice ) ) ) {
1877                 if( is_object( $wgUser ) && $wgUser->isLoggedIn() ) {
1878                         $siteNotice = wfGetCachedNotice( 'sitenotice' );
1879                 } else {
1880                         $anonNotice = wfGetCachedNotice( 'anonnotice' );
1881                         if( !$anonNotice ) {
1882                                 $siteNotice = wfGetCachedNotice( 'sitenotice' );
1883                         } else {
1884                                 $siteNotice = $anonNotice;
1885                         }
1886                 }
1887                 if( !$siteNotice ) {
1888                         $siteNotice = wfGetCachedNotice( 'default' );
1889                 }
1890         }
1891
1892         wfRunHooks( 'SiteNoticeAfter', array( &$siteNotice ) );
1893         wfProfileOut( $fname );
1894         return $siteNotice;
1895 }
1896
1897 /**
1898  * BC wrapper for MimeMagic::singleton()
1899  * @deprecated
1900  */
1901 function &wfGetMimeMagic() {
1902         return MimeMagic::singleton();
1903 }
1904
1905 /**
1906  * Tries to get the system directory for temporary files.
1907  * The TMPDIR, TMP, and TEMP environment variables are checked in sequence,
1908  * and if none are set /tmp is returned as the generic Unix default.
1909  *
1910  * NOTE: When possible, use the tempfile() function to create temporary
1911  * files to avoid race conditions on file creation, etc.
1912  *
1913  * @return string
1914  */
1915 function wfTempDir() {
1916         foreach( array( 'TMPDIR', 'TMP', 'TEMP' ) as $var ) {
1917                 $tmp = getenv( $var );
1918                 if( $tmp && file_exists( $tmp ) && is_dir( $tmp ) && is_writable( $tmp ) ) {
1919                         return $tmp;
1920                 }
1921         }
1922         # Hope this is Unix of some kind!
1923         return '/tmp';
1924 }
1925
1926 /**
1927  * Make directory, and make all parent directories if they don't exist
1928  *
1929  * @param string $fullDir Full path to directory to create
1930  * @param int $mode Chmod value to use, default is $wgDirectoryMode
1931  * @return bool
1932  */
1933 function wfMkdirParents( $fullDir, $mode = null ) {
1934         global $wgDirectoryMode;
1935         if( strval( $fullDir ) === '' )
1936                 return true;
1937         if( file_exists( $fullDir ) )
1938                 return true;
1939         // If not defined or isn't an int, set to default
1940         if ( is_null( $mode ) ) {
1941                 $mode = $wgDirectoryMode;
1942         }
1943
1944
1945         # Go back through the paths to find the first directory that exists
1946         $currentDir = $fullDir;
1947         $createList = array();
1948         while ( strval( $currentDir ) !== '' && !file_exists( $currentDir ) ) {
1949                 # Strip trailing slashes
1950                 $currentDir = rtrim( $currentDir, '/\\' );
1951
1952                 # Add to create list
1953                 $createList[] = $currentDir;
1954
1955                 # Find next delimiter searching from the end
1956                 $p = max( strrpos( $currentDir, '/' ), strrpos( $currentDir, '\\' ) );
1957                 if ( $p === false ) {
1958                         $currentDir = false;
1959                 } else {
1960                         $currentDir = substr( $currentDir, 0, $p );
1961                 }
1962         }
1963
1964         if ( count( $createList ) == 0 ) {
1965                 # Directory specified already exists
1966                 return true;
1967         } elseif ( $currentDir === false ) {
1968                 # Went all the way back to root and it apparently doesn't exist
1969                 wfDebugLog( 'mkdir', "Root doesn't exist?\n" );
1970                 return false;
1971         }
1972         # Now go forward creating directories
1973         $createList = array_reverse( $createList );
1974
1975         # Is the parent directory writable?
1976         if ( $currentDir === '' ) {
1977                 $currentDir = '/';
1978         }
1979         if ( !is_writable( $currentDir ) ) {
1980                 wfDebugLog( 'mkdir', "Not writable: $currentDir\n" );
1981                 return false;
1982         }
1983
1984         foreach ( $createList as $dir ) {
1985                 # use chmod to override the umask, as suggested by the PHP manual
1986                 if ( !mkdir( $dir, $mode ) || !chmod( $dir, $mode ) ) {
1987                         wfDebugLog( 'mkdir', "Unable to create directory $dir\n" );
1988                         return false;
1989                 }
1990         }
1991         return true;
1992 }
1993
1994 /**
1995  * Increment a statistics counter
1996  */
1997 function wfIncrStats( $key ) {
1998         global $wgStatsMethod;
1999
2000         if( $wgStatsMethod == 'udp' ) {
2001                 global $wgUDPProfilerHost, $wgUDPProfilerPort, $wgDBname;
2002                 static $socket;
2003                 if (!$socket) {
2004                         $socket=socket_create(AF_INET, SOCK_DGRAM, SOL_UDP);
2005                         $statline="stats/{$wgDBname} - 1 1 1 1 1 -total\n";
2006                         socket_sendto($socket,$statline,strlen($statline),0,$wgUDPProfilerHost,$wgUDPProfilerPort);
2007                 }
2008                 $statline="stats/{$wgDBname} - 1 1 1 1 1 {$key}\n";
2009                 @socket_sendto($socket,$statline,strlen($statline),0,$wgUDPProfilerHost,$wgUDPProfilerPort);
2010         } elseif( $wgStatsMethod == 'cache' ) {
2011                 global $wgMemc;
2012                 $key = wfMemcKey( 'stats', $key );
2013                 if ( is_null( $wgMemc->incr( $key ) ) ) {
2014                         $wgMemc->add( $key, 1 );
2015                 }
2016         } else {
2017                 // Disabled
2018         }
2019 }
2020
2021 /**
2022  * @param mixed $nr The number to format
2023  * @param int $acc The number of digits after the decimal point, default 2
2024  * @param bool $round Whether or not to round the value, default true
2025  * @return float
2026  */
2027 function wfPercent( $nr, $acc = 2, $round = true ) {
2028         $ret = sprintf( "%.${acc}f", $nr );
2029         return $round ? round( $ret, $acc ) . '%' : "$ret%";
2030 }
2031
2032 /**
2033  * Encrypt a username/password.
2034  *
2035  * @param string $userid ID of the user
2036  * @param string $password Password of the user
2037  * @return string Hashed password
2038  * @deprecated Use User::crypt() or User::oldCrypt() instead
2039  */
2040 function wfEncryptPassword( $userid, $password ) {
2041         wfDeprecated(__FUNCTION__);
2042         # Just wrap around User::oldCrypt()
2043         return User::oldCrypt($password, $userid);
2044 }
2045
2046 /**
2047  * Appends to second array if $value differs from that in $default
2048  */
2049 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
2050         if ( is_null( $changed ) ) {
2051                 throw new MWException('GlobalFunctions::wfAppendToArrayIfNotDefault got null');
2052         }
2053         if ( $default[$key] !== $value ) {
2054                 $changed[$key] = $value;
2055         }
2056 }
2057
2058 /**
2059  * Since wfMsg() and co suck, they don't return false if the message key they
2060  * looked up didn't exist but a XHTML string, this function checks for the
2061  * nonexistance of messages by looking at wfMsg() output
2062  *
2063  * @param $msg      The message key looked up
2064  * @param $wfMsgOut The output of wfMsg*()
2065  * @return bool
2066  */
2067 function wfEmptyMsg( $msg, $wfMsgOut ) {
2068         return $wfMsgOut === htmlspecialchars( "<$msg>" );
2069 }
2070
2071 /**
2072  * Find out whether or not a mixed variable exists in a string
2073  *
2074  * @param mixed  needle
2075  * @param string haystack
2076  * @return bool
2077  */
2078 function in_string( $needle, $str ) {
2079         return strpos( $str, $needle ) !== false;
2080 }
2081
2082 function wfSpecialList( $page, $details ) {
2083         global $wgContLang;
2084         $details = $details ? ' ' . $wgContLang->getDirMark() . "($details)" : "";
2085         return $page . $details;
2086 }
2087
2088 /**
2089  * Returns a regular expression of url protocols
2090  *
2091  * @return string
2092  */
2093 function wfUrlProtocols() {
2094         global $wgUrlProtocols;
2095
2096         // Support old-style $wgUrlProtocols strings, for backwards compatibility
2097         // with LocalSettings files from 1.5
2098         if ( is_array( $wgUrlProtocols ) ) {
2099                 $protocols = array();
2100                 foreach ($wgUrlProtocols as $protocol)
2101                         $protocols[] = preg_quote( $protocol, '/' );
2102
2103                 return implode( '|', $protocols );
2104         } else {
2105                 return $wgUrlProtocols;
2106         }
2107 }
2108
2109 /**
2110  * Safety wrapper around ini_get() for boolean settings.
2111  * The values returned from ini_get() are pre-normalized for settings
2112  * set via php.ini or php_flag/php_admin_flag... but *not*
2113  * for those set via php_value/php_admin_value.
2114  *
2115  * It's fairly common for people to use php_value instead of php_flag,
2116  * which can leave you with an 'off' setting giving a false positive
2117  * for code that just takes the ini_get() return value as a boolean.
2118  *
2119  * To make things extra interesting, setting via php_value accepts
2120  * "true" and "yes" as true, but php.ini and php_flag consider them false. :)
2121  * Unrecognized values go false... again opposite PHP's own coercion
2122  * from string to bool.
2123  *
2124  * Luckily, 'properly' set settings will always come back as '0' or '1',
2125  * so we only have to worry about them and the 'improper' settings.
2126  *
2127  * I frickin' hate PHP... :P
2128  *
2129  * @param string $setting
2130  * @return bool
2131  */
2132 function wfIniGetBool( $setting ) {
2133         $val = ini_get( $setting );
2134         // 'on' and 'true' can't have whitespace around them, but '1' can.
2135         return strtolower( $val ) == 'on'
2136                 || strtolower( $val ) == 'true'
2137                 || strtolower( $val ) == 'yes'
2138                 || preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2139 }
2140
2141 /**
2142  * Execute a shell command, with time and memory limits mirrored from the PHP
2143  * configuration if supported.
2144  * @param $cmd Command line, properly escaped for shell.
2145  * @param &$retval optional, will receive the program's exit code.
2146  *                 (non-zero is usually failure)
2147  * @return collected stdout as a string (trailing newlines stripped)
2148  */
2149 function wfShellExec( $cmd, &$retval=null ) {
2150         global $IP, $wgMaxShellMemory, $wgMaxShellFileSize, $wgMaxShellTime;
2151
2152         if( wfIniGetBool( 'safe_mode' ) ) {
2153                 wfDebug( "wfShellExec can't run in safe_mode, PHP's exec functions are too broken.\n" );
2154                 $retval = 1;
2155                 return "Unable to run external programs in safe mode.";
2156         }
2157         wfInitShellLocale();
2158
2159         if ( php_uname( 's' ) == 'Linux' ) {
2160                 $time = intval( $wgMaxShellTime );
2161                 $mem = intval( $wgMaxShellMemory );
2162                 $filesize = intval( $wgMaxShellFileSize );
2163
2164                 if ( $time > 0 && $mem > 0 ) {
2165                         $script = "$IP/bin/ulimit4.sh";
2166                         if ( is_executable( $script ) ) {
2167                                 $cmd = escapeshellarg( $script ) . " $time $mem $filesize " . escapeshellarg( $cmd );
2168                         }
2169                 }
2170         } elseif ( php_uname( 's' ) == 'Windows NT' ) {
2171                 # This is a hack to work around PHP's flawed invocation of cmd.exe
2172                 # http://news.php.net/php.internals/21796
2173                 $cmd = '"' . $cmd . '"';
2174         }
2175         wfDebug( "wfShellExec: $cmd\n" );
2176
2177         $retval = 1; // error by default?
2178         ob_start();
2179         passthru( $cmd, $retval );
2180         $output = ob_get_contents();
2181         ob_end_clean();
2182
2183         if ( $retval == 127 ) {
2184                 wfDebugLog( 'exec', "Possibly missing executable file: $cmd\n" );
2185         }
2186         return $output;
2187 }
2188
2189 /**
2190  * Workaround for http://bugs.php.net/bug.php?id=45132
2191  * escapeshellarg() destroys non-ASCII characters if LANG is not a UTF-8 locale
2192  */
2193 function wfInitShellLocale() {
2194         static $done = false;
2195         if ( $done ) return;
2196         $done = true;
2197         global $wgShellLocale;
2198         if ( !wfIniGetBool( 'safe_mode' ) ) {
2199                 putenv( "LC_CTYPE=$wgShellLocale" );
2200                 setlocale( LC_CTYPE, $wgShellLocale );
2201         }
2202 }
2203
2204 /**
2205  * This function works like "use VERSION" in Perl, the program will die with a
2206  * backtrace if the current version of PHP is less than the version provided
2207  *
2208  * This is useful for extensions which due to their nature are not kept in sync
2209  * with releases, and might depend on other versions of PHP than the main code
2210  *
2211  * Note: PHP might die due to parsing errors in some cases before it ever
2212  *       manages to call this function, such is life
2213  *
2214  * @see perldoc -f use
2215  *
2216  * @param mixed $version The version to check, can be a string, an integer, or
2217  *                       a float
2218  */
2219 function wfUsePHP( $req_ver ) {
2220         $php_ver = PHP_VERSION;
2221
2222         if ( version_compare( $php_ver, (string)$req_ver, '<' ) )
2223                  throw new MWException( "PHP $req_ver required--this is only $php_ver" );
2224 }
2225
2226 /**
2227  * This function works like "use VERSION" in Perl except it checks the version
2228  * of MediaWiki, the program will die with a backtrace if the current version
2229  * of MediaWiki is less than the version provided.
2230  *
2231  * This is useful for extensions which due to their nature are not kept in sync
2232  * with releases
2233  *
2234  * @see perldoc -f use
2235  *
2236  * @param mixed $version The version to check, can be a string, an integer, or
2237  *                       a float
2238  */
2239 function wfUseMW( $req_ver ) {
2240         global $wgVersion;
2241
2242         if ( version_compare( $wgVersion, (string)$req_ver, '<' ) )
2243                 throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
2244 }
2245
2246 /**
2247  * @deprecated use StringUtils::escapeRegexReplacement
2248  */
2249 function wfRegexReplacement( $string ) {
2250         return StringUtils::escapeRegexReplacement( $string );
2251 }
2252
2253 /**
2254  * Return the final portion of a pathname.
2255  * Reimplemented because PHP5's basename() is buggy with multibyte text.
2256  * http://bugs.php.net/bug.php?id=33898
2257  *
2258  * PHP's basename() only considers '\' a pathchar on Windows and Netware.
2259  * We'll consider it so always, as we don't want \s in our Unix paths either.
2260  *
2261  * @param string $path
2262  * @param string $suffix to remove if present
2263  * @return string
2264  */
2265 function wfBaseName( $path, $suffix='' ) {
2266         $encSuffix = ($suffix == '')
2267                 ? ''
2268                 : ( '(?:' . preg_quote( $suffix, '#' ) . ')?' );
2269         $matches = array();
2270         if( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
2271                 return $matches[1];
2272         } else {
2273                 return '';
2274         }
2275 }
2276
2277 /**
2278  * Generate a relative path name to the given file.
2279  * May explode on non-matching case-insensitive paths,
2280  * funky symlinks, etc.
2281  *
2282  * @param string $path Absolute destination path including target filename
2283  * @param string $from Absolute source path, directory only
2284  * @return string
2285  */
2286 function wfRelativePath( $path, $from ) {
2287         // Normalize mixed input on Windows...
2288         $path = str_replace( '/', DIRECTORY_SEPARATOR, $path );
2289         $from = str_replace( '/', DIRECTORY_SEPARATOR, $from );
2290
2291         // Trim trailing slashes -- fix for drive root
2292         $path = rtrim( $path, DIRECTORY_SEPARATOR );
2293         $from = rtrim( $from, DIRECTORY_SEPARATOR );
2294
2295         $pieces  = explode( DIRECTORY_SEPARATOR, dirname( $path ) );
2296         $against = explode( DIRECTORY_SEPARATOR, $from );
2297
2298         if( $pieces[0] !== $against[0] ) {
2299                 // Non-matching Windows drive letters?
2300                 // Return a full path.
2301                 return $path;
2302         }
2303
2304         // Trim off common prefix
2305         while( count( $pieces ) && count( $against )
2306                 && $pieces[0] == $against[0] ) {
2307                 array_shift( $pieces );
2308                 array_shift( $against );
2309         }
2310
2311         // relative dots to bump us to the parent
2312         while( count( $against ) ) {
2313                 array_unshift( $pieces, '..' );
2314                 array_shift( $against );
2315         }
2316
2317         array_push( $pieces, wfBaseName( $path ) );
2318
2319         return implode( DIRECTORY_SEPARATOR, $pieces );
2320 }
2321
2322 /**
2323  * array_merge() does awful things with "numeric" indexes, including
2324  * string indexes when happen to look like integers. When we want
2325  * to merge arrays with arbitrary string indexes, we don't want our
2326  * arrays to be randomly corrupted just because some of them consist
2327  * of numbers.
2328  *
2329  * Fuck you, PHP. Fuck you in the ear!
2330  *
2331  * @param array $array1, [$array2, [...]]
2332  * @return array
2333  */
2334 function wfArrayMerge( $array1/* ... */ ) {
2335         $out = $array1;
2336         for( $i = 1; $i < func_num_args(); $i++ ) {
2337                 foreach( func_get_arg( $i ) as $key => $value ) {
2338                         $out[$key] = $value;
2339                 }
2340         }
2341         return $out;
2342 }
2343
2344 /**
2345  * Make a URL index, appropriate for the el_index field of externallinks.
2346  */
2347 function wfMakeUrlIndex( $url ) {
2348         global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
2349         wfSuppressWarnings();
2350         $bits = parse_url( $url );
2351         wfRestoreWarnings();
2352         if ( !$bits ) {
2353                 return false;
2354         }
2355         // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
2356         $delimiter = '';
2357         if ( in_array( $bits['scheme'] . '://' , $wgUrlProtocols ) ) {
2358                 $delimiter = '://';
2359         } elseif ( in_array( $bits['scheme'] .':' , $wgUrlProtocols ) ) {
2360                 $delimiter = ':';
2361                 // parse_url detects for news: and mailto: the host part of an url as path
2362                 // We have to correct this wrong detection
2363                 if ( isset ( $bits['path'] ) ) {
2364                         $bits['host'] = $bits['path'];
2365                         $bits['path'] = '';
2366                 }
2367         } else {
2368                 return false;
2369         }
2370
2371         // Reverse the labels in the hostname, convert to lower case
2372         // For emails reverse domainpart only
2373         if ( $bits['scheme'] == 'mailto' ) {
2374                 $mailparts = explode( '@', $bits['host'], 2 );
2375                 if ( count($mailparts) === 2 ) {
2376                         $domainpart = strtolower( implode( '.', array_reverse( explode( '.', $mailparts[1] ) ) ) );
2377                 } else {
2378                         // No domain specified, don't mangle it
2379                         $domainpart = '';
2380                 }
2381                 $reversedHost = $domainpart . '@' . $mailparts[0];
2382         } else {
2383                 $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) );
2384         }
2385         // Add an extra dot to the end
2386         // Why? Is it in wrong place in mailto links?
2387         if ( substr( $reversedHost, -1, 1 ) !== '.' ) {
2388                 $reversedHost .= '.';
2389         }
2390         // Reconstruct the pseudo-URL
2391         $prot = $bits['scheme'];
2392         $index = "$prot$delimiter$reversedHost";
2393         // Leave out user and password. Add the port, path, query and fragment
2394         if ( isset( $bits['port'] ) )      $index .= ':' . $bits['port'];
2395         if ( isset( $bits['path'] ) ) {
2396                 $index .= $bits['path'];
2397         } else {
2398                 $index .= '/';
2399         }
2400         if ( isset( $bits['query'] ) )     $index .= '?' . $bits['query'];
2401         if ( isset( $bits['fragment'] ) )  $index .= '#' . $bits['fragment'];
2402         return $index;
2403 }
2404
2405 /**
2406  * Do any deferred updates and clear the list
2407  * TODO: This could be in Wiki.php if that class made any sense at all
2408  */
2409 function wfDoUpdates()
2410 {
2411         global $wgPostCommitUpdateList, $wgDeferredUpdateList;
2412         foreach ( $wgDeferredUpdateList as $update ) {
2413                 $update->doUpdate();
2414         }
2415         foreach ( $wgPostCommitUpdateList as $update ) {
2416                 $update->doUpdate();
2417         }
2418         $wgDeferredUpdateList = array();
2419         $wgPostCommitUpdateList = array();
2420 }
2421
2422 /**
2423  * @deprecated use StringUtils::explodeMarkup
2424  */
2425 function wfExplodeMarkup( $separator, $text ) {
2426         return StringUtils::explodeMarkup( $separator, $text );
2427 }
2428
2429 /**
2430  * Convert an arbitrarily-long digit string from one numeric base
2431  * to another, optionally zero-padding to a minimum column width.
2432  *
2433  * Supports base 2 through 36; digit values 10-36 are represented
2434  * as lowercase letters a-z. Input is case-insensitive.
2435  *
2436  * @param $input string of digits
2437  * @param $sourceBase int 2-36
2438  * @param $destBase int 2-36
2439  * @param $pad int 1 or greater
2440  * @param $lowercase bool
2441  * @return string or false on invalid input
2442  */
2443 function wfBaseConvert( $input, $sourceBase, $destBase, $pad=1, $lowercase=true ) {
2444         $input = strval( $input );
2445         if( $sourceBase < 2 ||
2446                 $sourceBase > 36 ||
2447                 $destBase < 2 ||
2448                 $destBase > 36 ||
2449                 $pad < 1 ||
2450                 $sourceBase != intval( $sourceBase ) ||
2451                 $destBase != intval( $destBase ) ||
2452                 $pad != intval( $pad ) ||
2453                 !is_string( $input ) ||
2454                 $input == '' ) {
2455                 return false;
2456         }
2457         $digitChars = ( $lowercase ) ?  '0123456789abcdefghijklmnopqrstuvwxyz' : '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ';
2458         $inDigits = array();
2459         $outChars = '';
2460
2461         // Decode and validate input string
2462         $input = strtolower( $input );
2463         for( $i = 0; $i < strlen( $input ); $i++ ) {
2464                 $n = strpos( $digitChars, $input{$i} );
2465                 if( $n === false || $n > $sourceBase ) {
2466                         return false;
2467                 }
2468                 $inDigits[] = $n;
2469         }
2470
2471         // Iterate over the input, modulo-ing out an output digit
2472         // at a time until input is gone.
2473         while( count( $inDigits ) ) {
2474                 $work = 0;
2475                 $workDigits = array();
2476
2477                 // Long division...
2478                 foreach( $inDigits as $digit ) {
2479                         $work *= $sourceBase;
2480                         $work += $digit;
2481
2482                         if( $work < $destBase ) {
2483                                 // Gonna need to pull another digit.
2484                                 if( count( $workDigits ) ) {
2485                                         // Avoid zero-padding; this lets us find
2486                                         // the end of the input very easily when
2487                                         // length drops to zero.
2488                                         $workDigits[] = 0;
2489                                 }
2490                         } else {
2491                                 // Finally! Actual division!
2492                                 $workDigits[] = intval( $work / $destBase );
2493
2494                                 // Isn't it annoying that most programming languages
2495                                 // don't have a single divide-and-remainder operator,
2496                                 // even though the CPU implements it that way?
2497                                 $work = $work % $destBase;
2498                         }
2499                 }
2500
2501                 // All that division leaves us with a remainder,
2502                 // which is conveniently our next output digit.
2503                 $outChars .= $digitChars[$work];
2504
2505                 // And we continue!
2506                 $inDigits = $workDigits;
2507         }
2508
2509         while( strlen( $outChars ) < $pad ) {
2510                 $outChars .= '0';
2511         }
2512
2513         return strrev( $outChars );
2514 }
2515
2516 /**
2517  * Create an object with a given name and an array of construct parameters
2518  * @param string $name
2519  * @param array $p parameters
2520  */
2521 function wfCreateObject( $name, $p ){
2522         $p = array_values( $p );
2523         switch ( count( $p ) ) {
2524                 case 0:
2525                         return new $name;
2526                 case 1:
2527                         return new $name( $p[0] );
2528                 case 2:
2529                         return new $name( $p[0], $p[1] );
2530                 case 3:
2531                         return new $name( $p[0], $p[1], $p[2] );
2532                 case 4:
2533                         return new $name( $p[0], $p[1], $p[2], $p[3] );
2534                 case 5:
2535                         return new $name( $p[0], $p[1], $p[2], $p[3], $p[4] );
2536                 case 6:
2537                         return new $name( $p[0], $p[1], $p[2], $p[3], $p[4], $p[5] );
2538                 default:
2539                         throw new MWException( "Too many arguments to construtor in wfCreateObject" );
2540         }
2541 }
2542
2543 /**
2544  * Alias for modularized function
2545  * @deprecated Use Http::get() instead
2546  */
2547 function wfGetHTTP( $url, $timeout = 'default' ) {
2548         wfDeprecated(__FUNCTION__);
2549         return Http::get( $url, $timeout );
2550 }
2551
2552 /**
2553  * Alias for modularized function
2554  * @deprecated Use Http::isLocalURL() instead
2555  */
2556 function wfIsLocalURL( $url ) {
2557         wfDeprecated(__FUNCTION__);
2558         return Http::isLocalURL( $url );
2559 }
2560
2561 function wfHttpOnlySafe() {
2562         global $wgHttpOnlyBlacklist;
2563         if( !version_compare("5.2", PHP_VERSION, "<") )
2564                 return false;
2565
2566         if( isset( $_SERVER['HTTP_USER_AGENT'] ) ) {
2567                 foreach( $wgHttpOnlyBlacklist as $regex ) {
2568                         if( preg_match( $regex, $_SERVER['HTTP_USER_AGENT'] ) ) {
2569                                 return false;
2570                         }
2571                 }
2572         }
2573
2574         return true;
2575 }
2576
2577 /**
2578  * Initialise php session
2579  */
2580 function wfSetupSession() {
2581         global $wgSessionsInMemcached, $wgCookiePath, $wgCookieDomain, $wgCookieSecure, $wgCookieHttpOnly;
2582         if( $wgSessionsInMemcached ) {
2583                 require_once( 'MemcachedSessions.php' );
2584         } elseif( 'files' != ini_get( 'session.save_handler' ) ) {
2585                 # If it's left on 'user' or another setting from another
2586                 # application, it will end up failing. Try to recover.
2587                 ini_set ( 'session.save_handler', 'files' );
2588         }
2589         $httpOnlySafe = wfHttpOnlySafe();
2590         wfDebugLog( 'cookie',
2591                 'session_set_cookie_params: "' . implode( '", "',
2592                         array(
2593                                 0,
2594                                 $wgCookiePath,
2595                                 $wgCookieDomain,
2596                                 $wgCookieSecure,
2597                                 $httpOnlySafe && $wgCookieHttpOnly ) ) . '"' );
2598         if( $httpOnlySafe && $wgCookieHttpOnly ) {
2599                 session_set_cookie_params( 0, $wgCookiePath, $wgCookieDomain, $wgCookieSecure, $wgCookieHttpOnly );
2600         } else {
2601                 // PHP 5.1 throws warnings if you pass the HttpOnly parameter for 5.2.
2602                 session_set_cookie_params( 0, $wgCookiePath, $wgCookieDomain, $wgCookieSecure );
2603         }
2604         session_cache_limiter( 'private, must-revalidate' );
2605         wfSuppressWarnings();
2606         session_start();
2607         wfRestoreWarnings();
2608 }
2609
2610 /**
2611  * Get an object from the precompiled serialized directory
2612  *
2613  * @return mixed The variable on success, false on failure
2614  */
2615 function wfGetPrecompiledData( $name ) {
2616         global $IP;
2617
2618         $file = "$IP/serialized/$name";
2619         if ( file_exists( $file ) ) {
2620                 $blob = file_get_contents( $file );
2621                 if ( $blob ) {
2622                         return unserialize( $blob );
2623                 }
2624         }
2625         return false;
2626 }
2627
2628 function wfGetCaller( $level = 2 ) {
2629         $backtrace = wfDebugBacktrace();
2630         if ( isset( $backtrace[$level] ) ) {
2631                 return wfFormatStackFrame($backtrace[$level]);
2632         } else {
2633                 $caller = 'unknown';
2634         }
2635         return $caller;
2636 }
2637
2638 /** Return a string consisting all callers in stack, somewhat useful sometimes for profiling specific points */
2639 function wfGetAllCallers() {
2640         return implode('/', array_map('wfFormatStackFrame',array_reverse(wfDebugBacktrace())));
2641 }
2642
2643 /** Return a string representation of frame */
2644 function wfFormatStackFrame($frame) {
2645         return isset( $frame["class"] )?
2646                 $frame["class"]."::".$frame["function"]:
2647                 $frame["function"];
2648 }
2649
2650 /**
2651  * Get a cache key
2652  */
2653 function wfMemcKey( /*... */ ) {
2654         $args = func_get_args();
2655         $key = wfWikiID() . ':' . implode( ':', $args );
2656         return $key;
2657 }
2658
2659 /**
2660  * Get a cache key for a foreign DB
2661  */
2662 function wfForeignMemcKey( $db, $prefix /*, ... */ ) {
2663         $args = array_slice( func_get_args(), 2 );
2664         if ( $prefix ) {
2665                 $key = "$db-$prefix:" . implode( ':', $args );
2666         } else {
2667                 $key = $db . ':' . implode( ':', $args );
2668         }
2669         return $key;
2670 }
2671
2672 /**
2673  * Get an ASCII string identifying this wiki
2674  * This is used as a prefix in memcached keys
2675  */
2676 function wfWikiID( $db = null ) {
2677         if( $db instanceof Database ) {
2678                 return $db->getWikiID();
2679         } else {
2680         global $wgDBprefix, $wgDBname;
2681                 if ( $wgDBprefix ) {
2682                         return "$wgDBname-$wgDBprefix";
2683                 } else {
2684                         return $wgDBname;
2685                 }
2686         }
2687 }
2688
2689 /**
2690  * Split a wiki ID into DB name and table prefix
2691  */
2692 function wfSplitWikiID( $wiki ) {
2693         $bits = explode( '-', $wiki, 2 );
2694         if ( count( $bits ) < 2 ) {
2695                 $bits[] = '';
2696         }
2697         return $bits;
2698 }
2699
2700 /*
2701  * Get a Database object.
2702  * @param integer $db Index of the connection to get. May be DB_MASTER for the
2703  *                master (for write queries), DB_SLAVE for potentially lagged
2704  *                read queries, or an integer >= 0 for a particular server.
2705  *
2706  * @param mixed $groups Query groups. An array of group names that this query
2707  *              belongs to. May contain a single string if the query is only
2708  *              in one group.
2709  *
2710  * @param string $wiki The wiki ID, or false for the current wiki
2711  *
2712  * Note: multiple calls to wfGetDB(DB_SLAVE) during the course of one request
2713  * will always return the same object, unless the underlying connection or load
2714  * balancer is manually destroyed.
2715  */
2716 function &wfGetDB( $db, $groups = array(), $wiki = false ) {
2717         return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
2718 }
2719
2720 /**
2721  * Get a load balancer object.
2722  *
2723  * @param array $groups List of query groups
2724  * @param string $wiki Wiki ID, or false for the current wiki
2725  * @return LoadBalancer
2726  */
2727 function wfGetLB( $wiki = false ) {
2728         return wfGetLBFactory()->getMainLB( $wiki );
2729 }
2730
2731 /**
2732  * Get the load balancer factory object
2733  */
2734 function &wfGetLBFactory() {
2735         return LBFactory::singleton();
2736 }
2737
2738 /**
2739  * Find a file.
2740  * Shortcut for RepoGroup::singleton()->findFile()
2741  * @param mixed $title Title object or string. May be interwiki.
2742  * @param mixed $time Requested time for an archived image, or false for the
2743  *                    current version. An image object will be returned which
2744  *                    was created at the specified time.
2745  * @param mixed $flags FileRepo::FIND_ flags
2746  * @return File, or false if the file does not exist
2747  */
2748 function wfFindFile( $title, $time = false, $flags = 0 ) {
2749         return RepoGroup::singleton()->findFile( $title, $time, $flags );
2750 }
2751
2752 /**
2753  * Get an object referring to a locally registered file.
2754  * Returns a valid placeholder object if the file does not exist.
2755  */
2756 function wfLocalFile( $title ) {
2757         return RepoGroup::singleton()->getLocalRepo()->newFile( $title );
2758 }
2759
2760 /**
2761  * Should low-performance queries be disabled?
2762  *
2763  * @return bool
2764  */
2765 function wfQueriesMustScale() {
2766         global $wgMiserMode;
2767         return $wgMiserMode
2768                 || ( SiteStats::pages() > 100000
2769                 && SiteStats::edits() > 1000000
2770                 && SiteStats::users() > 10000 );
2771 }
2772
2773 /**
2774  * Get the path to a specified script file, respecting file
2775  * extensions; this is a wrapper around $wgScriptExtension etc.
2776  *
2777  * @param string $script Script filename, sans extension
2778  * @return string
2779  */
2780 function wfScript( $script = 'index' ) {
2781         global $wgScriptPath, $wgScriptExtension;
2782         return "{$wgScriptPath}/{$script}{$wgScriptExtension}";
2783 }
2784
2785 /**
2786  * Convenience function converts boolean values into "true"
2787  * or "false" (string) values
2788  *
2789  * @param bool $value
2790  * @return string
2791  */
2792 function wfBoolToStr( $value ) {
2793         return $value ? 'true' : 'false';
2794 }
2795
2796 /**
2797  * Load an extension messages file
2798  *
2799  * @param string $extensionName Name of extension to load messages from\for.
2800  * @param string $langcode Language to load messages for, or false for default
2801  *                         behvaiour (en, content language and user language).
2802  * @since r24808 (v1.11) Using this method of loading extension messages will not work
2803  * on MediaWiki prior to that
2804  */
2805 function wfLoadExtensionMessages( $extensionName, $langcode = false ) {
2806         global $wgExtensionMessagesFiles, $wgMessageCache, $wgLang, $wgContLang;
2807
2808         #For recording whether extension message files have been loaded in a given language.
2809         static $loaded = array();
2810
2811         if( !array_key_exists( $extensionName, $loaded ) ) {
2812                 $loaded[$extensionName] = array();
2813         }
2814
2815         if ( !isset($wgExtensionMessagesFiles[$extensionName]) ) {
2816                 throw new MWException( "Messages file for extensions $extensionName is not defined" );
2817         }
2818
2819         if( !$langcode && !array_key_exists( '*', $loaded[$extensionName] ) ) {
2820                 # Just do en, content language and user language.
2821                 $wgMessageCache->loadMessagesFile( $wgExtensionMessagesFiles[$extensionName], false );
2822                 # Mark that they have been loaded.
2823                 $loaded[$extensionName]['en'] = true;
2824                 $loaded[$extensionName][$wgLang->getCode()] = true;
2825                 $loaded[$extensionName][$wgContLang->getCode()] = true;
2826                 # Mark that this part has been done to avoid weird if statements.
2827                 $loaded[$extensionName]['*'] = true;
2828         } elseif( is_string( $langcode ) && !array_key_exists( $langcode, $loaded[$extensionName] ) ) {
2829                 # Load messages for specified language.
2830                 $wgMessageCache->loadMessagesFile( $wgExtensionMessagesFiles[$extensionName], $langcode );
2831                 # Mark that they have been loaded.
2832                 $loaded[$extensionName][$langcode] = true;
2833         }
2834 }
2835
2836 /**
2837  * Get a platform-independent path to the null file, e.g.
2838  * /dev/null
2839  *
2840  * @return string
2841  */
2842 function wfGetNull() {
2843         return wfIsWindows()
2844                 ? 'NUL'
2845                 : '/dev/null';
2846 }
2847
2848 /**
2849  * Displays a maxlag error
2850  *
2851  * @param string $host Server that lags the most
2852  * @param int $lag Maxlag (actual)
2853  * @param int $maxLag Maxlag (requested)
2854  */
2855 function wfMaxlagError( $host, $lag, $maxLag ) {
2856         global $wgShowHostnames;
2857         header( 'HTTP/1.1 503 Service Unavailable' );
2858         header( 'Retry-After: ' . max( intval( $maxLag ), 5 ) );
2859         header( 'X-Database-Lag: ' . intval( $lag ) );
2860         header( 'Content-Type: text/plain' );
2861         if( $wgShowHostnames ) {
2862                 echo "Waiting for $host: $lag seconds lagged\n";
2863         } else {
2864                 echo "Waiting for a database server: $lag seconds lagged\n";
2865         }
2866 }
2867
2868 /**
2869  * Throws an E_USER_NOTICE saying that $function is deprecated
2870  * @param string $function
2871  * @return null
2872  */
2873 function wfDeprecated( $function ) {
2874         global $wgDebugLogFile;
2875         if ( !$wgDebugLogFile ) {
2876                 return;
2877         }
2878         $callers = wfDebugBacktrace();
2879         if( isset( $callers[2] ) ){
2880                 $callerfunc = $callers[2];
2881                 $callerfile = $callers[1];
2882                 if( isset( $callerfile['file'] ) && isset( $callerfile['line'] ) ){
2883                         $file = $callerfile['file'] . ' at line ' . $callerfile['line'];
2884                 } else {
2885                         $file = '(internal function)';
2886                 }
2887                 $func = '';
2888                 if( isset( $callerfunc['class'] ) )
2889                         $func .= $callerfunc['class'] . '::';
2890                 $func .= @$callerfunc['function'];
2891                 $msg = "Use of $function is deprecated. Called from $func in $file";
2892         } else {
2893                 $msg = "Use of $function is deprecated.";
2894         }
2895         wfDebug( "$msg\n" );
2896 }
2897
2898 /**
2899  * Sleep until the worst slave's replication lag is less than or equal to
2900  * $maxLag, in seconds.  Use this when updating very large numbers of rows, as
2901  * in maintenance scripts, to avoid causing too much lag.  Of course, this is
2902  * a no-op if there are no slaves.
2903  *
2904  * Every time the function has to wait for a slave, it will print a message to
2905  * that effect (and then sleep for a little while), so it's probably not best
2906  * to use this outside maintenance scripts in its present form.
2907  *
2908  * @param int $maxLag
2909  * @return null
2910  */
2911 function wfWaitForSlaves( $maxLag ) {
2912         if( $maxLag ) {
2913                 $lb = wfGetLB();
2914                 list( $host, $lag ) = $lb->getMaxLag();
2915                 while( $lag > $maxLag ) {
2916                         $name = @gethostbyaddr( $host );
2917                         if( $name !== false ) {
2918                                 $host = $name;
2919                         }
2920                         print "Waiting for $host (lagged $lag seconds)...\n";
2921                         sleep($maxLag);
2922                         list( $host, $lag ) = $lb->getMaxLag();
2923                 }
2924         }
2925 }
2926
2927 /** Generate a random 32-character hexadecimal token.
2928  * @param mixed $salt Some sort of salt, if necessary, to add to random characters before hashing.
2929  */
2930 function wfGenerateToken( $salt = '' ) {
2931         $salt = serialize($salt);
2932
2933         return md5( mt_rand( 0, 0x7fffffff ) . $salt );
2934 }
2935
2936 /**
2937  * Replace all invalid characters with -
2938  * @param mixed $title Filename to process
2939  */
2940 function wfStripIllegalFilenameChars( $name ) {
2941         $name = wfBaseName( $name );
2942         $name = preg_replace ( "/[^".Title::legalChars()."]|:/", '-', $name );
2943         return $name;
2944 }