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