coding style tweaks
[lhc/web/wiklou.git] / includes / GlobalFunctions.php
index c1dbb92..81705d3 100644 (file)
@@ -1,15 +1,14 @@
 <?php
+/**
+ * Global functions used everywhere
+ * @file
+ */
 
 if ( !defined( 'MEDIAWIKI' ) ) {
        die( "This file is part of MediaWiki, it is not a valid entry point" );
 }
 
-/**
- * Global functions used everywhere
- */
-
 require_once dirname(__FILE__) . '/normal/UtfNormalUtil.php';
-require_once dirname(__FILE__) . '/XmlFunctions.php';
 
 // Hide compatibility functions from Doxygen
 /// @cond
@@ -26,6 +25,7 @@ if( !function_exists('iconv') ) {
        # 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 );
@@ -33,18 +33,71 @@ if( !function_exists('iconv') ) {
        }
 }
 
-# UTF-8 substr function based on a PHP manual comment
 if ( !function_exists( 'mb_substr' ) ) {
-       function mb_substr( $str, $start ) {
-               $ar = array();
-               preg_match_all( '/./us', $str, $ar );
+       /**
+        * 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( func_num_args() >= 3 ) {
-                       $end = func_get_arg( 2 );
-                       return join( '', array_slice( $ar[0], $start, $end ) );
+               if( $count !== 'end' ) {
+                       $split = mb_substr_split_unicode( $str, intval( $count ) );
+                       $str = substr( $str, 0, $split );
+               }
+
+               return $str;
+       }
+
+       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 {
-                       return join( '', array_slice( $ar[0], $start ) );
+                       $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;
        }
 }
 
@@ -111,29 +164,12 @@ if( !function_exists( 'mb_strrpos' ) ) {
                $ar = array();
                preg_match_all( '/'.$needle.'/u', $haystack, $ar, PREG_OFFSET_CAPTURE, $offset );
 
-               if( isset( $ar[0] ) && count( $ar[0] ) > 0 && 
+               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;
-               } 
-       }
-}
-
-if ( !function_exists( 'array_diff_key' ) ) {
-       /**
-        * Exists in PHP 5.1.0+
-        * Not quite compatible, two-argument version only
-        * Null values will cause problems due to this use of isset()
-        */
-       function array_diff_key( $left, $right ) {
-               $result = $left;
-               foreach ( $left as $key => $unused ) {
-                       if ( isset( $right[$key] ) ) {
-                               unset( $result[$key] );
-                       }
                }
-               return $result;
        }
 }
 
@@ -177,15 +213,6 @@ function wfArrayDiff2_cmp( $a, $b ) {
        }
 }
 
