Add tests for parser tag hooks.
[lhc/web/wiklou.git] / includes / GlobalFunctions.php
index 8319c36..015c6e8 100644 (file)
@@ -20,170 +20,44 @@ require_once dirname( __FILE__ ) . '/normal/UtfNormalUtil.php';
  * Re-implementations of newer functions or functions in non-standard
  * PHP extensions may be included here.
  */
+
 if( !function_exists( 'iconv' ) ) {
-       # iconv support is not in the default configuration and so may not be present.
-       # Assume will only ever use utf-8 and iso-8859-1.
-       # This will *not* work in all circumstances.
        function iconv( $from, $to, $string ) {
-               if ( substr( $to, -8 ) == '//IGNORE' ) {
-                       $to = substr( $to, 0, strlen( $to ) - 8 );
-               }
-               if( strcasecmp( $from, $to ) == 0 ) {
-                       return $string;
-               }
-               if( strcasecmp( $from, 'utf-8' ) == 0 ) {
-                       return utf8_decode( $string );
-               }
-               if( strcasecmp( $to, 'utf-8' ) == 0 ) {
-                       return utf8_encode( $string );
-               }
-               return $string;
+               return Fallback::iconv( $from, $to, $string );
        }
 }
 
 if ( !function_exists( 'mb_substr' ) ) {
-       /**
-        * Fallback implementation for mb_substr, hardcoded to UTF-8.
-        * Attempts to be at least _moderately_ efficient; best optimized
-        * for relatively small offset and count values -- about 5x slower
-        * than native mb_string in my testing.
-        *
-        * Larger offsets are still fairly efficient for Latin text, but
-        * can be up to 100x slower than native if the text is heavily
-        * multibyte and we have to slog through a few hundred kb.
-        */
        function mb_substr( $str, $start, $count='end' ) {
-               if( $start != 0 ) {
-                       $split = mb_substr_split_unicode( $str, intval( $start ) );
-                       $str = substr( $str, $split );
-               }
-
-               if( $count !== 'end' ) {
-                       $split = mb_substr_split_unicode( $str, intval( $count ) );
-                       $str = substr( $str, 0, $split );
-               }
-
-               return $str;
+               return Fallback::mb_substr( $str, $start, $count );
        }
 
        function mb_substr_split_unicode( $str, $splitPos ) {
-               if( $splitPos == 0 ) {
-                       return 0;
-               }
-
-               $byteLen = strlen( $str );
-
-               if( $splitPos > 0 ) {
-                       if( $splitPos > 256 ) {
-                               // Optimize large string offsets by skipping ahead N bytes.
-                               // This will cut out most of our slow time on Latin-based text,
-                               // and 1/2 to 1/3 on East European and Asian scripts.
-                               $bytePos = $splitPos;
-                               while ( $bytePos < $byteLen && $str{$bytePos} >= "\x80" && $str{$bytePos} < "\xc0" ) {
-                                       ++$bytePos;
-                               }
-                               $charPos = mb_strlen( substr( $str, 0, $bytePos ) );
-                       } else {
-                               $charPos = 0;
-                               $bytePos = 0;
-                       }
-
-                       while( $charPos++ < $splitPos ) {
-                               ++$bytePos;
-                               // Move past any tail bytes
-                               while ( $bytePos < $byteLen && $str{$bytePos} >= "\x80" && $str{$bytePos} < "\xc0" ) {
-                                       ++$bytePos;
-                               }
-                       }
-               } else {
-                       $splitPosX = $splitPos + 1;
-                       $charPos = 0; // relative to end of string; we don't care about the actual char position here
-                       $bytePos = $byteLen;
-                       while( $bytePos > 0 && $charPos-- >= $splitPosX ) {
-                               --$bytePos;
-                               // Move past any tail bytes
-                               while ( $bytePos > 0 && $str{$bytePos} >= "\x80" && $str{$bytePos} < "\xc0" ) {
-                                       --$bytePos;
-                               }
-                       }
-               }
-
-               return $bytePos;
+               return Fallback::mb_substr_split_unicode( $str, $splitPos );
        }
 }
 
 if ( !function_exists( 'mb_strlen' ) ) {
-       /**
-        * Fallback implementation of mb_strlen, hardcoded to UTF-8.
-        * @param string $str
-        * @param string $enc optional encoding; ignored
-        * @return int
-        */
        function mb_strlen( $str, $enc = '' ) {
-               $counts = count_chars( $str );
-               $total = 0;
-
-               // Count ASCII bytes
-               for( $i = 0; $i < 0x80; $i++ ) {
-                       $total += $counts[$i];
-               }
-
-               // Count multibyte sequence heads
-               for( $i = 0xc0; $i < 0xff; $i++ ) {
-                       $total += $counts[$i];
-               }
-               return $total;
+               return Fallback::mb_strlen( $str, $enc );
        }
 }
 
