Add support for Number grouping(commafy) based on CLDR number grouping patterns like...
[lhc/web/wiklou.git] / includes / GlobalFunctions.php
index 2b16d17..cbe28c2 100644 (file)
@@ -164,7 +164,7 @@ function wfArrayMerge( $array1/* ... */ ) {
  *             array( array( 'x' ) ),
  *             array( array( 'x', '2' ) ),
  *             array( array( 'x' ) ),
- *             array( array( 'y') )
+ *             array( array( 'y' ) )
  *     );
  * returns:
  *             array(
@@ -298,7 +298,7 @@ function wfUrlencode( $s ) {
                $needle = null;
                return;
        }
-       
+
        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 ) ) {
@@ -431,13 +431,14 @@ function wfAppendQuery( $url, $query ) {
 /**
  * Expand a potentially local URL to a fully-qualified URL.  Assumes $wgServer
  * is correct.
- * 
+ *
  * The meaning of the PROTO_* constants is as follows:
  * PROTO_HTTP: Output a URL starting with http://
  * PROTO_HTTPS: Output a URL starting with https://
  * PROTO_RELATIVE: Output a URL starting with // (protocol-relative URL)
  * PROTO_CURRENT: Output a URL starting with either http:// or https:// , depending on which protocol was used for the current incoming request
  * PROTO_CANONICAL: For URLs without a domain, like /w/index.php , use $wgCanonicalServer. For protocol-relative URLs, use the protocol of $wgCanonicalServer
+ * PROTO_INTERNAL: Like PROTO_CANONICAL, but uses $wgInternalServer instead of $wgCanonicalServer
  *
  * @todo this won't work with current-path-relative URLs
  * like "subdir/foo.html", etc.
@@ -447,29 +448,35 @@ function wfAppendQuery( $url, $query ) {
  * @return string Fully-qualified URL
  */
 function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT ) {
-       global $wgServer, $wgCanonicalServer;
-       $serverUrl = $defaultProto === PROTO_CANONICAL ? $wgCanonicalServer : $wgServer;
-       
+       global $wgServer, $wgCanonicalServer, $wgInternalServer;
+       $serverUrl = $wgServer;
+       if ( $defaultProto === PROTO_CANONICAL ) {
+               $serverUrl = $wgCanonicalServer;
+       }
+       // Make $wgInternalServer fall back to $wgServer if not set
+       if ( $defaultProto === PROTO_INTERNAL && $wgInternalServer !== false ) {
+               $serverUrl = $wgInternalServer;
+       }
        if ( $defaultProto === PROTO_CURRENT ) {
                $defaultProto = WebRequest::detectProtocol() . '://';
        }
-       
+
        // Analyze $serverUrl to obtain its protocol
        $bits = wfParseUrl( $serverUrl );
        $serverHasProto = $bits && $bits['scheme'] != '';
-       
-       if ( $defaultProto === PROTO_CANONICAL ) {
+
+       if ( $defaultProto === PROTO_CANONICAL || $defaultProto === PROTO_INTERNAL ) {
                if ( $serverHasProto ) {
                        $defaultProto = $bits['scheme'] . '://';
                } else {
-                       // $wgCanonicalServer doesn't have a protocol. This really isn't supposed to happen
+                       // $wgCanonicalServer or $wgInternalServer doesn't have a protocol. This really isn't supposed to happen
                        // Fall back to HTTP in this ridiculous case
                        $defaultProto = PROTO_HTTP;
                }
        }
-       
+
        $defaultProtoWithoutSlashes = substr( $defaultProto, 0, -2 );
-       
+
        if( substr( $url, 0, 2 ) == '//' ) {
                return $defaultProtoWithoutSlashes . $url;
        } elseif( substr( $url, 0, 1 ) == '/' ) {
@@ -516,7 +523,7 @@ function wfUrlProtocols( $includeProtocolRelative = true ) {
                // URLs weren't supported until 1.18
                $retval = $wgUrlProtocols;
        }
-       
+
        // Cache return value
        if ( $includeProtocolRelative ) {
                $withProtRel = $retval;
@@ -749,8 +756,8 @@ function wfDebugTimer() {
        } else {
                $prefix = sprintf( "%6.4f", microtime( true ) - $start );
        }
-
-       return $prefix . '  ';
+       $mem = sprintf( "%5.1fM", ( memory_get_usage( true ) / (1024*1024) ) );
+       return "$prefix $mem  " ;
 }
 
 /**
@@ -860,7 +867,14 @@ function wfErrorLog( $text, $file ) {
                if ( !$sock ) {
                        return;
                }
-               socket_sendto( $sock, $text, strlen( $text ), 0, $host, $port );
+
+               $len = strlen( $text );
+               $maxLen = socket_get_option( $sock, SOL_SOCKET, SO_SNDBUF );
+
+               if ( $len > $maxLen ) {
+                       $len = $maxLen - 1;
+               }
+               socket_sendto( $sock, $text, $len, 0, $host, $port );
                socket_close( $sock );
        } else {
                wfSuppressWarnings();
@@ -967,9 +981,10 @@ function wfReadOnlyReason() {
  *                    a valid code create a language for that language, if
  *                    it is a string but not a valid code then make a basic
  *                    language object
- *                  - a boolean: if it's false then use the current users
- *                    language (as a fallback for the old parameter
- *                    functionality), or if it is true then use the wikis
+ *                  - a boolean: if it's false then use the global object for
+ *                    the current user's language (as a fallback for the old parameter
+ *                    functionality), or if it is true then use global object
+ *                    for the wiki's content language.
  * @return Language object
  */
 function wfGetLangObj( $langcode = false ) {
@@ -1407,6 +1422,8 @@ function wfReportTime() {
  * debug_backtrace is disabled, otherwise the output from
  * debug_backtrace() (trimmed).
  *
+ * @param $limit int This parameter can be used to limit the number of stack frames returned
+ *
  * @return array of backtrace information
  */
 function wfDebugBacktrace( $limit = 0 ) {
@@ -1432,7 +1449,7 @@ function wfDebugBacktrace( $limit = 0 ) {
        }
 
        if ( $limit && version_compare( PHP_VERSION, '5.4.0', '>=' ) ) {
-               return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT, 1 ), 1 );
+               return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT, $limit ), 1 );
        } else {
                return array_slice( debug_backtrace(), 1 );
        }
@@ -2150,7 +2167,7 @@ function mimeTypeMatch( $type, $avail ) {
 function wfNegotiateType( $cprefs, $sprefs ) {
        $combine = array();
 
-       foreach( array_keys($sprefs) as $type ) {
+       foreach( array_keys( $sprefs ) as $type ) {
                $parts = explode( '/', $type );
                if( $parts[1] != '*' ) {
                        $ckey = mimeTypeMatch( $type, $cprefs );
@@ -2202,7 +2219,7 @@ function wfSuppressWarnings( $end = false ) {
        } else {
                if ( !$suppressCount ) {
                        // E_DEPRECATED is undefined in PHP 5.2
-                       if( !defined( 'E_DEPRECATED' ) ){
+                       if( !defined( 'E_DEPRECATED' ) ) {
                                define( 'E_DEPRECATED', 8192 );
                        }
                        $originalLevel = error_reporting( E_ALL & ~( E_WARNING | E_NOTICE | E_USER_WARNING | E_USER_NOTICE | E_DEPRECATED ) );
@@ -2315,7 +2332,7 @@ function wfTimestamp( $outputtype = TS_UNIX, $ts = 0 ) {
                # TS_POSTGRES
        } elseif ( preg_match( '/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)\.*\d* GMT$/', $ts, $da ) ) {
                # TS_POSTGRES
-       } elseif (preg_match('/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)\.\d\d\d$/',$ts,$da)) {
+       } elseif (preg_match( '/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)\.\d\d\d$/', $ts, $da ) ) {
                # TS_DB2
        } elseif ( preg_match( '/^[ \t\r\n]*([A-Z][a-z]{2},[ \t\r\n]*)?' . # Day of week
                                                        '\d\d?[ \t\r\n]*[A-Z][a-z]{2}[ \t\r\n]*\d{2}(?:\d{2})?' .  # dd Mon yyyy
@@ -2909,35 +2926,11 @@ function wfRelativePath( $path, $from ) {
 /**
  * Do any deferred updates and clear the list
  *
- * @param $commit String: set to 'commit' to commit after every update to
- *                prevent lock contention
+ * @deprecated since 1.19
+ * @see DeferredUpdates::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;
-       }
-
-       $doCommit = $commit == 'commit';
-       if ( $doCommit ) {
-               $dbw = wfGetDB( DB_MASTER );
-       }
-
-       foreach ( $wgDeferredUpdateList as $update ) {
-               $update->doUpdate();
-
-               if ( $doCommit && $dbw->trxLevel() ) {
-                       $dbw->commit();
-               }
-       }
-
-       $wgDeferredUpdateList = array();
-       wfProfileOut( __METHOD__ );
+       DeferredUpdates::doUpdates( $commit );
 }
 
 /**
@@ -3155,8 +3148,10 @@ function wfForeignMemcKey( $db, $prefix /*, ... */ ) {
  * @return String
  */
 function wfWikiID() {
-       global $wgDBprefix, $wgDBname;
-       if ( $wgDBprefix ) {
+       global $wgDBprefix, $wgDBname, $wgWikiID;
+       if ( $wgWikiID !== false ) {
+               return $wgWikiID;
+       } elseif ( $wgDBprefix ) {
                return "$wgDBname-$wgDBprefix";
        } else {
                return $wgDBname;
@@ -3168,6 +3163,8 @@ function wfWikiID() {
  *
  * @param $wiki String
  * @param $bits String
+ *
+ * @return array
  */
 function wfSplitWikiID( $wiki ) {
        $bits = explode( '-', $wiki, 2 );
@@ -3350,13 +3347,30 @@ function wfGetNull() {
  * Throws a warning that $function is deprecated
  *
  * @param $function String
+ * @param $version String
  * @return null
  */
-function wfDeprecated( $function ) {
+function wfDeprecated( $function, $version = false ) {
        static $functionsWarned = array();
        if ( !isset( $functionsWarned[$function] ) ) {
                $functionsWarned[$function] = true;
-               wfWarn( "Use of $function is deprecated.", 2 );
+               if ( $version ) {
+                       global $wgDeprecationReleaseLimit;
+                       if ( $wgDeprecationReleaseLimit ) {
+                               # Strip -* off the end of $version so that branches can use the
+                               # format #.##-branchname to avoid issues if the branch is merged into
+                               # a version of MediaWiki later than what it was branched from
+                               $comparableVersion = preg_replace( '/-.*$/', '', $version );
+                               # If the comparableVersion is larger than our release limit then
+                               # skip the warning message for the deprecation
+                               if ( version_compare( $wgDeprecationReleaseLimit, $comparableVersion, '<' ) ) {
+                                       return;
+                               }
+                       }
+                       wfWarn( "Use of $function was deprecated in $version.", 2 );
+               } else {
+                       wfWarn( "Use of $function is deprecated.", 2 );
+               }
        }
 }
 
@@ -3556,7 +3570,7 @@ function wfBCP47( $code ) {
        foreach ( $codeSegment as $segNo => $seg ) {
                if ( count( $codeSegment ) > 0 ) {
                        // when previous segment is x, it is a private segment and should be lc
-                       if( $segNo > 0 && strtolower( $codeSegment[($segNo - 1)] ) == 'x') {
+                       if( $segNo > 0 && strtolower( $codeSegment[( $segNo - 1 )] ) == 'x' ) {
                                $codeBCP[$segNo] = strtolower( $seg );
                        // ISO 3166 country code
                        } elseif ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) {