-/**
- * Wrapper for clone(), for compatibility with PHP4-friendly extensions.
- * PHP 5 won't let you declare a 'clone' function, even conditionally,
- * so it has to be a wrapper with a different name.
- */
-function wfClone( $object ) {
-       return clone( $object );
-}
-
 /**
  * Seed Mersenne Twister
  * No-op for compatibility; only necessary in PHP < 4.2.0
@@ -224,16 +251,27 @@ function wfRandom() {
  *
  * ;:@$!*(),/
  *
+ * However, IIS7 redirects fail when the url contains a colon (Bug 22709),
+ * so no fancy : for IIS7.
+ *
  * %2F in the page titles seems to fatally break for some reason.
  *
  * @param $s String:
  * @return string
 */
 function wfUrlencode( $s ) {
+       static $needle;
+       if ( is_null( $needle ) ) {
+               $needle = array( '%3B','%40','%24','%21','%2A','%28','%29','%2C','%2F' );
+               if (! isset($_SERVER['SERVER_SOFTWARE']) || ( strpos($_SERVER['SERVER_SOFTWARE'], "Microsoft-IIS/7") === false)) {
+                       $needle[] = '%3A';
+               }
+       }
+
        $s = urlencode( $s );
        $s = str_ireplace(
-               array( '%3B','%3A','%40','%24','%21','%2A','%28','%29','%2C','%2F' ),
-               array(   ';',  ':',  '@',  '$',  '!',  '*',  '(',  ')',  ',',  '/' ),
+               $needle,
+               array( ';',  '@',  '$',  '!',  '*',  '(',  ')',  ',',  '/',  ':' ),
                $s
        );
 
@@ -255,17 +293,18 @@ function wfUrlencode( $s ) {
  */
 function wfDebug( $text, $logonly = false ) {
        global $wgOut, $wgDebugLogFile, $wgDebugComments, $wgProfileOnly, $wgDebugRawPage;
-       global $wgDebugLogPrefix;
+       global $wgDebugLogPrefix, $wgShowDebug;
        static $recursion = 0;
 
        static $cache = array(); // Cache of unoutputted messages
+       $text = wfDebugTimer() . $text;
 
        # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
        if ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' && !$wgDebugRawPage ) {
                return;
        }
 
-       if ( $wgDebugComments && !$logonly ) {
+       if ( ( $wgDebugComments || $wgShowDebug ) && !$logonly ) {
                $cache[] = $text;
 
                if ( !isset( $wgOut ) ) {
@@ -284,7 +323,7 @@ function wfDebug( $text, $logonly = false ) {
                array_map( array( $wgOut, 'debug' ), $cache );
                $cache = array();
        }
-       if ( '' != $wgDebugLogFile && !$wgProfileOnly ) {
+       if ( $wgDebugLogFile != '' && !$wgProfileOnly ) {
                # Strip unprintables; they can switch terminal modes when binary data
                # gets dumped, which is pretty annoying.
                $text = preg_replace( '![\x00-\x08\x0b\x0c\x0e-\x1f]!', ' ', $text );
@@ -293,6 +332,21 @@ function wfDebug( $text, $logonly = false ) {
        }
 }
 
+function wfDebugTimer() {
+       global $wgDebugTimestamps;
+       if ( !$wgDebugTimestamps ) return '';
+       static $start = null;
+
+       if ( $start === null ) {
+               $start = microtime( true );
+               $prefix = "\n$start";
+       } else {
+               $prefix = sprintf( "%6.4f", microtime( true ) - $start );
+       }
+
+       return $prefix . '  ';
+}
+
 /**
  * Send a line giving PHP memory usage.
  * @param $exact Bool: print exact values instead of kilobytes (default: false)
@@ -348,23 +402,29 @@ function wfLogDBError( $text ) {
 
 /**
  * Log to a file without getting "file size exceeded" signals.
- * 
- * Can also log to TCP or UDP with the syntax udp://host:port/prefix. This will 
+ *
+ * Can also log to TCP or UDP with the syntax udp://host:port/prefix. This will
  * send lines to the specified port, prefixed by the specified prefix and a space.
  */
 function wfErrorLog( $text, $file ) {
        if ( substr( $file, 0, 4 ) == 'udp:' ) {
+               # Needs the sockets extension
                if ( preg_match( '!^(tcp|udp):(?://)?\[([0-9a-fA-F:]+)\]:(\d+)(?:/(.*))?$!', $file, $m ) ) {
                        // IPv6 bracketed host
                        $protocol = $m[1];
                        $host = $m[2];
-                       $port = $m[3];
+                       $port = intval( $m[3] );
                        $prefix = isset( $m[4] ) ? $m[4] : false;
+                       $domain = AF_INET6;
                } elseif ( preg_match( '!^(tcp|udp):(?://)?([a-zA-Z0-9.-]+):(\d+)(?:/(.*))?$!', $file, $m ) ) {
                        $protocol = $m[1];
                        $host = $m[2];
-                       $port = $m[3];
+                       if ( !IP::isIPv4( $host ) ) {
+                               $host = gethostbyname( $host );
+                       }
+                       $port = intval( $m[3] );
                        $prefix = isset( $m[4] ) ? $m[4] : false;
+                       $domain = AF_INET;
                } else {
                        throw new MWException( __METHOD__.": Invalid UDP specification" );
                }
@@ -376,12 +436,12 @@ function wfErrorLog( $text, $file ) {
                        }
                }
 
-               $sock = fsockopen( "$protocol://$host", $port );
+               $sock = socket_create( $domain, SOCK_DGRAM, SOL_UDP );
                if ( !$sock ) {
                        return;
                }
-               fwrite( $sock, $text );
-               fclose( $sock );
+               socket_sendto( $sock, $text, strlen( $text ), 0, $host, $port );
+               socket_close( $sock );
        } else {
                wfSuppressWarnings();
                $exists = file_exists( $file );
@@ -400,7 +460,7 @@ function wfLogProfilingData() {
        global $wgRequestTime, $wgDebugLogFile, $wgDebugRawPage, $wgRequest;
        global $wgProfiler, $wgProfileLimit, $wgUser;
        # Profiling must actually be enabled...
-       if( !isset( $wgProfiler ) ) return;
+       if( is_null( $wgProfiler ) ) return;
        # Get total page request time
        $now = wfTime();
        $elapsed = $now - $wgRequestTime;
@@ -422,7 +482,7 @@ function wfLogProfilingData() {
        $log = sprintf( "%s\t%04.3f\t%s\n",
          gmdate( 'YmdHis' ), $elapsed,
          urldecode( $wgRequest->getRequestURL() . $forward ) );
-       if ( '' != $wgDebugLogFile && ( $wgRequest->getVal('action') != 'raw' || $wgDebugRawPage ) ) {
+       if ( $wgDebugLogFile != '' && ( $wgRequest->getVal('action') != 'raw' || $wgDebugRawPage ) ) {
                wfErrorLog( $log . $prof, $wgDebugLogFile );
        }
 }
@@ -439,7 +499,7 @@ function wfReadOnly() {
        if ( !is_null( $wgReadOnly ) ) {
                return (bool)$wgReadOnly;
        }
-       if ( '' == $wgReadOnlyFile ) {
+       if ( $wgReadOnlyFile == '' ) {
                return false;
        }
        // Set $wgReadOnly for faster access next time
@@ -470,34 +530,51 @@ function wfReadOnlyReason() {
  *                    functionality), or if it is true then use the wikis
  * @return Language object
  */
-function wfGetLangObj( $langcode = false ){
+function wfGetLangObj( $langcode = false ) {
        # Identify which language to get or create a language object for.
-       if( $langcode instanceof Language )
-               # Great, we already have the object!
+       # Using is_object here due to Stub objects.
+       if( is_object( $langcode ) ) {
+               # Great, we already have the object (hopefully)!
                return $langcode;
-               
-       global $wgContLang;
-       if( $langcode === $wgContLang->getCode() || $langcode === true )
+       }
+
+       global $wgContLang, $wgLanguageCode;
+       if( $langcode === true || $langcode === $wgLanguageCode ) {
                # $langcode is the language code of the wikis content language object.
                # or it is a boolean and value is true
                return $wgContLang;
-       
+       }
+
        global $wgLang;
-       if( $langcode === $wgLang->getCode() || $langcode === false )
+       if( $langcode === false || $langcode === $wgLang->getCode() ) {
                # $langcode is the language code of user language object.
                # or it was a boolean and value is false
                return $wgLang;
+       }
 
        $validCodes = array_keys( Language::getLanguageNames() );
-       if( in_array( $langcode, $validCodes ) )
+       if( in_array( $langcode, $validCodes ) ) {
                # $langcode corresponds to a valid language.
                return Language::factory( $langcode );
+       }
 
        # $langcode is a string, but not a valid language code; use content language.
        wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
        return $wgContLang;
 }
 
+/**
+ * Use this instead of $wgContLang, when working with user interface.
+ * User interface is currently hard coded according to wiki content language
+ * in many ways, especially regarding to text direction. There is lots stuff
+ * to fix, hence this function to keep the old behaviour unless the global
+ * $wgBetterDirectionality is enabled (or removed when everything works).
+ */
+function wfUILang() {
+       global $wgBetterDirectionality;
+       return wfGetLangObj( !$wgBetterDirectionality );
+}
+
 /**
  * Get a message from anywhere, for the current user language.
  *
@@ -508,7 +585,7 @@ function wfGetLangObj( $langcode = false ){
  *    defined in languages/Language.php
  *
  * This function also takes extra optional parameters (not
- * shown in the function definition), which can by used to
+ * shown in the function definition), which can be used to
  * insert variable text into the predefined message.
  */
 function wfMsg( $key ) {
@@ -542,8 +619,8 @@ function wfMsgNoTrans( $key ) {
  *
  * Be wary of this distinction: If you use wfMsg() where you should
  * use wfMsgForContent(), a user of the software may have to
- * customize over 70 messages in order to, e.g., fix a link in every
- * possible language.
+ * customize potentially hundreds of messages in
+ * order to, e.g., fix a link in every possible language.
  *
  * @param $key String: lookup key for the message, usually
  *    defined in languages/Language.php
@@ -602,8 +679,8 @@ function wfMsgNoDBForContent( $key ) {
  * @param $key String: key to get.
  * @param $args
  * @param $useDB Boolean
+ * @param $forContent Mixed: Language code, or false for user lang, true for content lang.
  * @param $transform Boolean: Whether or not to transform the message.
- * @param $forContent Boolean
  * @return String: the requested message.
  */
 function wfMsgReal( $key, $args, $useDB = true, $forContent = false, $transform = true ) {
@@ -634,33 +711,22 @@ function wfMsgWeirdKey( $key ) {
  *                  behaves as a content language switch if it is a boolean.
  * @param $transform Boolean: whether to parse magic words, etc.
  * @return string
- * @private
  */
 function wfMsgGetKey( $key, $useDB, $langCode = false, $transform = true ) {
-       global $wgContLang, $wgMessageCache;
+       global $wgMessageCache;
 
        wfRunHooks('NormalizeMessageKey', array(&$key, &$useDB, &$langCode, &$transform));
-       
-       # If $wgMessageCache isn't initialised yet, try to return something sensible.
-       if( is_object( $wgMessageCache ) ) {
-               $message = $wgMessageCache->get( $key, $useDB, $langCode );
-               if ( $transform ) {
-                       $message = $wgMessageCache->transform( $message );
-               }
-       } else {
-               $lang = wfGetLangObj( $langCode );
-
-               # MessageCache::get() does this already, Language::getMessage() doesn't
-               # ISSUE: Should we try to handle "message/lang" here too?
-               $key = str_replace( ' ' , '_' , $wgContLang->lcfirst( $key ) );
 
-               if( is_object( $lang ) ) {
-                       $message = $lang->getMessage( $key );
-               } else {
-                       $message = false;
-               }
+       if ( !is_object( $wgMessageCache ) ) {
+               throw new MWException( "Trying to get message before message cache is initialised" );
        }
 
+       $message = $wgMessageCache->get( $key, $useDB, $langCode );
+       if( $message === false ){
+               $message = '&lt;' . htmlspecialchars( $key ) . '&gt;';
+       } elseif ( $transform ) {
+               $message = $wgMessageCache->transform( $message );
+       }
        return $message;
 }
 
@@ -735,7 +801,7 @@ function wfMsgWikiHtml( $key ) {
  *   <i>parseinline</i>: parses wikitext to html and removes the surrounding
  *       p's added by parser or tidy
  *   <i>escape</i>: filters message through htmlspecialchars
- *   <i>escapenoentities</i>: same, but allows entity references like &nbsp; through
+ *   <i>escapenoentities</i>: same, but allows entity references like &#160; through
  *   <i>replaceafter</i>: parameters are substituted after parsing or escaping
  *   <i>parsemag</i>: transform the message using magic phrases
  *   <i>content</i>: fetch message for content language instead of interface
@@ -1016,7 +1082,7 @@ function wfShowingResults( $offset, $limit ) {
  */
 function wfShowingResultsNum( $offset, $limit, $num ) {
        global $wgLang;
-       return wfMsgExt( 'showingresultsnum', array( 'parseinline' ), $wgLang->formatNum( $limit ), 
+       return wfMsgExt( 'showingresultsnum', array( 'parseinline' ), $wgLang->formatNum( $limit ),
                $wgLang->formatNum( $offset+1 ), $wgLang->formatNum( $num ) );
 }
 
@@ -1056,7 +1122,7 @@ function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) {
                        $q .= '&'.$query;
                }
                $plink = '<a href="' . $title->escapeLocalUrl( $q ) . "\" title=\"{$pTitle}\" class=\"mw-prevlink\">{$prev}</a>";
-       } else { 
+       } else {
                $plink = $prev;
        }
        # Make 'next' link
@@ -1071,7 +1137,7 @@ function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) {
                $nlink = '<a href="' . $title->escapeLocalUrl( $q ) . "\" title=\"{$nTitle}\" class=\"mw-nextlink\">{$next}</a>";
        }
        # Make links to set number of items per page
-       $nums = $wgLang->pipeList( array( 
+       $nums = $wgLang->pipeList( array(
                wfNumLink( $offset, 20, $title, $query ),
                wfNumLink( $offset, 50, $title, $query ),
                wfNumLink( $offset, 100, $title, $query ),
@@ -1090,9 +1156,9 @@ function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) {
  */
 function wfNumLink( $offset, $limit, $title, $query = '' ) {
        global $wgLang;
-       if( $query == '' ) { 
+       if( $query == '' ) {
                $q = '';
-       } else { 
+       } else {
                $q = $query.'&';
        }
        $q .= "limit={$limit}&offset={$offset}";
@@ -1109,8 +1175,7 @@ function wfNumLink( $offset, $limit, $title, $query = '' ) {
  * @return bool Whereas client accept gzip compression
  */
 function wfClientAcceptsGzip() {
-       global $wgUseGzip;
-       if( $wgUseGzip ) {
+       if( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
                # FIXME: we may want to blacklist some broken browsers
                $m = array();
                if( preg_match(
@@ -1219,7 +1284,7 @@ function wfSetBit( &$dest, $bit, $state = true ) {
  * "days=7&limit=100". Options in the first array override options in the second.
  * Options set to "" will not be output.
  */
-function wfArrayToCGI( $array1, $array2 = NULL )
+function wfArrayToCGI( $array1, $array2 = null )
 {
        if ( !is_null( $array2 ) ) {
                $array1 = $array1 + $array2;
@@ -1227,8 +1292,8 @@ function wfArrayToCGI( $array1, $array2 = NULL )
 
        $cgi = '';
        foreach ( $array1 as $key => $value ) {
-               if ( '' !== $value ) {
-                       if ( '' != $cgi ) {
+               if ( $value !== '' ) {
+                       if ( $cgi != '' ) {
                                $cgi .= '&';
                        }
                        if ( is_array( $value ) ) {
@@ -1303,13 +1368,20 @@ function wfAppendQuery( $url, $query ) {
 }
 
 /**
- * Expand a potentially local URL to a fully-qualified URL.
- * Assumes $wgServer is correct. :)
+ * Expand a potentially local URL to a fully-qualified URL.  Assumes $wgServer
+ * and $wgProto are correct.
+ *
+ * @todo this won't work with current-path-relative URLs
+ * like "subdir/foo.html", etc.
+ *
  * @param $url String: either fully-qualified or a local path + query
  * @return string Fully-qualified URL
  */
 function wfExpandUrl( $url ) {
-       if( substr( $url, 0, 1 ) == '/' ) {
+       if( substr( $url, 0, 2 ) == '//' ) {
+               global $wgProto;
+               return $wgProto . ':' . $url;
+       } elseif( substr( $url, 0, 1 ) == '/' ) {
                global $wgServer;
                return $wgServer . $url;
        } else {
@@ -1330,7 +1402,7 @@ function wfPurgeSquidServers ($urlArr) {
  * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
  * function puts single quotes in regardless of OS.
  *
- * Also fixes the locale problems on Linux in PHP 5.2.6+ (bug backported to 
+ * Also fixes the locale problems on Linux in PHP 5.2.6+ (bug backported to
  * earlier distro releases of PHP)
  */
 function wfEscapeShellArg( ) {
@@ -1352,14 +1424,19 @@ function wfEscapeShellArg( ) {
                        // Double the backslashes before any double quotes. Escape the double quotes.
                        $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE );
                        $arg = '';
-                       $delim = false;
+                       $iteration = 0;
                        foreach ( $tokens as $token ) {
-                               if ( $delim ) {
+                               if ( $iteration % 2 == 1 ) {
+                                       // Delimiter, a double quote preceded by zero or more slashes
                                        $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
-                               } else {
+                               } else if ( $iteration % 4 == 2 ) {
+                                       // ^ in $token will be outside quotes, need to be escaped
+                                       $arg .= str_replace( '^', '^^', $token );
+                               } else { // $iteration % 4 == 0
+                                       // ^ in $token will appear inside double quotes, so leave as is
                                        $arg .= $token;
                                }
-                               $delim = !$delim;
+                               $iteration++;
                        }
                        // Double the backslashes before the end of the string, because
                        // we will soon add a quote
@@ -1430,7 +1507,7 @@ function wfMerge( $old, $mine, $yours, &$result ){
        pclose( $handle );
        unlink( $mytextName ); unlink( $oldtextName ); unlink( $yourtextName );
 
-       if ( $result === '' && $old !== '' && $conflict == false ) {
+       if ( $result === '' && $old !== '' && !$conflict ) {
                wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
                $conflict = true;
        }
@@ -1449,7 +1526,7 @@ function wfDiff( $before, $after, $params = '-u' ) {
        if ($before == $after) {
                return '';
        }
-       
+
        global $wgDiff;
 
        # This check may also protect against code injection in
@@ -1468,14 +1545,14 @@ function wfDiff( $before, $after, $params = '-u' ) {
 
        fwrite( $oldtextFile, $before ); fclose( $oldtextFile );
        fwrite( $newtextFile, $after ); fclose( $newtextFile );
-       
+
        // Get the diff of the two files
        $cmd = "$wgDiff " . $params . ' ' .wfEscapeShellArg( $oldtextName, $newtextName );
-       
+
        $h = popen( $cmd, 'r' );
-       
+
        $diff = '';
-       
+
        do {
                $data = fread( $h, 8192 );
                if ( strlen( $data ) == 0 ) {
@@ -1483,12 +1560,12 @@ function wfDiff( $before, $after, $params = '-u' ) {
                }
                $diff .= $data;
        } while ( true );
-       
+
        // Clean up
        pclose( $h );
        unlink( $oldtextName );
        unlink( $newtextName );
-       
+
        // Kill the --- and +++ lines. They're not useful.
        $diff_lines = explode( "\n", $diff );
        if (strpos( $diff_lines[0], '---' ) === 0) {
@@ -1497,9 +1574,9 @@ function wfDiff( $before, $after, $params = '-u' ) {
        if (strpos( $diff_lines[1], '+++' ) === 0) {
                unset($diff_lines[1]);
        }
-       
+
        $diff = implode( "\n", $diff_lines );
-       
+
        return $diff;
 }
 
@@ -1655,7 +1732,7 @@ function mimeTypeMatch( $type, $avail ) {
                } elseif( array_key_exists( '*/*', $avail ) ) {
                        return '*/*';
                } else {
-                       return NULL;
+                       return null;
                }
        }
 }
@@ -1697,7 +1774,7 @@ function wfNegotiateType( $cprefs, $sprefs ) {
        }
 
        $bestq = 0;
-       $besttype = NULL;
+       $besttype = null;
 
        foreach( array_keys( $combine ) as $type ) {
                if( $combine[$type] > $bestq ) {
@@ -1745,7 +1822,7 @@ function wfSuppressWarnings( $end = false ) {
                }
        } else {
                if ( !$suppressCount ) {
-                       $originalLevel = error_reporting( E_ALL & ~( E_WARNING | E_NOTICE ) );
+                       $originalLevel = error_reporting( E_ALL & ~( E_WARNING | E_NOTICE | E_USER_WARNING | E_USER_NOTICE ) );
                }
                ++$suppressCount;
        }
@@ -1829,7 +1906,7 @@ function wfTimestamp( $outputtype = TS_UNIX, $ts = 0 ) {
                # TS_EXIF
        } elseif (preg_match('/^(\d{4})(\d\d)(\d\d)(\d\d)(\d\d)(\d\d)$/D',$ts,$da)) {
                # TS_MW
-       } elseif (preg_match('/^\d{1,13}$/D',$ts)) {
+       } elseif (preg_match('/^-?\d{1,13}$/D',$ts)) {
                # TS_UNIX
                $uts = $ts;
        } elseif (preg_match('/^\d{2}-\d{2}-\d{4} \d{2}:\d{2}:\d{2}.\d{6}$/', $ts)) {
@@ -1964,7 +2041,7 @@ function wfGetCachedNotice( $name ) {
                        $notice = '';
                }
        }
-
+       $notice = '<div id="localNotice">'.$notice.'</div>';
        wfProfileOut( $fname );
        return $notice;
 }
@@ -1992,7 +2069,7 @@ function wfGetNamespaceNotice() {
 }
 
 function wfGetSiteNotice() {
-       global $wgUser, $wgSiteNotice;
+       global $wgUser;
        $fname = 'wfGetSiteNotice';
        wfProfileIn( $fname );
        $siteNotice = '';
@@ -2023,20 +2100,26 @@ function wfGetSiteNotice() {
  * @deprecated
  */
 function &wfGetMimeMagic() {
+       wfDeprecated( __FUNCTION__ );
        return MimeMagic::singleton();
 }
 
 /**
- * Tries to get the system directory for temporary files.
- * The TMPDIR, TMP, and TEMP environment variables are checked in sequence,
- * and if none are set /tmp is returned as the generic Unix default.
+ * Tries to get the system directory for temporary files. For PHP >= 5.2.1,
+ * we'll use sys_get_temp_dir(). The TMPDIR, TMP, and TEMP environment
+ * variables are then checked in sequence, and if none are set /tmp is
+ * returned as the generic Unix default.
+ * It is common to call it with tempnam().
  *
- * NOTE: When possible, use the tempfile() function to create temporary
- * files to avoid race conditions on file creation, etc.
+ * NOTE: When possible, use instead the tmpfile() function to create
+ * temporary files to avoid race conditions on file creation, etc.
  *
  * @return String
  */
 function wfTempDir() {
+       if( function_exists( 'sys_get_temp_dir' ) ) {
+               return sys_get_temp_dir();
+       }
        foreach( array( 'TMPDIR', 'TMP', 'TEMP' ) as $var ) {
                $tmp = getenv( $var );
                if( $tmp && file_exists( $tmp ) && is_dir( $tmp ) && is_writable( $tmp ) ) {
@@ -2049,7 +2132,7 @@ function wfTempDir() {
 
 /**
  * Make directory, and make all parent directories if they don't exist
- * 
+ *
  * @param $dir String: full path to directory to create
  * @param $mode Integer: chmod value to use, default is $wgDirectoryMode
  * @param $caller String: optional caller param for debugging.
@@ -2070,7 +2153,16 @@ function wfMkdirParents( $dir, $mode = null, $caller = null ) {
        if ( is_null( $mode ) )
                $mode = $wgDirectoryMode;
 
-       return mkdir( $dir, $mode, true );  // PHP5 <3
+       // Turn off the normal warning, we're doing our own below
+       wfSuppressWarnings();
+       $ok = mkdir( $dir, $mode, true );  // PHP5 <3
+       wfRestoreWarnings();
+
+       if( !$ok ) {
+               // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
+               trigger_error( __FUNCTION__ . ": failed to mkdir \"$dir\" mode $mode", E_USER_WARNING );
+       }
+       return $ok;
 }
 
 /**
@@ -2142,12 +2234,12 @@ function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
  * looked up didn't exist but a XHTML string, this function checks for the
  * nonexistance of messages by looking at wfMsg() output
  *
- * @param $msg      String: the message key looked up
- * @param $wfMsgOut String: the output of wfMsg*()
- * @return Boolean
+ * @param $key      String: the message key looked up
+ * @return Boolean True if the message *doesn't* exist.
  */
-function wfEmptyMsg( $msg, $wfMsgOut ) {
-       return $wfMsgOut === htmlspecialchars( "<$msg>" );
+function wfEmptyMsg( $key ) {
+       global $wgMessageCache;
+       return $wgMessageCache->get( $key, /*useDB*/true, /*content*/false ) === false;
 }
 
 /**
@@ -2175,6 +2267,10 @@ function wfSpecialList( $page, $details ) {
 function wfUrlProtocols() {
        global $wgUrlProtocols;
 
+       static $retval = null;
+       if ( !is_null( $retval ) )
+               return $retval;
+
        // Support old-style $wgUrlProtocols strings, for backwards compatibility
        // with LocalSettings files from 1.5
        if ( is_array( $wgUrlProtocols ) ) {
@@ -2182,10 +2278,11 @@ function wfUrlProtocols() {
                foreach ($wgUrlProtocols as $protocol)
                        $protocols[] = preg_quote( $protocol, '/' );
 
-               return implode( '|', $protocols );
+               $retval = implode( '|', $protocols );
        } else {
-               return $wgUrlProtocols;
+               $retval = $wgUrlProtocols;
        }
+       return $retval;
 }
 
 /**
@@ -2220,6 +2317,30 @@ function wfIniGetBool( $setting ) {
                || preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
 }
 
+/**
+ * Wrapper function for PHP's dl(). This doesn't work in most situations from
+ * PHP 5.3 onward, and is usually disabled in shared environments anyway.
+ *
+ * @param $extension String A PHP extension. The file suffix (.so or .dll)
+ *                          should be omitted
+ * @return Bool - Whether or not the extension is loaded
+ */
+function wfDl( $extension ) {
+       if( extension_loaded( $extension ) ) {
+               return true;
+       }
+
+       $canDl = ( function_exists( 'dl' ) && is_callable( 'dl' )
+               && wfIniGetBool( 'enable_dl' ) && !wfIniGetBool( 'safe_mode' ) );
+
+       if( $canDl ) {
+               wfSuppressWarnings();
+               dl( $extension . '.' . PHP_SHLIB_SUFFIX );
+               wfRestoreWarnings();
+       }
+       return extension_loaded( $extension );
+}
+
 /**
  * Execute a shell command, with time and memory limits mirrored from the PHP
  * configuration if supported.
@@ -2264,10 +2385,13 @@ function wfShellExec( $cmd, &$retval=null ) {
                                $cmd = escapeshellarg( $script ) . " $time $mem $filesize " . escapeshellarg( $cmd );
                        }
                }
-       } elseif ( php_uname( 's' ) == 'Windows NT' ) {
+       } elseif ( php_uname( 's' ) == 'Windows NT' &&
+               version_compare( PHP_VERSION, '5.3.0', '<' ) )
+       {
                # This is a hack to work around PHP's flawed invocation of cmd.exe
                # http://news.php.net/php.internals/21796
-               $cmd = '"' . $cmd . '"'; // FIXME: breaking Vista sp2/PHP 5.2.9(2)
+               # Which is fixed in 5.3.0 :)
+               $cmd = '"' . $cmd . '"';
        }
        wfDebug( "wfShellExec: $cmd\n" );
 
@@ -2283,41 +2407,6 @@ function wfShellExec( $cmd, &$retval=null ) {
        return $output;
 }
 
-/**
- * Executes a shell command in the background. Passes back the PID of the operation 
- *
- * @param $cmd String
- */
-function wfShellBackgroundExec( $cmd ){        
-       wfDebug( "wfShellBackgroundExec: $cmd\n" );
-       
-       if ( ! wfShellExecEnabled() ) {
-               return "Unable to run external programs";
-       }
-       
-       $pid = shell_exec( "nohup $cmd > /dev/null & echo $!" );
-       return $pid;
-}
-
-/**
- * Checks if the current instance can execute a shell command
- *
- */
-function wfShellExecEnabled(){                 
-       if( wfIniGetBool( 'safe_mode' ) ) {
-               wfDebug( "wfShellExec can't run in safe_mode, PHP's exec functions are too broken.\n" );
-               return false;
-       }
-       $functions = explode( ',', ini_get( 'disable_functions' ) );
-       $functions = array_map( 'trim', $functions );
-       $functions = array_map( 'strtolower', $functions );
-       if ( in_array( 'passthru', $functions ) ) {
-               wfDebug( "passthru is in disabled_functions\n" );
-               return false;
-       }
-       return true;
-}
-
 /**
  * Workaround for http://bugs.php.net/bug.php?id=45132
  * escapeshellarg() destroys non-ASCII characters if LANG is not a UTF-8 locale
@@ -2375,13 +2464,6 @@ function wfUseMW( $req_ver ) {
                throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
 }
 
-/**
- * @deprecated use StringUtils::escapeRegexReplacement
- */
-function wfRegexReplacement( $string ) {
-       return StringUtils::escapeRegexReplacement( $string );
-}
-
 /**
  * Return the final portion of a pathname.
  * Reimplemented because PHP5's basename() is buggy with multibyte text.
@@ -2472,24 +2554,26 @@ function wfArrayMerge( $array1/* ... */ ) {
 /**
  * Merge arrays in the style of getUserPermissionsErrors, with duplicate removal
  * e.g.
- *     wfMergeErrorArrays( 
- *             array( array( 'x' ) ), 
- *             array( array( 'x', '2' ) ), 
- *             array( array( 'x' ) ), 
+ *     wfMergeErrorArrays(
+ *             array( array( 'x' ) ),
+ *             array( array( 'x', '2' ) ),
+ *             array( array( 'x' ) ),
  *             array( array( 'y') )
  *     );
  * returns:
- *             array( 
+ *             array(
  *             array( 'x', '2' ),
  *             array( 'x' ),
  *             array( 'y' )
  *     )
  */
-function wfMergeErrorArrays(/*...*/) {
+function wfMergeErrorArrays( /*...*/ ) {
        $args = func_get_args();
        $out = array();
        foreach ( $args as $errors ) {
                foreach ( $errors as $params ) {
+                       # FIXME: sometimes get nested arrays for $params,
+                       # which leads to E_NOTICEs
                        $spec = implode( "\t", $params );
                        $out[$spec] = $params;
                }
@@ -2591,13 +2675,6 @@ function wfDoUpdates()
        $wgPostCommitUpdateList = array();
 }
 
-/**
- * @deprecated use StringUtils::explodeMarkup
- */
-function wfExplodeMarkup( $separator, $text ) {
-       return StringUtils::explodeMarkup( $separator, $text );
-}
-
 /**
  * Convert an arbitrarily-long digit string from one numeric base
  * to another, optionally zero-padding to a minimum column width.
@@ -2712,27 +2789,6 @@ function wfCreateObject( $name, $p ){
        }
 }
 
-/**
- * Alias for modularized function
- * @deprecated Use Http::get() instead
- */
-function wfGetHTTP( $url ) {
-       wfDeprecated(__FUNCTION__);
-       $status = Http::get( $url );
-       if( $status->isOK() )
-               return $status->value;          
-       return null;
-}
-
-/**
- * Alias for modularized function
- * @deprecated Use Http::isLocalURL() instead
- */
-function wfIsLocalURL( $url ) {
-       wfDeprecated(__FUNCTION__);
-       return Http::isLocalURL( $url );
-}
-
 function wfHttpOnlySafe() {
        global $wgHttpOnlyBlacklist;
        if( !version_compare("5.2", PHP_VERSION, "<") )
@@ -2745,7 +2801,7 @@ function wfHttpOnlySafe() {
                        }
                }
        }
-       
+
        return true;
 }
 
@@ -2753,7 +2809,7 @@ function wfHttpOnlySafe() {
  * Initialise php session
  */
 function wfSetupSession() {
-       global $wgSessionsInMemcached, $wgCookiePath, $wgCookieDomain, 
+       global $wgSessionsInMemcached, $wgCookiePath, $wgCookieDomain,
                        $wgCookieSecure, $wgCookieHttpOnly, $wgSessionHandler;
        if( $wgSessionsInMemcached ) {
                require_once( 'MemcachedSessions.php' );
@@ -2812,11 +2868,19 @@ function wfGetCaller( $level = 2 ) {
 }
 
 /**
- * Return a string consisting all callers in stack, somewhat useful sometimes
- * for profiling specific points
+ * Return a string consisting of callers in the stack. Useful sometimes
+ * for profiling specific points.
+ *
+ * @param $limit The maximum depth of the stack frame to return, or false for
+ *               the entire stack.
  */
-function wfGetAllCallers() {
-       return implode('/', array_map('wfFormatStackFrame',array_reverse(wfDebugBacktrace())));
+function wfGetAllCallers( $limit = 3 ) {
+       $trace = array_reverse( wfDebugBacktrace() );
+       if ( !$limit || $limit > count( $trace ) - 1 ) {
+               $limit = count( $trace ) - 1;
+       }
+       $trace = array_slice( $trace, -$limit - 1, $limit );
+       return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
 }
 
 /**
@@ -2834,6 +2898,7 @@ function wfFormatStackFrame($frame) {
 function wfMemcKey( /*... */ ) {
        $args = func_get_args();
        $key = wfWikiID() . ':' . implode( ':', $args );
+       $key = str_replace( ' ', '_', $key );
        return $key;
 }
 
@@ -2914,25 +2979,31 @@ function &wfGetLBFactory() {
 /**
  * Find a file.
  * Shortcut for RepoGroup::singleton()->findFile()
- * @param $title Title object or string. May be interwiki.
- * @param $time Mixed: requested time for an archived image, or false for the
- *              current version. An image object will be returned which was
- *              created at the specified time.
- * @param $flags Mixed: FileRepo::FIND_ flags
- * @param $bypass Boolean: bypass the file cache even if it could be used
+ * @param $title Either a string or Title object
+ * @param $options Associative array of options:
+ *     time:           requested time for an archived image, or false for the
+ *                     current version. An image object will be returned which was
+ *                     created at the specified time.
+ *
+ *     ignoreRedirect: If true, do not follow file redirects
+ *
+ *     private:        If true, return restricted (deleted) files if the current
+ *                     user is allowed to view them. Otherwise, such files will not
+ *                     be found.
+ *
+ *     bypassCache:    If true, do not use the process-local cache of File objects
+ *
  * @return File, or false if the file does not exist
  */
-function wfFindFile( $title, $time = false, $flags = 0, $bypass = false ) {
-        if( !$time && !$flags && !$bypass ) {
-               return FileCache::singleton()->findFile( $title );
-       } else {
-               return RepoGroup::singleton()->findFile( $title, $time, $flags );
-       }
+function wfFindFile( $title, $options = array() ) {
+       return RepoGroup::singleton()->findFile( $title, $options );
 }
 
 /**
  * Get an object referring to a locally registered file.
  * Returns a valid placeholder object if the file does not exist.
+ * @param $title Either a string or Title object
+ * @return File, or null if passed an invalid Title
  */
 function wfLocalFile( $title ) {
        return RepoGroup::singleton()->getLocalRepo()->newFile( $title );
@@ -2998,7 +3069,7 @@ function wfBoolToStr( $value ) {
 
 /**
  * Load an extension messages file
- * @deprecated
+ * @deprecated in 1.16 (warnings in 1.18, removed in ?)
  */
 function wfLoadExtensionMessages( $extensionName, $langcode = false ) {
 }
@@ -3048,6 +3119,16 @@ function wfDeprecated( $function ) {
        }
 }
 
+/**
+ * Send a warning either to the debug log or in a PHP error depending on
+ * $wgDevelopmentWarnings
+ *
+ * @param $msg String: message to send
+ * @param $callerOffset Integer: number of itmes to go back in the backtrace to
+ *        find the correct caller (1 = function calling wfWarn, ...)
+ * @param $level Integer: PHP error level; only used when $wgDevelopmentWarnings
+ *        is true
+ */
 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE ) {
        $callers = wfDebugBacktrace();
        if( isset( $callers[$callerOffset+1] ) ){
@@ -3084,12 +3165,13 @@ function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE ) {
  * to use this outside maintenance scripts in its present form.
  *
  * @param $maxLag Integer
+ * @param $wiki mixed Wiki identifier accepted by wfGetLB
  * @return null
  */
-function wfWaitForSlaves( $maxLag ) {
+function wfWaitForSlaves( $maxLag, $wiki = false ) {
        if( $maxLag ) {
-               $lb = wfGetLB();
-               list( $host, $lag ) = $lb->getMaxLag();
+               $lb = wfGetLB( $wiki );
+               list( $host, $lag ) = $lb->getMaxLag( $wiki );
                while( $lag > $maxLag ) {
                        $name = @gethostbyaddr( $host );
                        if( $name !== false ) {
@@ -3118,14 +3200,14 @@ function wfOut( $s ) {
 }
 
 /**
- * Count down from $n to zero on the terminal, with a one-second pause 
+ * Count down from $n to zero on the terminal, with a one-second pause
  * between showing each number. For use in command-line scripts.
  */
 function wfCountDown( $n ) {
        for ( $i = $n; $i >= 0; $i-- ) {
                if ( $i != $n ) {
                        echo str_repeat( "\x08", strlen( $i + 1 ) );
-               } 
+               }
                echo $i;
                flush();
                if ( $i ) {
@@ -3150,8 +3232,9 @@ function wfGenerateToken( $salt = '' ) {
  * @param $name Mixed: filename to process
  */
 function wfStripIllegalFilenameChars( $name ) {
+       global $wgIllegalFileChars;
        $name = wfBaseName( $name );
-       $name = preg_replace ( "/[^".Title::legalChars()."]|:/", '-', $name );
+       $name = preg_replace("/[^".Title::legalChars()."]".($wgIllegalFileChars ? "|[".$wgIllegalFileChars."]":"")."/",'-',$name);
        return $name;
 }
 
@@ -3165,52 +3248,113 @@ function wfArrayInsertAfter( $array, $insert, $after ) {
        // Find the offset of the element to insert after.
        $keys = array_keys($array);
        $offsetByKey = array_flip( $keys );
-       
+
        $offset = $offsetByKey[$after];
-       
+
        // Insert at the specified offset
        $before = array_slice( $array, 0, $offset + 1, true );
        $after = array_slice( $array, $offset + 1, count($array)-$offset, true );
-       
+
        $output = $before + $insert + $after;
-       
+
        return $output;
 }
 
 /* Recursively converts the parameter (an object) to an array with the same data */
 function wfObjectToArray( $object, $recursive = true ) {
        $array = array();
-       foreach ( get_object_vars($object) as $key => $value ) {
-               if ( is_object($value) && $recursive ) {
+       foreach ( get_object_vars( $object ) as $key => $value ) {
+               if ( is_object( $value ) && $recursive ) {
                        $value = wfObjectToArray( $value );
                }
-               
+
                $array[$key] = $value;
        }
-       
+
        return $array;
 }
 
-/* Get the normalised IETF language tag */
+/**
+ * Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit;
+ * @return Integer value memory was set to.
+ */
+function wfMemoryLimit() {
+       global $wgMemoryLimit;
+       $memlimit = wfShorthandToInteger( ini_get( "memory_limit" ) );
+       $conflimit = wfShorthandToInteger( $wgMemoryLimit );
+       if( $memlimit != -1 ) {
+               if( $conflimit == -1 ) {
+                       wfDebug( "Removing PHP's memory limit\n" );
+                       wfSuppressWarnings();
+                       ini_set( "memory_limit", $conflimit );
+                       wfRestoreWarnings();
+                       return $conflimit;
+               } elseif ( $conflimit > $memlimit ) {
+                       wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
+                       wfSuppressWarnings();
+                       ini_set( "memory_limit", $conflimit );
+                       wfRestoreWarnings();
+                       return $conflimit;
+               }
+       }
+       return $memlimit;
+}
+
+/**
+ * Converts shorthand byte notation to integer form
+ * @param $string String
+ * @return Integer
+ */
+function wfShorthandToInteger ( $string = '' ) {
+       $string = trim($string);
+       if( empty($string) ) { return -1; }
+       $last = strtolower($string[strlen($string)-1]);
+       $val = intval($string);
+       switch($last) {
+               case 'g':
+                       $val *= 1024;
+               case 'm':
+                       $val *= 1024;
+               case 'k':
+                       $val *= 1024;
+       }
+
+       return $val;
+}
+
+/* Get the normalised IETF language tag
+ * @param $code String: The language code.
+ * @return $langCode String: The language code which complying with BCP 47 standards.
+ */
 function wfBCP47( $code ) {
        $codeSegment = explode( '-', $code );
        foreach ( $codeSegment as $segNo => $seg ) {
                if ( count( $codeSegment ) > 0 ) {
                        // ISO 3166 country code
                        if ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) )
-                               $codeBCP[$segNo] = strtoupper ( $seg );
+                               $codeBCP[$segNo] = strtoupper( $seg );
                        // ISO 15924 script code
                        else if ( ( strlen( $seg ) == 4 ) && ( $segNo > 0 ) )
                                $codeBCP[$segNo] = ucfirst( $seg );
+                       // Use lowercase for other cases
                        else
-                       // Keep casing for other cases
-                               $codeBCP[$segNo] = $seg;
+                               $codeBCP[$segNo] = strtolower( $seg );
                } else {
-               // Keep casing for single segment
-                       $codeBCP[$segNo] = $seg;
+               // Use lowercase for single segment
+                       $codeBCP[$segNo] = strtolower( $seg );
                }
        }
        $langCode = implode ( '-' , $codeBCP );
        return $langCode;
 }
 
+function wfArrayMap( $function, $input ) {
+       $ret = array_map( $function, $input );
+       foreach ( $ret as $key => $value ) {
+               $taint = istainted( $input[$key] );
+               if ( $taint ) {
+                       taint( $ret[$key], $taint );
+               }
+       }
+       return $ret;
+}