includes/GlobalFunctions.php

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