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