-
 if( !function_exists( 'mb_strpos' ) ) {
-       /**
-        * Fallback implementation of mb_strpos, hardcoded to UTF-8.
-        * @param $haystack String
-        * @param $needle String
-        * @param $offset String: optional start position
-        * @param $encoding String: optional encoding; ignored
-        * @return int
-        */
+       
        function mb_strpos( $haystack, $needle, $offset = 0, $encoding = '' ) {
-               $needle = preg_quote( $needle, '/' );
-
-               $ar = array();
-               preg_match( '/' . $needle . '/u', $haystack, $ar, PREG_OFFSET_CAPTURE, $offset );
-
-               if( isset( $ar[0][1] ) ) {
-                       return $ar[0][1];
-               } else {
-                       return false;
-               }
+               return Fallback::mb_strpos( $haystack, $needle, $offset, $encoding );
        }
+       
 }
 
 if( !function_exists( 'mb_strrpos' ) ) {
-       /**
-        * Fallback implementation of mb_strrpos, hardcoded to UTF-8.
-        * @param $haystack String
-        * @param $needle String
-        * @param $offset String: optional start position
-        * @param $encoding String: optional encoding; ignored
-        * @return int
-        */
        function mb_strrpos( $haystack, $needle, $offset = 0, $encoding = '' ) {
-               $needle = preg_quote( $needle, '/' );
-
-               $ar = array();
-               preg_match_all( '/' . $needle . '/u', $haystack, $ar, PREG_OFFSET_CAPTURE, $offset );
-
-               if( isset( $ar[0] ) && count( $ar[0] ) > 0 &&
-                       isset( $ar[0][count( $ar[0] ) - 1][1] ) ) {
-                       return $ar[0][count( $ar[0] ) - 1][1];
-               } else {
-                       return false;
-               }
+               return Fallback::mb_strrpos( $haystack, $needle, $offset, $encoding );
        }
 }
 
+
 // Support for Wietse Venema's taint feature
 if ( !function_exists( 'istainted' ) ) {
        function istainted( $var ) {
@@ -200,6 +74,7 @@ if ( !function_exists( 'istainted' ) ) {
 /// @endcond
 
 
+
 /**
  * Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
  */
@@ -224,15 +99,6 @@ function wfArrayDiff2_cmp( $a, $b ) {
        }
 }
 
-/**
- * Seed Mersenne Twister
- * No-op for compatibility; only necessary in PHP < 4.2.0
- * @deprecated. Remove in 1.18
- */
-function wfSeedRandom() {
-       wfDeprecated(__FUNCTION__);
-}
-
 /**
  * Get a random decimal value between 0 and 1, in a way
  * not likely to give duplicate values for any realistic
@@ -306,7 +172,6 @@ function wfUrlencode( $s ) {
 function wfDebug( $text, $logonly = false ) {
        global $wgOut, $wgDebugLogFile, $wgDebugComments, $wgProfileOnly, $wgDebugRawPage;
        global $wgDebugLogPrefix, $wgShowDebug;
-       static $recursion = 0;
 
        static $cache = array(); // Cache of unoutputted messages
        $text = wfDebugTimer() . $text;
@@ -319,21 +184,11 @@ function wfDebug( $text, $logonly = false ) {
        if ( ( $wgDebugComments || $wgShowDebug ) && !$logonly ) {
                $cache[] = $text;
 
-               if ( !isset( $wgOut ) ) {
-                       return;
+               if ( isset( $wgOut ) && StubObject::isRealObject( $wgOut ) ) {
+                       // add the message and any cached messages to the output
+                       array_map( array( $wgOut, 'debug' ), $cache );
+                       $cache = array();
                }
-               if ( !StubObject::isRealObject( $wgOut ) ) {
-                       if ( $recursion ) {
-                               return;
-                       }
-                       $recursion++;
-                       $wgOut->_unstub();
-                       $recursion--;
-               }
-
-               // add the message and possible cached ones to the output
-               array_map( array( $wgOut, 'debug' ), $cache );
-               $cache = array();
        }
        if ( $wgDebugLogFile != '' && !$wgProfileOnly ) {
                # Strip unprintables; they can switch terminal modes when binary data
@@ -615,6 +470,26 @@ function wfMessage( $key /*...*/) {
        return new Message( $key, $params );
 }
 
+/**
+ * This function accepts multiple message keys and returns a message instance
+ * for the first message which is non-empty. If all messages are empty then an
+ * instance of the first message key is returned.
+ * Varargs: message keys
+ * @return \type{Message}
+ * @since 1.18
+ */
+function wfMessageFallback( /*...*/ ) {
+       $keys = func_get_args();
+       $first = $keys[0];
+       foreach ( $keys as $key ) {
+               if ( wfEmptyMsg( $key ) ) {
+                       continue;
+               }
+               return wfMessage( $key );
+       }
+       return wfMessage( $first );
+}
+
 /**
  * Get a message from anywhere, for the current user language.
  *
@@ -881,12 +756,15 @@ function wfMsgExt( $key, $options ) {
        if( in_array( 'content', $options, true ) ) {
                $forContent = true;
                $langCode = true;
+               $langCodeObj = null;
        } elseif( array_key_exists( 'language', $options ) ) {
                $forContent = false;
                $langCode = wfGetLangObj( $options['language'] );
+               $langCodeObj = $langCode;
        } else {
                $forContent = false;
                $langCode = false;
+               $langCodeObj = null;
        }
 
        $string = wfMsgGetKey( $key, /*DB*/true, $langCode, /*Transform*/false );
