includes/GlobalFunctions.php

   1 <?php
   2
   3 /**
   4  * Global functions used everywhere
   5  * @package MediaWiki
   6  */
   7
   8 /**
   9  * Some globals and requires needed
  10  */
  11
  12 /**
  13  * Total number of articles
  14  * @global integer $wgNumberOfArticles
  15  */
  16 $wgNumberOfArticles = -1; # Unset
  17 /**
  18  * Total number of views
  19  * @global integer $wgTotalViews
  20  */
  21 $wgTotalViews = -1;
  22 /**
  23  * Total number of edits
  24  * @global integer $wgTotalEdits
  25  */
  26 $wgTotalEdits = -1;
  27
  28
  29 require_once( 'DatabaseFunctions.php' );
  30 require_once( 'UpdateClasses.php' );
  31 require_once( 'LogPage.php' );
  32 require_once( 'normal/UtfNormalUtil.php' );
  33
  34 /**
  35  * Compatibility functions
  36  * PHP <4.3.x is not actively supported; 4.1.x and 4.2.x might or might not work.
  37  * <4.1.x will not work, as we use a number of features introduced in 4.1.0
  38  * such as the new autoglobals.
  39  */
  40 if( !function_exists('iconv') ) {
  41         # iconv support is not in the default configuration and so may not be present.
  42         # Assume will only ever use utf-8 and iso-8859-1.
  43         # This will *not* work in all circumstances.
  44         function iconv( $from, $to, $string ) {
  45                 if(strcasecmp( $from, $to ) == 0) return $string;
  46                 if(strcasecmp( $from, 'utf-8' ) == 0) return utf8_decode( $string );
  47                 if(strcasecmp( $to, 'utf-8' ) == 0) return utf8_encode( $string );
  48                 return $string;
  49         }
  50 }
  51
  52 if( !function_exists('file_get_contents') ) {
  53         # Exists in PHP 4.3.0+
  54         function file_get_contents( $filename ) {
  55                 return implode( '', file( $filename ) );
  56         }
  57 }
  58
  59 if( !function_exists('is_a') ) {
  60         # Exists in PHP 4.2.0+
  61         function is_a( $object, $class_name ) {
  62                 return
  63                         (strcasecmp( get_class( $object ), $class_name ) == 0) ||
  64                          is_subclass_of( $object, $class_name );
  65         }
  66 }
  67
  68 # UTF-8 substr function based on a PHP manual comment
  69 if ( !function_exists( 'mb_substr' ) ) {
  70         function mb_substr( $str, $start ) {
  71                 preg_match_all( '/./us', $str, $ar );
  72
  73                 if( func_num_args() >= 3 ) {
  74                         $end = func_get_arg( 2 );
  75                         return join( '', array_slice( $ar[0], $start, $end ) );
  76                 } else {
  77                         return join( '', array_slice( $ar[0], $start ) );
  78                 }
  79         }
  80 }
  81
  82 if( !function_exists( 'floatval' ) ) {
  83         /**
  84          * First defined in PHP 4.2.0
  85          * @param mixed $var;
  86          * @return float
  87          */
  88         function floatval( $var ) {
  89                 return (float)$var;
  90         }
  91 }
  92
  93 /**
  94  * Where as we got a random seed
  95  * @var bool $wgTotalViews
  96  */
  97 $wgRandomSeeded = false;
  98
  99 /**
 100  * Seed Mersenne Twister
 101  * Only necessary in PHP < 4.2.0
 102  *
 103  * @return bool
 104  */
 105 function wfSeedRandom() {
 106         global $wgRandomSeeded;
 107
 108         if ( ! $wgRandomSeeded && version_compare( phpversion(), '4.2.0' ) < 0 ) {
 109                 $seed = hexdec(substr(md5(microtime()),-8)) & 0x7fffffff;
 110                 mt_srand( $seed );
 111                 $wgRandomSeeded = true;
 112         }
 113 }
 114
 115 /**
 116  * Get a random decimal value between 0 and 1, in a way
 117  * not likely to give duplicate values for any realistic
 118  * number of articles.
 119  *
 120  * @return string
 121  */
 122 function wfRandom() {
 123         # The maximum random value is "only" 2^31-1, so get two random
 124         # values to reduce the chance of dupes
 125         $max = mt_getrandmax();
 126         $rand = number_format( (mt_rand() * $max + mt_rand())
 127                 / $max / $max, 12, '.', '' );
 128         return $rand;
 129 }
 130
 131 /**
 132  * We want / and : to be included as literal characters in our title URLs.
 133  * %2F in the page titles seems to fatally break for some reason.
 134  *
 135  * @param string $s
 136  * @return string
 137 */
 138 function wfUrlencode ( $s ) {
 139         $s = urlencode( $s );
 140         $s = preg_replace( '/%3[Aa]/', ':', $s );
 141         $s = preg_replace( '/%2[Ff]/', '/', $s );
 142
 143         return $s;
 144 }
 145
 146 /**
 147  * Sends a line to the debug log if enabled or, optionally, to a comment in output.
 148  * In normal operation this is a NOP.
 149  *
 150  * Controlling globals:
 151  * $wgDebugLogFile - points to the log file
 152  * $wgProfileOnly - if set, normal debug messages will not be recorded.
 153  * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
 154  * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
 155  *
 156  * @param string $text
 157  * @param bool $logonly Set true to avoid appearing in HTML when $wgDebugComments is set
 158  */
 159 function wfDebug( $text, $logonly = false ) {
 160         global $wgOut, $wgDebugLogFile, $wgDebugComments, $wgProfileOnly, $wgDebugRawPage;
 161
 162         # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
 163         if ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' && !$wgDebugRawPage ) {
 164                 return;
 165         }
 166
 167         if ( isset( $wgOut ) && $wgDebugComments && !$logonly ) {
 168                 $wgOut->debug( $text );
 169         }
 170         if ( '' != $wgDebugLogFile && !$wgProfileOnly ) {
 171                 # Strip unprintables; they can switch terminal modes when binary data
 172                 # gets dumped, which is pretty annoying.
 173                 $text = preg_replace( '![\x00-\x08\x0b\x0c\x0e-\x1f]!', ' ', $text );
 174                 @error_log( $text, 3, $wgDebugLogFile );
 175         }
 176 }
 177
 178 /**
 179  * Log for database errors
 180  * @param string $text Database error message.
 181  */
 182 function wfLogDBError( $text ) {
 183         global $wgDBerrorLog;
 184         if ( $wgDBerrorLog ) {
 185                 $text = date('D M j G:i:s T Y') . "\t".$text;
 186                 error_log( $text, 3, $wgDBerrorLog );
 187         }
 188 }
 189
 190 /**
 191  * @todo document
 192  */
 193 function logProfilingData() {
 194         global $wgRequestTime, $wgDebugLogFile, $wgDebugRawPage, $wgRequest;
 195         global $wgProfiling, $wgProfileStack, $wgProfileLimit, $wgUser;
 196         $now = wfTime();
 197
 198         list( $usec, $sec ) = explode( ' ', $wgRequestTime );
 199         $start = (float)$sec + (float)$usec;
 200         $elapsed = $now - $start;
 201         if ( $wgProfiling ) {
 202                 $prof = wfGetProfilingOutput( $start, $elapsed );
 203                 $forward = '';
 204                 if( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) )
 205                         $forward = ' forwarded for ' . $_SERVER['HTTP_X_FORWARDED_FOR'];
 206                 if( !empty( $_SERVER['HTTP_CLIENT_IP'] ) )
 207                         $forward .= ' client IP ' . $_SERVER['HTTP_CLIENT_IP'];
 208                 if( !empty( $_SERVER['HTTP_FROM'] ) )
 209                         $forward .= ' from ' . $_SERVER['HTTP_FROM'];
 210                 if( $forward )
 211                         $forward = "\t(proxied via {$_SERVER['REMOTE_ADDR']}{$forward})";
 212                 if( $wgUser->isAnon() )
 213                         $forward .= ' anon';
 214                 $log = sprintf( "%s\t%04.3f\t%s\n",
 215                   gmdate( 'YmdHis' ), $elapsed,
 216                   urldecode( $_SERVER['REQUEST_URI'] . $forward ) );
 217                 if ( '' != $wgDebugLogFile && ( $wgRequest->getVal('action') != 'raw' || $wgDebugRawPage ) ) {
 218                         error_log( $log . $prof, 3, $wgDebugLogFile );
 219                 }
 220         }
 221 }
 222
 223 /**
 224  * Check if the wiki read-only lock file is present. This can be used to lock
 225  * off editing functions, but doesn't guarantee that the database will not be
 226  * modified.
 227  * @return bool
 228  */
 229 function wfReadOnly() {
 230         global $wgReadOnlyFile, $wgReadOnly;
 231
 232         if ( $wgReadOnly ) {
 233                 return true;
 234         }
 235         if ( '' == $wgReadOnlyFile ) {
 236                 return false;
 237         }
 238
 239         // Set $wgReadOnly and unset $wgReadOnlyFile, for faster access next time
 240         if ( is_file( $wgReadOnlyFile ) ) {
 241                 $wgReadOnly = true;
 242         } else {
 243                 $wgReadOnly = false;
 244         }
 245         $wgReadOnlyFile = '';
 246         return $wgReadOnly;
 247 }
 248
 249
 250 /**
 251  * Get a message from anywhere, for the current user language
 252  *
 253  * @param string
 254  */
 255 function wfMsg( $key ) {
 256         $args = func_get_args();
 257         array_shift( $args );
 258         return wfMsgReal( $key, $args, true );
 259 }
 260
 261 /**
 262  * Get a message from anywhere, for the current global language
 263  */
 264 function wfMsgForContent( $key ) {
 265         global $wgForceUIMsgAsContentMsg;
 266         $args = func_get_args();
 267         array_shift( $args );
 268         $forcontent = true;
 269         if( is_array( $wgForceUIMsgAsContentMsg ) &&
 270                 in_array( $key, $wgForceUIMsgAsContentMsg ) )
 271                 $forcontent = false;
 272         return wfMsgReal( $key, $args, true, $forcontent );
 273 }
 274
 275 /**
 276  * Get a message from the language file, for the UI elements
 277  */
 278 function wfMsgNoDB( $key ) {
 279         $args = func_get_args();
 280         array_shift( $args );
 281         return wfMsgReal( $key, $args, false );
 282 }
 283
 284 /**
 285  * Get a message from the language file, for the content
 286  */
 287 function wfMsgNoDBForContent( $key ) {
 288         global $wgForceUIMsgAsContentMsg;
 289         $args = func_get_args();
 290         array_shift( $args );
 291         $forcontent = true;
 292         if( is_array( $wgForceUIMsgAsContentMsg ) &&
 293                 in_array( $key, $wgForceUIMsgAsContentMsg ) )
 294                 $forcontent = false;
 295         return wfMsgReal( $key, $args, false, $forcontent );
 296 }
 297
 298
 299 /**
 300  * Really get a message
 301  */
 302 function wfMsgReal( $key, $args, $useDB, $forContent=false ) {
 303         $fname = 'wfMsgReal';
 304         wfProfileIn( $fname );
 305
 306         $message = wfMsgGetKey( $key, $useDB, $forContent );
 307         $message = wfMsgReplaceArgs( $message, $args );
 308         wfProfileOut( $fname );
 309         return $message;
 310 }
 311
 312 /**
 313  * Fetch a message string value, but don't replace any keys yet.
 314  * @param string $key
 315  * @param bool $useDB
 316  * @param bool $forContent
 317  * @return string
 318  * @access private
 319  */
 320 function wfMsgGetKey( $key, $useDB, $forContent = false ) {
 321         global $wgParser, $wgMsgParserOptions;
 322         global $wgContLang, $wgLanguageCode;
 323         global $wgMessageCache, $wgLang;
 324
 325         if( is_object( $wgMessageCache ) ) {
 326                 $message = $wgMessageCache->get( $key, $useDB, $forContent );
 327         } else {
 328                 if( $forContent ) {
 329                         $lang = &$wgContLang;
 330                 } else {
 331                         $lang = &$wgLang;
 332                 }
 333
 334                 wfSuppressWarnings();
 335
 336                 if( is_object( $lang ) ) {
 337                         $message = $lang->getMessage( $key );
 338                 } else {
 339                         $message = '';
 340                 }
 341                 wfRestoreWarnings();
 342                 if(!$message)
 343                         $message = Language::getMessage($key);
 344                 if(strstr($message, '{{' ) !== false) {
 345                         $message = $wgParser->transformMsg($message, $wgMsgParserOptions);
 346                 }
 347         }
 348         return $message;
 349 }
 350
 351 /**
 352  * Replace message parameter keys on the given formatted output.
 353  *
 354  * @param string $message
 355  * @param array $args
 356  * @return string
 357  * @access private
 358  */
 359 function wfMsgReplaceArgs( $message, $args ) {
 360         static $replacementKeys = array( '$1', '$2', '$3', '$4', '$5', '$6', '$7', '$8', '$9' );
 361
 362         # Fix windows line-endings
 363         # Some messages are split with explode("\n", $msg)
 364         $message = str_replace( "\r", '', $message );
 365
 366         # Replace arguments
 367         if( count( $args ) ) {
 368                 $message = str_replace( $replacementKeys, $args, $message );
 369         }
 370         return $message;
 371 }
 372
 373 /**
 374  * Return an HTML-escaped version of a message.
 375  * Parameter replacements, if any, are done *after* the HTML-escaping,
 376  * so parameters may contain HTML (eg links or form controls). Be sure
 377  * to pre-escape them if you really do want plaintext, or just wrap
 378  * the whole thing in htmlspecialchars().
 379  *
 380  * @param string $key
 381  * @param string ... parameters
 382  * @return string
 383  */
 384 function wfMsgHtml( $key ) {
 385         $args = func_get_args();
 386         array_shift( $args );
 387         return wfMsgReplaceArgs( htmlspecialchars( wfMsgGetKey( $key, true ) ), $args );
 388 }
 389
 390 /**
 391  * Return an HTML version of message
 392  * Parameter replacements, if any, are done *after* parsing the wiki-text message,
 393  * so parameters may contain HTML (eg links or form controls). Be sure
 394  * to pre-escape them if you really do want plaintext, or just wrap
 395  * the whole thing in htmlspecialchars().
 396  *
 397  * @param string $key
 398  * @param string ... parameters
 399  * @return string
 400  */
 401 function wfMsgWikiHtml( $key ) {
 402         global $wgOut;
 403         $args = func_get_args();
 404         array_shift( $args );
 405         return wfMsgReplaceArgs( $wgOut->parse( wfMsgGetKey( $key, true ), /* can't be set to false */ true ), $args );
 406 }
 407
 408 /**
 409  * Just like exit() but makes a note of it.
 410  * Commits open transactions except if the error parameter is set
 411  */
 412 function wfAbruptExit( $error = false ){
 413         global $wgLoadBalancer;
 414         static $called = false;
 415         if ( $called ){
 416                 exit();
 417         }
 418         $called = true;
 419
 420         if( function_exists( 'debug_backtrace' ) ){ // PHP >= 4.3
 421                 $bt = debug_backtrace();
 422                 for($i = 0; $i < count($bt) ; $i++){
 423                         $file = $bt[$i]['file'];
 424                         $line = $bt[$i]['line'];
 425                         wfDebug("WARNING: Abrupt exit in $file at line $line\n");
 426                 }
 427         } else {
 428                 wfDebug('WARNING: Abrupt exit\n');
 429         }
 430         if ( !$error ) {
 431                 $wgLoadBalancer->closeAll();
 432         }
 433         exit();
 434 }
 435
 436 /**
 437  * @todo document
 438  */
 439 function wfErrorExit() {
 440         wfAbruptExit( true );
 441 }
 442
 443 /**
 444  * Die with a backtrace
 445  * This is meant as a debugging aid to track down where bad data comes from.
 446  * Shouldn't be used in production code except maybe in "shouldn't happen" areas.
 447  *
 448  * @param string $msg Message shown when dieing.
 449  */
 450 function wfDebugDieBacktrace( $msg = '' ) {
 451         global $wgCommandLineMode;
 452
 453         $backtrace = wfBacktrace();
 454         if ( $backtrace !== false ) {
 455                 if ( $wgCommandLineMode ) {
 456                         $msg .= "\nBacktrace:\n$backtrace";
 457                 } else {
 458                         $msg .= "\n<p>Backtrace:</p>\n$backtrace";
 459                 }
 460          }
 461          echo $msg;
 462          die( -1 );
 463 }
 464
 465 function wfBacktrace() {
 466         global $wgCommandLineMode;
 467         if ( !function_exists( 'debug_backtrace' ) ) {
 468                 return false;
 469         }
 470
 471         if ( $wgCommandLineMode ) {
 472                 $msg = '';
 473         } else {
 474                 $msg = "<ul>\n";
 475         }
 476         $backtrace = debug_backtrace();
 477         foreach( $backtrace as $call ) {
 478                 if( isset( $call['file'] ) ) {
 479                         $f = explode( DIRECTORY_SEPARATOR, $call['file'] );
 480                         $file = $f[count($f)-1];
 481                 } else {
 482                         $file = '-';
 483                 }
 484                 if( isset( $call['line'] ) ) {
 485                         $line = $call['line'];
 486                 } else {
 487                         $line = '-';
 488                 }
 489                 if ( $wgCommandLineMode ) {
 490                         $msg .= "$file line $line calls ";
 491                 } else {
 492                         $msg .= '<li>' . $file . ' line ' . $line . ' calls ';
 493                 }
 494                 if( !empty( $call['class'] ) ) $msg .= $call['class'] . '::';
 495                 $msg .= $call['function'] . '()';
 496
 497                 if ( $wgCommandLineMode ) {
 498                         $msg .= "\n";
 499                 } else {
 500                         $msg .= "</li>\n";
 501                 }
 502         }
 503         if ( $wgCommandLineMode ) {
 504                 $msg .= "\n";
 505         } else {
 506                 $msg .= "</ul>\n";
 507         }
 508
 509         return $msg;
 510 }
 511
 512
 513 /* Some generic result counters, pulled out of SearchEngine */
 514
 515
 516 /**
 517  * @todo document
 518  */
 519 function wfShowingResults( $offset, $limit ) {
 520         global $wgLang;
 521         return wfMsg( 'showingresults', $wgLang->formatNum( $limit ), $wgLang->formatNum( $offset+1 ) );
 522 }
 523
 524 /**
 525  * @todo document
 526  */
 527 function wfShowingResultsNum( $offset, $limit, $num ) {
 528         global $wgLang;
 529         return wfMsg( 'showingresultsnum', $wgLang->formatNum( $limit ), $wgLang->formatNum( $offset+1 ), $wgLang->formatNum( $num ) );
 530 }
 531
 532 /**
 533  * @todo document
 534  */
 535 function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) {
 536         global $wgUser, $wgLang;
 537         $fmtLimit = $wgLang->formatNum( $limit );
 538         $prev = wfMsg( 'prevn', $fmtLimit );
 539         $next = wfMsg( 'nextn', $fmtLimit );
 540
 541         if( is_object( $link ) ) {
 542                 $title =& $link;
 543         } else {
 544                 $title = Title::newFromText( $link );
 545                 if( is_null( $title ) ) {
 546                         return false;
 547                 }
 548         }
 549
 550         $sk = $wgUser->getSkin();
 551         if ( 0 != $offset ) {
 552                 $po = $offset - $limit;
 553                 if ( $po < 0 ) { $po = 0; }
 554                 $q = "limit={$limit}&offset={$po}";
 555                 if ( '' != $query ) { $q .= '&'.$query; }
 556                 $plink = '<a href="' . $title->escapeLocalUrl( $q ) . "\">{$prev}</a>";
 557         } else { $plink = $prev; }
 558
 559         $no = $offset + $limit;
 560         $q = 'limit='.$limit.'&offset='.$no;
 561         if ( '' != $query ) { $q .= '&'.$query; }
 562
 563         if ( $atend ) {
 564                 $nlink = $next;
 565         } else {
 566                 $nlink = '<a href="' . $title->escapeLocalUrl( $q ) . "\">{$next}</a>";
 567         }
 568         $nums = wfNumLink( $offset, 20, $title, $query ) . ' | ' .
 569           wfNumLink( $offset, 50, $title, $query ) . ' | ' .
 570           wfNumLink( $offset, 100, $title, $query ) . ' | ' .
 571           wfNumLink( $offset, 250, $title, $query ) . ' | ' .
 572           wfNumLink( $offset, 500, $title, $query );
 573
 574         return wfMsg( 'viewprevnext', $plink, $nlink, $nums );
 575 }
 576
 577 /**
 578  * @todo document
 579  */
 580 function wfNumLink( $offset, $limit, &$title, $query = '' ) {
 581         global $wgUser, $wgLang;
 582         if ( '' == $query ) { $q = ''; }
 583         else { $q = $query.'&'; }
 584         $q .= 'limit='.$limit.'&offset='.$offset;
 585
 586         $fmtLimit = $wgLang->formatNum( $limit );
 587         $s = '<a href="' . $title->escapeLocalUrl( $q ) . "\">{$fmtLimit}</a>";
 588         return $s;
 589 }
 590
 591 /**
 592  * @todo document
 593  * @todo FIXME: we may want to blacklist some broken browsers
 594  *
 595  * @return bool Whereas client accept gzip compression
 596  */
 597 function wfClientAcceptsGzip() {
 598         global $wgUseGzip;
 599         if( $wgUseGzip ) {
 600                 # FIXME: we may want to blacklist some broken browsers
 601                 if( preg_match(
 602                         '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
 603                         $_SERVER['HTTP_ACCEPT_ENCODING'],
 604                         $m ) ) {
 605                         if( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) return false;
 606                         wfDebug( " accepts gzip\n" );
 607                         return true;
 608                 }
 609         }
 610         return false;
 611 }
 612
 613 /**
 614  * Yay, more global functions!
 615  */
 616 function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
 617         global $wgRequest;
 618         return $wgRequest->getLimitOffset( $deflimit, $optionname );
 619 }
 620
 621 /**
 622  * Escapes the given text so that it may be output using addWikiText()
 623  * without any linking, formatting, etc. making its way through. This
 624  * is achieved by substituting certain characters with HTML entities.
 625  * As required by the callers, <nowiki> is not used. It currently does
 626  * not filter out characters which have special meaning only at the
 627  * start of a line, such as "*".
 628  *
 629  * @param string $text Text to be escaped
 630  */
 631 function wfEscapeWikiText( $text ) {
 632         $text = str_replace(
 633                 array( '[',             '|',      '\'',    'ISBN '        , '://'         , "\n=", '{{' ),
 634                 array( '&#91;', '&#124;', '&#39;', 'ISBN&#32;', '&#58;//' , "\n&#61;", '&#123;&#123;' ),
 635                 htmlspecialchars($text) );
 636         return $text;
 637 }
 638
 639 /**
 640  * @todo document
 641  */
 642 function wfQuotedPrintable( $string, $charset = '' ) {
 643         # Probably incomplete; see RFC 2045
 644         if( empty( $charset ) ) {
 645                 global $wgInputEncoding;
 646                 $charset = $wgInputEncoding;
 647         }
 648         $charset = strtoupper( $charset );
 649         $charset = str_replace( 'ISO-8859', 'ISO8859', $charset ); // ?
 650
 651         $illegal = '\x00-\x08\x0b\x0c\x0e-\x1f\x7f-\xff=';
 652         $replace = $illegal . '\t ?_';
 653         if( !preg_match( "/[$illegal]/", $string ) ) return $string;
 654         $out = "=?$charset?Q?";
 655         $out .= preg_replace( "/([$replace])/e", 'sprintf("=%02X",ord("$1"))', $string );
 656         $out .= '?=';
 657         return $out;
 658 }
 659
 660 /**
 661  * Returns an escaped string suitable for inclusion in a string literal
 662  * for JavaScript source code.
 663  * Illegal control characters are assumed not to be present.
 664  *
 665  * @param string $string
 666  * @return string
 667  */
 668 function wfEscapeJsString( $string ) {
 669         // See ECMA 262 section 7.8.4 for string literal format
 670         $pairs = array(
 671                 "\\" => "\\\\",
 672                 "\"" => "\\\"",
 673                 '\'' => '\\\'',
 674                 "\n" => "\\n",
 675                 "\r" => "\\r",
 676
 677                 # To avoid closing the element or CDATA section
 678                 "<" => "\\x3c",
 679                 ">" => "\\x3e",
 680         );
 681         return strtr( $string, $pairs );
 682 }
 683
 684 /**
 685  * @todo document
 686  * @return float
 687  */
 688 function wfTime() {
 689         $st = explode( ' ', microtime() );
 690         return (float)$st[0] + (float)$st[1];
 691 }
 692
 693 /**
 694  * Changes the first character to an HTML entity
 695  */
 696 function wfHtmlEscapeFirst( $text ) {
 697         $ord = ord($text);
 698         $newText = substr($text, 1);
 699         return "&#$ord;$newText";
 700 }
 701
 702 /**
 703  * Sets dest to source and returns the original value of dest
 704  * If source is NULL, it just returns the value, it doesn't set the variable
 705  */
 706 function wfSetVar( &$dest, $source ) {
 707         $temp = $dest;
 708         if ( !is_null( $source ) ) {
 709                 $dest = $source;
 710         }
 711         return $temp;
 712 }
 713
 714 /**
 715  * As for wfSetVar except setting a bit
 716  */
 717 function wfSetBit( &$dest, $bit, $state = true ) {
 718         $temp = (bool)($dest & $bit );
 719         if ( !is_null( $state ) ) {
 720                 if ( $state ) {
 721                         $dest |= $bit;
 722                 } else {
 723                         $dest &= ~$bit;
 724                 }
 725         }
 726         return $temp;
 727 }
 728
 729 /**
 730  * This function takes two arrays as input, and returns a CGI-style string, e.g.
 731  * "days=7&limit=100". Options in the first array override options in the second.
 732  * Options set to "" will not be output.
 733  */
 734 function wfArrayToCGI( $array1, $array2 = NULL )
 735 {
 736         if ( !is_null( $array2 ) ) {
 737                 $array1 = $array1 + $array2;
 738         }
 739
 740         $cgi = '';
 741         foreach ( $array1 as $key => $value ) {
 742                 if ( '' !== $value ) {
 743                         if ( '' != $cgi ) {
 744                                 $cgi .= '&';
 745                         }
 746                         $cgi .= urlencode( $key ) . '=' . urlencode( $value );
 747                 }
 748         }
 749         return $cgi;
 750 }
 751
 752 /**
 753  * This is obsolete, use SquidUpdate::purge()
 754  * @deprecated
 755  */
 756 function wfPurgeSquidServers ($urlArr) {
 757         SquidUpdate::purge( $urlArr );
 758 }
 759
 760 /**
 761  * Windows-compatible version of escapeshellarg()
 762  * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
 763  * function puts single quotes in regardless of OS
 764  */
 765 function wfEscapeShellArg( ) {
 766         $args = func_get_args();
 767         $first = true;
 768         $retVal = '';
 769         foreach ( $args as $arg ) {
 770                 if ( !$first ) {
 771                         $retVal .= ' ';
 772                 } else {
 773                         $first = false;
 774                 }
 775
 776                 if ( wfIsWindows() ) {
 777                         $retVal .= '"' . str_replace( '"','\"', $arg ) . '"';
 778                 } else {
 779                         $retVal .= escapeshellarg( $arg );
 780                 }
 781         }
 782         return $retVal;
 783 }
 784
 785 /**
 786  * wfMerge attempts to merge differences between three texts.
 787  * Returns true for a clean merge and false for failure or a conflict.
 788  */
 789 function wfMerge( $old, $mine, $yours, &$result ){
 790         global $wgDiff3;
 791
 792         # This check may also protect against code injection in
 793         # case of broken installations.
 794         if(! file_exists( $wgDiff3 ) ){
 795                 return false;
 796         }
 797
 798         # Make temporary files
 799         $td = wfTempDir();
 800         $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
 801         $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
 802         $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
 803
 804         fwrite( $oldtextFile, $old ); fclose( $oldtextFile );
 805         fwrite( $mytextFile, $mine ); fclose( $mytextFile );
 806         fwrite( $yourtextFile, $yours ); fclose( $yourtextFile );
 807
 808         # Check for a conflict
 809         $cmd = wfEscapeShellArg( $wgDiff3 ) . ' -a --overlap-only ' .
 810           wfEscapeShellArg( $mytextName ) . ' ' .
 811           wfEscapeShellArg( $oldtextName ) . ' ' .
 812           wfEscapeShellArg( $yourtextName );
 813         $handle = popen( $cmd, 'r' );
 814
 815         if( fgets( $handle, 1024 ) ){
 816                 $conflict = true;
 817         } else {
 818                 $conflict = false;
 819         }
 820         pclose( $handle );
 821
 822         # Merge differences
 823         $cmd = wfEscapeShellArg( $wgDiff3 ) . ' -a -e --merge ' .
 824           wfEscapeShellArg( $mytextName, $oldtextName, $yourtextName );
 825         $handle = popen( $cmd, 'r' );
 826         $result = '';
 827         do {
 828                 $data = fread( $handle, 8192 );
 829                 if ( strlen( $data ) == 0 ) {
 830                         break;
 831                 }
 832                 $result .= $data;
 833         } while ( true );
 834         pclose( $handle );
 835         unlink( $mytextName ); unlink( $oldtextName ); unlink( $yourtextName );
 836         return ! $conflict;
 837 }
 838
 839 /**
 840  * @todo document
 841  */
 842 function wfVarDump( $var ) {
 843         global $wgOut;
 844         $s = str_replace("\n","<br />\n", var_export( $var, true ) . "\n");
 845         if ( headers_sent() || !@is_object( $wgOut ) ) {
 846                 print $s;
 847         } else {
 848                 $wgOut->addHTML( $s );
 849         }
 850 }
 851
 852 /**
 853  * Provide a simple HTTP error.
 854  */
 855 function wfHttpError( $code, $label, $desc ) {
 856         global $wgOut;
 857         $wgOut->disable();
 858         header( "HTTP/1.0 $code $label" );
 859         header( "Status: $code $label" );
 860         $wgOut->sendCacheControl();
 861
 862         header( 'Content-type: text/html' );
 863         print "<html><head><title>" .
 864                 htmlspecialchars( $label ) .
 865                 "</title></head><body><h1>" .
 866                 htmlspecialchars( $label ) .
 867                 "</h1><p>" .
 868                 htmlspecialchars( $desc ) .
 869                 "</p></body></html>\n";
 870 }
 871
 872 /**
 873  * Converts an Accept-* header into an array mapping string values to quality
 874  * factors
 875  */
 876 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
 877         # No arg means accept anything (per HTTP spec)
 878         if( !$accept ) {
 879                 return array( $def => 1 );
 880         }
 881
 882         $prefs = array();
 883
 884         $parts = explode( ',', $accept );
 885
 886         foreach( $parts as $part ) {
 887                 # FIXME: doesn't deal with params like 'text/html; level=1'
 888                 @list( $value, $qpart ) = explode( ';', $part );
 889                 if( !isset( $qpart ) ) {
 890                         $prefs[$value] = 1;
 891                 } elseif( preg_match( '/q\s*=\s*(\d*\.\d+)/', $qpart, $match ) ) {
 892                         $prefs[$value] = $match[1];
 893                 }
 894         }
 895
 896         return $prefs;
 897 }
 898
 899 /**
 900  * Checks if a given MIME type matches any of the keys in the given
 901  * array. Basic wildcards are accepted in the array keys.
 902  *
 903  * Returns the matching MIME type (or wildcard) if a match, otherwise
 904  * NULL if no match.
 905  *
 906  * @param string $type
 907  * @param array $avail
 908  * @return string
 909  * @access private
 910  */
 911 function mimeTypeMatch( $type, $avail ) {
 912         if( array_key_exists($type, $avail) ) {
 913                 return $type;
 914         } else {
 915                 $parts = explode( '/', $type );
 916                 if( array_key_exists( $parts[0] . '/*', $avail ) ) {
 917                         return $parts[0] . '/*';
 918                 } elseif( array_key_exists( '*/*', $avail ) ) {
 919                         return '*/*';
 920                 } else {
 921                         return NULL;
 922                 }
 923         }
 924 }
 925
 926 /**
 927  * Returns the 'best' match between a client's requested internet media types
 928  * and the server's list of available types. Each list should be an associative
 929  * array of type to preference (preference is a float between 0.0 and 1.0).
 930  * Wildcards in the types are acceptable.
 931  *
 932  * @param array $cprefs Client's acceptable type list
 933  * @param array $sprefs Server's offered types
 934  * @return string
 935  *
 936  * @todo FIXME: doesn't handle params like 'text/plain; charset=UTF-8'
 937  * XXX: generalize to negotiate other stuff
 938  */
 939 function wfNegotiateType( $cprefs, $sprefs ) {
 940         $combine = array();
 941
 942         foreach( array_keys($sprefs) as $type ) {
 943                 $parts = explode( '/', $type );
 944                 if( $parts[1] != '*' ) {
 945                         $ckey = mimeTypeMatch( $type, $cprefs );
 946                         if( $ckey ) {
 947                                 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
 948                         }
 949                 }
 950         }
 951
 952         foreach( array_keys( $cprefs ) as $type ) {
 953                 $parts = explode( '/', $type );
 954                 if( $parts[1] != '*' && !array_key_exists( $type, $sprefs ) ) {
 955                         $skey = mimeTypeMatch( $type, $sprefs );
 956                         if( $skey ) {
 957                                 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
 958                         }
 959                 }
 960         }
 961
 962         $bestq = 0;
 963         $besttype = NULL;
 964
 965         foreach( array_keys( $combine ) as $type ) {
 966                 if( $combine[$type] > $bestq ) {
 967                         $besttype = $type;
 968                         $bestq = $combine[$type];
 969                 }
 970         }
 971
 972         return $besttype;
 973 }
 974
 975 /**
 976  * Array lookup
 977  * Returns an array where the values in the first array are replaced by the
 978  * values in the second array with the corresponding keys
 979  *
 980  * @return array
 981  */
 982 function wfArrayLookup( $a, $b ) {
 983         return array_flip( array_intersect( array_flip( $a ), array_keys( $b ) ) );
 984 }
 985
 986 /**
 987  * Convenience function; returns MediaWiki timestamp for the present time.
 988  * @return string
 989  */
 990 function wfTimestampNow() {
 991         # return NOW
 992         return wfTimestamp( TS_MW, time() );
 993 }
 994
 995 /**
 996  * Reference-counted warning suppression
 997  */
 998 function wfSuppressWarnings( $end = false ) {
 999         static $suppressCount = 0;
1000         static $originalLevel = false;
1001
1002         if ( $end ) {
1003                 if ( $suppressCount ) {
1004                         $suppressCount --;
1005                         if ( !$suppressCount ) {
1006                                 error_reporting( $originalLevel );
1007                         }
1008                 }
1009         } else {
1010                 if ( !$suppressCount ) {
1011                         $originalLevel = error_reporting( E_ALL & ~( E_WARNING | E_NOTICE ) );
1012                 }
1013                 $suppressCount++;
1014         }
1015 }
1016
1017 /**
1018  * Restore error level to previous value
1019  */
1020 function wfRestoreWarnings() {
1021         wfSuppressWarnings( true );
1022 }
1023
1024 # Autodetect, convert and provide timestamps of various types
1025
1026 /**
1027  * Unix time - the number of seconds since 1970-01-01 00:00:00 UTC
1028  */
1029 define('TS_UNIX', 0);
1030
1031 /**
1032  * MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
1033  */
1034 define('TS_MW', 1);
1035
1036 /**
1037  * MySQL DATETIME (YYYY-MM-DD HH:MM:SS)
1038  */
1039 define('TS_DB', 2);
1040
1041 /**
1042  * RFC 2822 format, for E-mail and HTTP headers
1043  */
1044 define('TS_RFC2822', 3);
1045
1046 /**
1047  * An Exif timestamp (YYYY:MM:DD HH:MM:SS)
1048  *
1049  * @link http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the
1050  *       DateTime tag and page 36 for the DateTimeOriginal and
1051  *       DateTimeDigitized tags.
1052  */
1053 define('TS_EXIF', 4);
1054
1055 /**
1056  * Oracle format time.
1057  */
1058 define('TS_ORACLE', 5);
1059
1060 /**
1061  * @param mixed $outputtype A timestamp in one of the supported formats, the
1062  *                          function will autodetect which format is supplied
1063                             and act accordingly.
1064  * @return string Time in the format specified in $outputtype
1065  */
1066 function wfTimestamp($outputtype=TS_UNIX,$ts=0) {
1067 wfdebug("ts: $ts\n");
1068         if ($ts==0) {
1069                 $uts=time();
1070         } elseif (preg_match("/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)$/",$ts,$da)) {
1071                 # TS_DB
1072                 $uts=gmmktime((int)$da[4],(int)$da[5],(int)$da[6],
1073                             (int)$da[2],(int)$da[3],(int)$da[1]);
1074         } elseif (preg_match("/^(\d{4}):(\d\d):(\d\d) (\d\d):(\d\d):(\d\d)$/",$ts,$da)) {
1075                 # TS_EXIF
1076                 $uts=gmmktime((int)$da[4],(int)$da[5],(int)$da[6],
1077                         (int)$da[2],(int)$da[3],(int)$da[1]);
1078         } elseif (preg_match("/^(\d{4})(\d\d)(\d\d)(\d\d)(\d\d)(\d\d)$/",$ts,$da)) {
1079                 # TS_MW
1080                 $uts=gmmktime((int)$da[4],(int)$da[5],(int)$da[6],
1081                             (int)$da[2],(int)$da[3],(int)$da[1]);
1082         } elseif (preg_match("/^(\d{1,13})$/",$ts,$datearray)) {
1083                 # TS_UNIX
1084                 $uts=$ts;
1085         } elseif (preg_match('/^(\d{1,2})-(...)-(\d\d(\d\d)?) (\d\d)\.(\d\d)\.(\d\d)/', $ts, $da)) {
1086                 # TS_ORACLE
1087                 $uts = strtotime(preg_replace('/(\d\d)\.(\d\d)\.(\d\d)(\.(\d+))?/', "$1:$2:$3",
1088                                 str_replace("+00:00", "UTC", $ts)));
1089         } else {
1090                 # Bogus value; fall back to the epoch...
1091                 wfDebug("wfTimestamp() fed bogus time value: $outputtype; $ts\n");
1092                 $uts = 0;
1093         }
1094
1095
1096         switch($outputtype) {
1097                 case TS_UNIX:
1098                         return $uts;
1099                 case TS_MW:
1100                         return gmdate( 'YmdHis', $uts );
1101                 case TS_DB:
1102                         return gmdate( 'Y-m-d H:i:s', $uts );
1103                 // This shouldn't ever be used, but is included for completeness
1104                 case TS_EXIF:
1105                         return gmdate(  'Y:m:d H:i:s', $uts );
1106                 case TS_RFC2822:
1107                         return gmdate( 'D, d M Y H:i:s', $uts ) . ' GMT';
1108                 case TS_ORACLE:
1109                         return gmdate( 'd-M-y h.i.s A', $uts) . ' +00:00';
1110                 default:
1111                         wfDebugDieBacktrace( 'wfTimestamp() called with illegal output type.');
1112         }
1113 }
1114
1115 /**
1116  * Return a formatted timestamp, or null if input is null.
1117  * For dealing with nullable timestamp columns in the database.
1118  * @param int $outputtype
1119  * @param string $ts
1120  * @return string
1121  */
1122 function wfTimestampOrNull( $outputtype = TS_UNIX, $ts = null ) {
1123         if( is_null( $ts ) ) {
1124                 return null;
1125         } else {
1126                 return wfTimestamp( $outputtype, $ts );
1127         }
1128 }
1129
1130 /**
1131  * Check where as the operating system is Windows
1132  *
1133  * @return bool True if it's windows, False otherwise.
1134  */
1135 function wfIsWindows() {
1136         if (substr(php_uname(), 0, 7) == 'Windows') {
1137                 return true;
1138         } else {
1139                 return false;
1140         }
1141 }
1142
1143 /**
1144  * Swap two variables
1145  */
1146 function swap( &$x, &$y ) {
1147         $z = $x;
1148         $x = $y;
1149         $y = $z;
1150 }
1151
1152 function wfGetSiteNotice() {
1153         global $wgSiteNotice, $wgTitle, $wgOut;
1154         $fname = 'wfGetSiteNotice';
1155         wfProfileIn( $fname );
1156
1157         $notice = wfMsg( 'sitenotice' );
1158         if( $notice == '&lt;sitenotice&gt;' || $notice == '-' ) {
1159                 $notice = '';
1160         }
1161         if( $notice == '' ) {
1162                 # We may also need to override a message with eg downtime info
1163                 # FIXME: make this work!
1164                 $notice = $wgSiteNotice;
1165         }
1166         if($notice != '-' && $notice != '') {
1167                 $specialparser = new Parser();
1168                 $parserOutput = $specialparser->parse( $notice, $wgTitle, $wgOut->mParserOptions, false );
1169                 $notice = $parserOutput->getText();
1170         }
1171         wfProfileOut( $fname );
1172         return $notice;
1173 }
1174
1175 /**
1176  * Format an XML element with given attributes and, optionally, text content.
1177  * Element and attribute names are assumed to be ready for literal inclusion.
1178  * Strings are assumed to not contain XML-illegal characters; special
1179  * characters (<, >, &) are escaped but illegals are not touched.
1180  *
1181  * @param string $element
1182  * @param array $attribs Name=>value pairs. Values will be escaped.
1183  * @param string $contents NULL to make an open tag only; '' for a contentless closed tag (default)
1184  * @return string
1185  */
1186 function wfElement( $element, $attribs = null, $contents = '') {
1187         $out = '<' . $element;
1188         if( !is_null( $attribs ) ) {
1189                 foreach( $attribs as $name => $val ) {
1190                         $out .= ' ' . $name . '="' . htmlspecialchars( $val ) . '"';
1191                 }
1192         }
1193         if( is_null( $contents ) ) {
1194                 $out .= '>';
1195         } else {
1196                 if( $contents == '' ) {
1197                         $out .= ' />';
1198                 } else {
1199                         $out .= '>';
1200                         $out .= htmlspecialchars( $contents );
1201                         $out .= "</$element>";
1202                 }
1203         }
1204         return $out;
1205 }
1206
1207 /**
1208  * Format an XML element as with wfElement(), but run text through the
1209  * UtfNormal::cleanUp() validator first to ensure that no invalid UTF-8
1210  * is passed.
1211  *
1212  * @param string $element
1213  * @param array $attribs Name=>value pairs. Values will be escaped.
1214  * @param string $contents NULL to make an open tag only; '' for a contentless closed tag (default)
1215  * @return string
1216  */
1217 function wfElementClean( $element, $attribs = array(), $contents = '') {
1218         if( $attribs ) {
1219                 $attribs = array_map( array( 'UtfNormal', 'cleanUp' ), $attribs );
1220         }
1221         if( $contents ) {
1222                 $contents = UtfNormal::cleanUp( $contents );
1223         }
1224         return wfElement( $element, $attribs, $contents );
1225 }
1226
1227 /**
1228  * Create a namespace selector
1229  *
1230  * @param mixed $selected The namespace which should be selected, default ''
1231  * @param string $allnamespaces Value of a special item denoting all namespaces. Null to not include (default)
1232  * @return Html string containing the namespace selector
1233  */
1234 function &HTMLnamespaceselector($selected = '', $allnamespaces = null) {
1235         global $wgContLang;
1236         $s = "<select name='namespace' class='namespaceselector'>\n";
1237         $arr = $wgContLang->getFormattedNamespaces();
1238         if( !is_null($allnamespaces) ) {
1239                 $arr = array($allnamespaces => wfMsgHtml('namespacesall')) + $arr;
1240         }
1241         foreach ($arr as $index => $name) {
1242                 if ($index < NS_MAIN) continue;
1243
1244                 $name = $index !== 0 ? $name : wfMsgHtml('blanknamespace');
1245
1246                 if ($index === $selected) {
1247                         $s .= wfElement("option",
1248                                         array("value" => $index, "selected" => "selected"),
1249                                         $name);
1250                 } else {
1251                         $s .= wfElement("option", array("value" => $index), $name);
1252                 }
1253         }
1254         $s .= "</select>\n";
1255         return $s;
1256 }
1257
1258 /** Global singleton instance of MimeMagic. This is initialized on demand,
1259 * please always use the wfGetMimeMagic() function to get the instance.
1260 *
1261 * @private
1262 */
1263 $wgMimeMagic= NULL;
1264
1265 /** Factory functions for the global MimeMagic object.
1266 * This function always returns the same singleton instance of MimeMagic.
1267 * That objects will be instantiated on the first call to this function.
1268 * If needed, the MimeMagic.php file is automatically included by this function.
1269 * @return MimeMagic the global MimeMagic objects.
1270 */
1271 function &wfGetMimeMagic() {
1272         global $wgMimeMagic;
1273
1274         if (!is_null($wgMimeMagic)) {
1275                 return $wgMimeMagic;
1276         }
1277
1278         if (!class_exists("MimeMagic")) {
1279                 #include on demand
1280                 require_once("MimeMagic.php");
1281         }
1282
1283         $wgMimeMagic= new MimeMagic();
1284
1285         return $wgMimeMagic;
1286 }
1287
1288
1289 /**
1290  * Tries to get the system directory for temporary files.
1291  * The TMPDIR, TMP, and TEMP environment variables are checked in sequence,
1292  * and if none are set /tmp is returned as the generic Unix default.
1293  *
1294  * NOTE: When possible, use the tempfile() function to create temporary
1295  * files to avoid race conditions on file creation, etc.
1296  *
1297  * @return string
1298  */
1299 function wfTempDir() {
1300         foreach( array( 'TMPDIR', 'TMP', 'TEMP' ) as $var ) {
1301                 $tmp = getenv( $var );
1302                 if( $tmp && file_exists( $tmp ) && is_dir( $tmp ) && is_writable( $tmp ) ) {
1303                         return $tmp;
1304                 }
1305         }
1306         # Hope this is Unix of some kind!
1307         return '/tmp';
1308 }
1309
1310 /**
1311  * Make directory, and make all parent directories if they don't exist
1312  */
1313 function wfMkdirParents( $fullDir, $mode ) {
1314         $parts = explode( '/', $fullDir );
1315         $path = '';
1316         $success = false;
1317         foreach ( $parts as $dir ) {
1318                 $path .= $dir . '/';
1319                 if ( !is_dir( $path ) ) {
1320                         if ( !mkdir( $path, $mode ) ) {
1321                                 return false;
1322                         }
1323                 }
1324         }
1325         return true;
1326 }
1327
1328 /**
1329  * Increment a statistics counter
1330  */
1331 function wfIncrStats( $key ) {
1332         global $wgDBname, $wgMemc;
1333         $key = "$wgDBname:stats:$key";
1334         if ( is_null( $wgMemc->incr( $key ) ) ) {
1335                 $wgMemc->add( $key, 1 );
1336         }
1337 }
1338
1339 /**
1340  * @param mixed $nr The number to format
1341  * @param int $acc The number of digits after the decimal point, default 2
1342  * @param bool $round Whether or not to round the value, default true
1343  * @return float
1344  */
1345 function wfPercent( $nr, $acc = 2, $round = true ) {
1346         $ret = sprintf( "%.${acc}f", $nr );
1347         return $round ? round( $ret, $acc ) . '%' : "$ret%";
1348 }
1349
1350 /**
1351  * Encrypt a username/password.
1352  *
1353  * @param string $userid ID of the user
1354  * @param string $password Password of the user
1355  * @return string Hashed password
1356  */
1357 function wfEncryptPassword( $userid, $password ) {
1358         global $wgPasswordSalt;
1359         $p = md5( $password);
1360
1361         if($wgPasswordSalt)
1362                 return md5( "{$userid}-{$p}" );
1363         else
1364                 return $p;
1365 }
1366
1367 /**
1368  * Appends to second array if $value differs from that in $default
1369  */
1370 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
1371         if ( is_null( $changed ) ) {
1372                 wfDebugDieBacktrace('GlobalFunctions::wfAppendToArrayIfNotDefault got null');
1373         }
1374         if ( $default[$key] !== $value ) {
1375                 $changed[$key] = $value;
1376         }
1377 }
1378
1379 /**
1380  * Since wfMsg() and co suck, they don't return false if the message key they
1381  * looked up didn't exist but a XHTML string, this function checks for the
1382  * nonexistance of messages by looking at wfMsg() output
1383  *
1384  * @param $msg      The message key looked up
1385  * @param $wfMsgOut The output of wfMsg*()
1386  * @return bool
1387  */
1388 function wfNoMsg( $msg, $wfMsgOut ) {
1389         return $wfMsgOut === "&lt;$msg&gt;";
1390 }
1391 ?>