Bump RL filter version to 4 to keep it in sync with the cluster. WMF-centrism, I...
[lhc/web/wiklou.git] / includes / GlobalFunctions.php
index 1eef74b..18d08ea 100644 (file)
@@ -22,29 +22,33 @@ require_once dirname( __FILE__ ) . '/normal/UtfNormalUtil.php';
  */
 
 if( !function_exists( 'iconv' ) ) {
+       /** @codeCoverageIgnore */
        function iconv( $from, $to, $string ) {
                return Fallback::iconv( $from, $to, $string );
        }
 }
 
 if ( !function_exists( 'mb_substr' ) ) {
+       /** @codeCoverageIgnore */
        function mb_substr( $str, $start, $count='end' ) {
                return Fallback::mb_substr( $str, $start, $count );
        }
 
+       /** @codeCoverageIgnore */
        function mb_substr_split_unicode( $str, $splitPos ) {
                return Fallback::mb_substr_split_unicode( $str, $splitPos );
        }
 }
 
 if ( !function_exists( 'mb_strlen' ) ) {
+       /** @codeCoverageIgnore */
        function mb_strlen( $str, $enc = '' ) {
                return Fallback::mb_strlen( $str, $enc );
        }
 }
 
 if( !function_exists( 'mb_strpos' ) ) {
-       
+       /** @codeCoverageIgnore */
        function mb_strpos( $haystack, $needle, $offset = 0, $encoding = '' ) {
                return Fallback::mb_strpos( $haystack, $needle, $offset, $encoding );
        }
@@ -52,6 +56,7 @@ if( !function_exists( 'mb_strpos' ) ) {
 }
 
 if( !function_exists( 'mb_strrpos' ) ) {
+       /** @codeCoverageIgnore */
        function mb_strrpos( $haystack, $needle, $offset = 0, $encoding = '' ) {
                return Fallback::mb_strrpos( $haystack, $needle, $offset, $encoding );
        }
@@ -60,10 +65,13 @@ if( !function_exists( 'mb_strrpos' ) ) {
 
 // Support for Wietse Venema's taint feature
 if ( !function_exists( 'istainted' ) ) {
+       /** @codeCoverageIgnore */
        function istainted( $var ) {
                return 0;
        }
+       /** @codeCoverageIgnore */
        function taint( $var, $level = 0 ) {}
+       /** @codeCoverageIgnore */
        function untaint( $var, $level = 0 ) {}
        define( 'TC_HTML', 1 );
        define( 'TC_SHELL', 1 );
@@ -73,8 +81,6 @@ if ( !function_exists( 'istainted' ) ) {
 }
 /// @endcond
 
-
-
 /**
  * Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
  */
@@ -295,12 +301,21 @@ function wfErrorLog( $text, $file ) {
                } else {
                        throw new MWException( __METHOD__ . ': Invalid UDP specification' );
                }
+
                // Clean it up for the multiplexer
                if ( strval( $prefix ) !== '' ) {
                        $text = preg_replace( '/^/m', $prefix . ' ', $text );
+
+                       // Limit to 64KB
+                       if ( strlen( $text ) > 65534 ) {
+                               $text = substr( $text, 0, 65534 );
+                       }
+
                        if ( substr( $text, -1 ) != "\n" ) {
                                $text .= "\n";
                        }
+               } elseif ( strlen( $text ) > 65535 ) {
+                       $text = substr( $text, 0, 65535 );
                }
 
                $sock = socket_create( $domain, SOCK_DGRAM, SOL_UDP );
@@ -458,7 +473,7 @@ function wfUILang() {
  * The intention is that this function replaces all old wfMsg* functions.
  * @param $key \string Message key.
  * Varargs: normal message parameters.
- * @return \type{Message}
+ * @return Message
  * @since 1.17
  */
 function wfMessage( $key /*...*/) {
@@ -607,11 +622,13 @@ function wfMsgReal( $key, $args, $useDB = true, $forContent = false, $transform
 
 /**
  * This function provides the message source for messages to be edited which are *not* stored in the database.
- * @param $key String:
+ *
+ * @deprecated in 1.18; use wfMessage()
+ * @param $key String
  */
 function wfMsgWeirdKey( $key ) {
        $source = wfMsgGetKey( $key, false, true, false );
-       if ( wfEmptyMsg( $key, $source ) ) {
+       if ( wfEmptyMsg( $key ) ) {
                return '';
        } else {
                return $source;
@@ -628,19 +645,14 @@ function wfMsgWeirdKey( $key ) {
  * @return string
  */
 function wfMsgGetKey( $key, $useDB, $langCode = false, $transform = true ) {
-       global $wgMessageCache;
-
        wfRunHooks( 'NormalizeMessageKey', array( &$key, &$useDB, &$langCode, &$transform ) );
 
-       if ( !is_object( $wgMessageCache ) ) {
-               throw new MWException( 'Trying to get message before message cache is initialised' );
-       }
-
-       $message = $wgMessageCache->get( $key, $useDB, $langCode );
+       $cache = MessageCache::singleton();
+       $message = $cache->get( $key, $useDB, $langCode );
        if( $message === false ) {
                $message = '<' . htmlspecialchars( $key ) . '>';
        } elseif ( $transform ) {
-               $message = $wgMessageCache->transform( $message );
+               $message = $cache->transform( $message );
        }
        return $message;
 }
@@ -775,11 +787,8 @@ function wfMsgExt( $key, $options ) {
                        $string = $m[1];
                }
        } elseif ( in_array( 'parsemag', $options, true ) ) {
-               global $wgMessageCache;
-               if ( isset( $wgMessageCache ) ) {
-                       $string = $wgMessageCache->transform( $string,
+               $string = MessageCache::singleton()->transform( $string,
                                !$forContent, $langCodeObj );
-               }
        }
 
        if ( in_array( 'escape', $options, true ) ) {
@@ -1149,21 +1158,20 @@ function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
  * Escapes the given text so that it may be output using addWikiText()
  * without any linking, formatting, etc. making its way through. This
  * is achieved by substituting certain characters with HTML entities.
- * As required by the callers, <nowiki> is not used. It currently does
- * not filter out characters which have special meaning only at the
- * start of a line, such as "*".
+ * As required by the callers, <nowiki> is not used.
  *
  * @param $text String: text to be escaped
  */
 function wfEscapeWikiText( $text ) {
-       $text = str_replace(
-               array( '[',     '|',      ']',     '\'',    'ISBN ',
-                       'RFC ',     '://',     "\n=",     '{{',           '}}' ),
-               array( '&#91;', '&#124;', '&#93;', '&#39;', 'ISBN&#32;',
-                       'RFC&#32;', '&#58;//', "\n&#61;", '&#123;&#123;', '&#125;&#125;' ),
-               htmlspecialchars( $text )
-       );
-       return $text;
+       $text = strtr( "\n$text", array(
+               '"' => '&#34;', '&' => '&#38;', "'" => '&#39;', '<' => '&#60;',
+               '=' => '&#61;', '>' => '&#62;', '[' => '&#91;', ']' => '&#93;',
+               '{' => '&#123;', '|' => '&#124;', '}' => '&#125;',
+               "\n#" => "\n&#35;", "\n*" => "\n&#42;",
+               "\n:" => "\n&#58;", "\n;" => "\n&#59;",
+               '://' => '&#58;//', 'ISBN ' => 'ISBN&#32;', 'RFC ' => 'RFC&#32;',
+       ) );
+       return substr( $text, 1 );
 }
 
 /**
@@ -1591,7 +1599,13 @@ function wfResetOutputBuffers( $resetGzipEncoding = true ) {
                        if( $status['name'] == 'ob_gzhandler' ) {
                                // Reset the 'Content-Encoding' field set by this handler
                                // so we can start fresh.
-                               header( 'Content-Encoding:' );
+                               if ( function_exists( 'header_remove' ) ) {
+                                       // Available since PHP 5.3.0
+                                       header_remove( 'Content-Encoding' );
+                               } else {
+                                       // We need to provide a valid content-coding. See bug 28069
+                                       header( 'Content-Encoding: identity' );
+                               }
                                break;
                        }
                }
@@ -1988,107 +2002,6 @@ function swap( &$x, &$y ) {
        $y = $z;
 }
 
-function wfGetCachedNotice( $name ) {
-       global $wgOut, $wgRenderHashAppend, $parserMemc;
-       $fname = 'wfGetCachedNotice';
-       wfProfileIn( $fname );
-
-       $needParse = false;
-
-       if( $name === 'default' ) {
-               // special case
-               global $wgSiteNotice;
-               $notice = $wgSiteNotice;
-               if( empty( $notice ) ) {
-                       wfProfileOut( $fname );
-                       return false;
-               }
-       } else {
-               $notice = wfMsgForContentNoTrans( $name );
-               if( wfEmptyMsg( $name, $notice ) || $notice == '-' ) {
-                       wfProfileOut( $fname );
-                       return( false );
-               }
-       }
-
-       // Use the extra hash appender to let eg SSL variants separately cache.
-       $key = wfMemcKey( $name . $wgRenderHashAppend );
-       $cachedNotice = $parserMemc->get( $key );
-       if( is_array( $cachedNotice ) ) {
-               if( md5( $notice ) == $cachedNotice['hash'] ) {
-                       $notice = $cachedNotice['html'];
-               } else {
-                       $needParse = true;
-               }
-       } else {
-               $needParse = true;
-       }
-
-       if( $needParse ) {
-               if( is_object( $wgOut ) ) {
-                       $parsed = $wgOut->parse( $notice );
-                       $parserMemc->set( $key, array( 'html' => $parsed, 'hash' => md5( $notice ) ), 600 );
-                       $notice = $parsed;
-               } else {
-                       wfDebug( 'wfGetCachedNotice called for ' . $name . ' with no $wgOut available' . "\n" );
-                       $notice = '';
-               }
-       }
-       $notice = '<div id="localNotice">' .$notice . '</div>';
-       wfProfileOut( $fname );
-       return $notice;
-}
-
-function wfGetNamespaceNotice() {
-       global $wgTitle;
-
-       # Paranoia
-       if ( !isset( $wgTitle ) || !is_object( $wgTitle ) ) {
-               return '';
-       }
-
-       $fname = 'wfGetNamespaceNotice';
-       wfProfileIn( $fname );
-
-       $key = 'namespacenotice-' . $wgTitle->getNsText();
-       $namespaceNotice = wfGetCachedNotice( $key );
-       if ( $namespaceNotice && substr( $namespaceNotice, 0, 7 ) != '<p>&lt;' ) {
-               $namespaceNotice = '<div id="namespacebanner">' . $namespaceNotice . '</div>';
-       } else {
-               $namespaceNotice = '';
-       }
-
-       wfProfileOut( $fname );
-       return $namespaceNotice;
-}
-
-function wfGetSiteNotice() {
-       global $wgUser;
-       $fname = 'wfGetSiteNotice';
-       wfProfileIn( $fname );
-       $siteNotice = '';
-
-       if( wfRunHooks( 'SiteNoticeBefore', array( &$siteNotice ) ) ) {
-               if( is_object( $wgUser ) && $wgUser->isLoggedIn() ) {
-                       $siteNotice = wfGetCachedNotice( 'sitenotice' );
-               } else {
-                       $anonNotice = wfGetCachedNotice( 'anonnotice' );
-                       if( !$anonNotice ) {
-                               $siteNotice = wfGetCachedNotice( 'sitenotice' );
-                       } else {
-                               $siteNotice = $anonNotice;
-                       }
-               }
-               if( !$siteNotice ) {
-                       $siteNotice = wfGetCachedNotice( 'default' );
-               }
-       }
-
-       wfRunHooks( 'SiteNoticeAfter', array( &$siteNotice ) );
-       wfProfileOut( $fname );
-       return $siteNotice;
-}
-
 /**
  * BC wrapper for MimeMagic::singleton()
  * @deprecated No longer needed as of 1.17 (r68836). Remove in 1.19.
@@ -2164,15 +2077,20 @@ function wfMkdirParents( $dir, $mode = null, $caller = null ) {
 /**
  * Increment a statistics counter
  */
-function wfIncrStats( $key ) {
+function wfIncrStats( $key, $count = 1 ) {
        global $wgStatsMethod;
 
+       $count = intval( $count );
+
        if( $wgStatsMethod == 'udp' ) {
-               global $wgUDPProfilerHost, $wgUDPProfilerPort, $wgDBname;
+               global $wgUDPProfilerHost, $wgUDPProfilerPort, $wgDBname, $wgAggregateStatsID;
                static $socket;
+
+               $id = $wgAggregateStatsID !== false ? $wgAggregateStatsID : $wgDBname;
+
                if ( !$socket ) {
                        $socket = socket_create( AF_INET, SOCK_DGRAM, SOL_UDP );
-                       $statline = "stats/{$wgDBname} - 1 1 1 1 1 -total\n";
+                       $statline = "stats/{$id} - {$count} 1 1 1 1 -total\n";
                        socket_sendto(
                                $socket,
                                $statline,
@@ -2182,7 +2100,7 @@ function wfIncrStats( $key ) {
                                $wgUDPProfilerPort
                        );
                }
-               $statline = "stats/{$wgDBname} - 1 1 1 1 1 {$key}\n";
+               $statline = "stats/{$id} - {$count} 1 1 1 1 {$key}\n";
                wfSuppressWarnings();
                socket_sendto(
                        $socket,
@@ -2196,8 +2114,8 @@ function wfIncrStats( $key ) {
        } elseif( $wgStatsMethod == 'cache' ) {
                global $wgMemc;
                $key = wfMemcKey( 'stats', $key );
-               if ( is_null( $wgMemc->incr( $key ) ) ) {
-                       $wgMemc->add( $key, 1 );
+               if ( is_null( $wgMemc->incr( $key, $count ) ) ) {
+                       $wgMemc->add( $key, $count );
                }
        } else {
                // Disabled
@@ -2250,8 +2168,7 @@ function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
  * @return Boolean True if the message *doesn't* exist.
  */
 function wfEmptyMsg( $key ) {
-       global $wgMessageCache;
-       return $wgMessageCache->get( $key, /*useDB*/true, /*content*/false ) === false;
+       return MessageCache::singleton()->get( $key, /*useDB*/true, /*content*/false ) === false;
 }
 
 /**
@@ -2845,9 +2762,6 @@ function wfCreateObject( $name, $p ) {
 
 function wfHttpOnlySafe() {
        global $wgHttpOnlyBlacklist;
-       if( !version_compare( '5.2', PHP_VERSION, '<' ) ) {
-               return false;
-       }
 
        if( isset( $_SERVER['HTTP_USER_AGENT'] ) ) {
                foreach( $wgHttpOnlyBlacklist as $regex ) {
@@ -3074,6 +2988,7 @@ function wfLocalFile( $title ) {
  * Should low-performance queries be disabled?
  *
  * @return Boolean
+ * @codeCoverageIgnore
  */
 function wfQueriesMustScale() {
        global $wgMiserMode;
@@ -3132,6 +3047,7 @@ function wfBoolToStr( $value ) {
 /**
  * Load an extension messages file
  * @deprecated in 1.16, warnings in 1.18, remove in 1.20
+ * @codeCoverageIgnore
  */
 function wfLoadExtensionMessages( $extensionName, $langcode = false ) {
        wfDeprecated( __FUNCTION__ );
@@ -3269,6 +3185,7 @@ function wfOut( $s ) {
 /**
  * Count down from $n to zero on the terminal, with a one-second pause
  * between showing each number. For use in command-line scripts.
+ * @codeCoverageIgnore
  */
 function wfCountDown( $n ) {
        for ( $i = $n; $i >= 0; $i-- ) {
@@ -3288,6 +3205,7 @@ function wfCountDown( $n ) {
  * Generate a random 32-character hexadecimal token.
  * @param $salt Mixed: some sort of salt, if necessary, to add to random
  *              characters before hashing.
+ * @codeCoverageIgnore
  */
 function wfGenerateToken( $salt = '' ) {
        $salt = serialize( $salt );
@@ -3334,10 +3252,13 @@ function wfArrayInsertAfter( $array, $insert, $after ) {
 }
 
 /* Recursively converts the parameter (an object) to an array with the same data */
-function wfObjectToArray( $object, $recursive = true ) {
+function wfObjectToArray( $objOrArray, $recursive = true ) {
        $array = array();
-       foreach ( get_object_vars( $object ) as $key => $value ) {
-               if ( is_object( $value ) && $recursive ) {
+       if( is_object( $objOrArray ) ) {
+               $objOrArray = get_object_vars( $objOrArray );
+       }
+       foreach ( $objOrArray as $key => $value ) {
+               if ( $recursive && ( is_object( $value ) || is_array( $value ) ) ) {
                        $value = wfObjectToArray( $value );
                }
 
@@ -3404,6 +3325,7 @@ function wfShorthandToInteger( $string = '' ) {
 
 /**
  * Get the normalised IETF language tag
+ * See unit test for examples.
  * @param $code String: The language code.
  * @return $langCode String: The language code which complying with BCP 47 standards.
  */
@@ -3411,12 +3333,15 @@ function wfBCP47( $code ) {
        $codeSegment = explode( '-', $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') {
+                               $codeBCP[$segNo] = strtolower( $seg );
                        // ISO 3166 country code
-                       if ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) {
+                       } elseif ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) {
                                $codeBCP[$segNo] = strtoupper( $seg );
                        // ISO 15924 script code
                        } elseif ( ( strlen( $seg ) == 4 ) && ( $segNo > 0 ) ) {
-                               $codeBCP[$segNo] = ucfirst( $seg );
+                               $codeBCP[$segNo] = ucfirst( strtolower( $seg ) );
                        // Use lowercase for other cases
                        } else {
                                $codeBCP[$segNo] = strtolower( $seg );
@@ -3440,3 +3365,33 @@ function wfArrayMap( $function, $input ) {
        }
        return $ret;
 }
+
+
+/**
+ * Get a cache object.
+ * @param $inputType Cache type, one the the CACHE_* constants.
+ *
+ * @return BagOStuff
+ */
+function wfGetCache( $inputType ) {
+       return ObjectCache::getInstance( $inputType );
+}
+
+/** Get the main cache object */
+function wfGetMainCache() {
+       global $wgMainCacheType;
+       return ObjectCache::getInstance( $wgMainCacheType );
+}
+
+/** Get the cache object used by the message cache */
+function wfGetMessageCacheStorage() {
+       global $wgMessageCacheType;
+       return ObjectCache::getInstance( $wgMessageCacheType );
+}
+
+/** Get the cache object used by the parser cache */
+function wfGetParserCacheStorage() {
+       global $wgParserCacheType;
+       return ObjectCache::getInstance( $wgParserCacheType );
+}
+