@@ -896,9 +774,9 @@ function wfMsgExt( $key, $options ) {
        }
 
        if( in_array( 'parse', $options, true ) ) {
-               $string = $wgOut->parse( $string, true, !$forContent );
+               $string = $wgOut->parse( $string, true, !$forContent, $langCodeObj );
        } elseif ( in_array( 'parseinline', $options, true ) ) {
-               $string = $wgOut->parse( $string, true, !$forContent );
+               $string = $wgOut->parse( $string, true, !$forContent, $langCodeObj );
                $m = array();
                if( preg_match( '/^<p>(.*)\n?<\/p>\n?$/sU', $string, $m ) ) {
                        $string = $m[1];
@@ -907,8 +785,7 @@ function wfMsgExt( $key, $options ) {
                global $wgMessageCache;
                if ( isset( $wgMessageCache ) ) {
                        $string = $wgMessageCache->transform( $string,
-                               !$forContent,
-                               is_object( $langCode ) ? $langCode : null );
+                               !$forContent, $langCodeObj );
                }
        }
 
@@ -1236,9 +1113,9 @@ function wfNumLink( $offset, $limit, $title, $query = '' ) {
  *
  * @return bool Whereas client accept gzip compression
  */
-function wfClientAcceptsGzip() {
+function wfClientAcceptsGzip( $force = false ) {
        static $result = null;
-       if ( $result === null ) {
+       if ( $result === null || $force ) {
                $result = false;
                if( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
                        # FIXME: we may want to blacklist some broken browsers
@@ -1296,30 +1173,6 @@ function wfEscapeWikiText( $text ) {
        return $text;
 }
 
-/**
- * @todo document
- */
-function wfQuotedPrintable( $string, $charset = '' ) {
-       # Probably incomplete; see RFC 2045
-       if( empty( $charset ) ) {
-               global $wgInputEncoding;
-               $charset = $wgInputEncoding;
-       }
-       $charset = strtoupper( $charset );
-       $charset = str_replace( 'ISO-8859', 'ISO8859', $charset ); // ?
-
-       $illegal = '\x00-\x08\x0b\x0c\x0e-\x1f\x7f-\xff=';
-       $replace = $illegal . '\t ?_';
-       if( !preg_match( "/[$illegal]/", $string ) ) {
-               return $string;
-       }
-       $out = "=?$charset?Q?";
-       $out .= preg_replace( "/([$replace])/e", 'sprintf("=%02X",ord("$1"))', $string );
-       $out .= '?=';
-       return $out;
-}
-
-
 /**
  * @todo document
  * @return float
@@ -1331,10 +1184,11 @@ function wfTime() {
 /**
  * Sets dest to source and returns the original value of dest
  * If source is NULL, it just returns the value, it doesn't set the variable
+ * If force is true, it will set the value even if source is NULL
  */
-function wfSetVar( &$dest, $source ) {
+function wfSetVar( &$dest, $source, $force = false ) {
        $temp = $dest;
-       if ( !is_null( $source ) ) {
+       if ( !is_null( $source ) || $force ) {
                $dest = $source;
        }
        return $temp;
@@ -1486,8 +1340,12 @@ function wfEscapeShellArg( ) {
                }
 
                if ( wfIsWindows() ) {
-                       // Escaping for an MSVC-style command line parser
-                       // Ref: http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
+                       // Escaping for an MSVC-style command line parser and CMD.EXE
+                       // Refs:
+                       //  * http://web.archive.org/web/20020708081031/http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
+                       //  * http://technet.microsoft.com/en-us/library/cc723564.aspx
+                       //  * Bug #13518
+                       //  * CR r63214
                        // Double the backslashes before any double quotes. Escape the double quotes.
                        $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE );
                        $arg = '';
@@ -1988,7 +1846,7 @@ function wfTimestamp( $outputtype = TS_UNIX, $ts = 0 ) {
        $da = array();
        $strtime = '';
 
-       if ( $ts === 0 ) {
+       if ( !$ts ) { // We want to catch 0, '', null... but not date strings starting with a letter.
                $uts = time();
                $strtime = "@$uts";
        } elseif ( preg_match( '/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)$/D', $ts, $da ) ) {
@@ -2019,7 +1877,7 @@ function wfTimestamp( $outputtype = TS_UNIX, $ts = 0 ) {
                                                        '\d\d?[ \t\r\n]*[A-Z][a-z]{2}[ \t\r\n]*\d{2}(?:\d{2})?' .  # dd Mon yyyy
                                                        '[ \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
                # TS_RFC2822, accepting a trailing comment. See http://www.squid-cache.org/mail-archive/squid-users/200307/0122.html / r77171
-               # The regex is a superset of rfc2822 for readability 
+               # The regex is a superset of rfc2822 for readability
                $strtime = strtok( $ts, ';' );
        } 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 ) ) {
                # TS_RFC850
@@ -2028,9 +1886,9 @@ function wfTimestamp( $outputtype = TS_UNIX, $ts = 0 ) {
                # asctime
                $strtime = $ts;
        } else {
-               # Bogus value; fall back to the epoch...
-               wfDebug("wfTimestamp() fed bogus time value: $outputtype; $ts\n");
-               
+               # Bogus value...
+               wfDebug("wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n");
+
                return false;
        }
 
@@ -2065,12 +1923,12 @@ function wfTimestamp( $outputtype = TS_UNIX, $ts = 0 ) {
                } else {
                        return false;
                }
-               
+
                if ( !$d ) {
                        wfDebug("wfTimestamp() fed bogus time value: $outputtype; $ts\n");
                        return false;
                }
-               
+
                $output = $d->format( $formats[$outputtype] );
        } else {
                if ( count( $da ) ) {
@@ -2240,7 +2098,7 @@ function wfGetSiteNotice() {
 
 /**
  * BC wrapper for MimeMagic::singleton()
- * @deprecated No longer needed as of 1.17 (r68836).
+ * @deprecated No longer needed as of 1.17 (r68836). Remove in 1.19.
  */
 function &wfGetMimeMagic() {
        wfDeprecated( __FUNCTION__ );
@@ -2408,10 +2266,14 @@ function wfEmptyMsg( $key ) {
  *
  * @param $needle String
  * @param $str String
+ * @param $insensitive Boolean
  * @return Boolean
  */
-function in_string( $needle, $str ) {
-       return strpos( $str, $needle ) !== false;
+function in_string( $needle, $str, $insensitive = false ) {
+       $func = 'strpos';
+       if( $insensitive ) $func = 'stripos';
+       
+       return $func( $str, $needle ) !== false;
 }
 
 function wfSpecialList( $page, $details ) {
@@ -2551,7 +2413,7 @@ function wfShellExec( $cmd, &$retval = null, $environ = array() ) {
                         * Note however that the quote isn't listed there, but is needed, and the parentheses
                         * are listed there but doesn't appear to need it.
                         */
-                       $envcmd .= "set $k=" . preg_replace( '/([&|()<>^"])/', '^\\1', $v ) . ' && ';
+                       $envcmd .= "set $k=" . preg_replace( '/([&|()<>^"])/', '^\\1', $v ) . '&& ';
                } else {
                        /* Assume this is a POSIX shell, thus required to accept variable assignments before the command
                         * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_09_01
@@ -2859,18 +2721,36 @@ function wfMakeUrlIndex( $url ) {
 
 /**
  * Do any deferred updates and clear the list
- * TODO: This could be in Wiki.php if that class made any sense at all
+ *
+ * @param $commit String: set to 'commit' to commit after every update to
+ *                prevent lock contention
  */
-function wfDoUpdates() {
-       global $wgPostCommitUpdateList, $wgDeferredUpdateList;
-       foreach ( $wgDeferredUpdateList as $update ) {
-               $update->doUpdate();
+function wfDoUpdates( $commit = '' ) {
+       global $wgDeferredUpdateList;
+
+       wfProfileIn( __METHOD__ );
+
+       // No need to get master connections in case of empty updates array
+       if ( !count( $wgDeferredUpdateList ) ) {
+               wfProfileOut( __METHOD__ );
+               return;
        }
-       foreach ( $wgPostCommitUpdateList as $update ) {
+
+       $doCommit = $commit == 'commit';
+       if ( $doCommit ) {
+               $dbw = wfGetDB( DB_MASTER );
+       }
+
+       foreach ( $wgDeferredUpdateList as $update ) {
                $update->doUpdate();
+
+               if ( $doCommit && $dbw->trxLevel() ) {
+                       $dbw->commit();
+               }
        }
+
        $wgDeferredUpdateList = array();
-       $wgPostCommitUpdateList = array();
+       wfProfileOut( __METHOD__ );
 }
 
 /**
@@ -2964,27 +2844,10 @@ function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1, $lowercase = t
  * Create an object with a given name and an array of construct parameters
  * @param $name String
  * @param $p Array: parameters
+ * @deprecated
  */
 function wfCreateObject( $name, $p ) {
-       $p = array_values( $p );
-       switch ( count( $p ) ) {
-               case 0:
-                       return new $name;
-               case 1:
-                       return new $name( $p[0] );
-               case 2:
-                       return new $name( $p[0], $p[1] );
-               case 3:
-                       return new $name( $p[0], $p[1], $p[2] );
-               case 4:
-                       return new $name( $p[0], $p[1], $p[2], $p[3] );
-               case 5:
-                       return new $name( $p[0], $p[1], $p[2], $p[3], $p[4] );
-               case 6:
-                       return new $name( $p[0], $p[1], $p[2], $p[3], $p[4], $p[5] );
-               default:
-                       throw new MWException( 'Too many arguments to construtor in wfCreateObject' );
-       }
+       return MWFunction::newObj( $name, $p );
 }
 
 function wfHttpOnlySafe() {
@@ -3175,6 +3038,7 @@ function wfGetLB( $wiki = false ) {
 
 /**
  * Get the load balancer factory object
+ * @return LBFactory
  */
 function &wfGetLBFactory() {
        return LBFactory::singleton();
@@ -3274,9 +3138,10 @@ function wfBoolToStr( $value ) {
 
 /**
  * Load an extension messages file
- * @deprecated in 1.16 (warnings in 1.18, removed in ?)
+ * @deprecated in 1.16, warnings in 1.18, remove in 1.20
  */
 function wfLoadExtensionMessages( $extensionName, $langcode = false ) {
+       wfDeprecated( __FUNCTION__ );
 }
 
 /**
@@ -3395,8 +3260,8 @@ function wfWaitForSlaves( $maxLag, $wiki = false ) {
 }
 
 /**
- * Output some plain text in command-line mode or in the installer (updaters.inc).
- * Do not use it in any other context, its behaviour is subject to change.
+ * Used to be used for outputting text in the installer/updater
+ * @deprecated Warnings in 1.19, removal in 1.20
  */
 function wfOut( $s ) {
        global $wgCommandLineMode;
@@ -3582,23 +3447,3 @@ function wfArrayMap( $function, $input ) {
        }
        return $ret;
 }
-
-/**
- * Returns the PackageRepository object for interaction with the package repository.
- *
- * TODO: Make the repository type also configurable.
- *
- * @since 1.17
- *
- * @return PackageRepository
- */
-function wfGetRepository() {
-       global $wgRepositoryApiLocation;
-       static $repository = false;
-
-       if ( $repository === false ) {
-               $repository = new DistributionRepository( $wgRepositoryApiLocation );
-       }
-
-       return $repository;
-}