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