Followup r95753 per CR: prevent extensions from making isMovable() return true for...
[lhc/web/wiklou.git] / includes / GlobalFunctions.php
index 2871676..017b842 100644 (file)
@@ -50,7 +50,7 @@ if( !function_exists( 'mb_strpos' ) ) {
        function mb_strpos( $haystack, $needle, $offset = 0, $encoding = '' ) {
                return Fallback::mb_strpos( $haystack, $needle, $offset, $encoding );
        }
-       
+
 }
 
 if( !function_exists( 'mb_strrpos' ) ) {
@@ -294,6 +294,11 @@ function wfRandom() {
 */
 function wfUrlencode( $s ) {
        static $needle;
+       if ( is_null( $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 ) ) {
@@ -316,11 +321,12 @@ function wfUrlencode( $s ) {
  * "days=7&limit=100". Options in the first array override options in the second.
  * Options set to "" will not be output.
  *
- * @param $array1 Array( String|Array )
- * @param $array2 Array( String|Array )
+ * @param $array1 Array ( String|Array )
+ * @param $array2 Array ( String|Array )
+ * @param $prefix String
  * @return String
  */
-function wfArrayToCGI( $array1, $array2 = null ) {
+function wfArrayToCGI( $array1, $array2 = null, $prefix = '' ) {
        if ( !is_null( $array2 ) ) {
                $array1 = $array1 + $array2;
        }
@@ -331,20 +337,25 @@ function wfArrayToCGI( $array1, $array2 = null ) {
                        if ( $cgi != '' ) {
                                $cgi .= '&';
                        }
+                       if ( $prefix !== '' ) {
+                               $key = $prefix . "[$key]";
+                       }
                        if ( is_array( $value ) ) {
                                $firstTime = true;
-                               foreach ( $value as $v ) {
-                                       $cgi .= ( $firstTime ? '' : '&') .
-                                               urlencode( $key . '[]' ) . '=' .
-                                               urlencode( $v );
+                               foreach ( $value as $k => $v ) {
+                                       $cgi .= $firstTime ? '' : '&';
+                                       if ( is_array( $v ) ) {
+                                               $cgi .= wfArrayToCGI( $v, null, $key . "[$k]" );
+                                       } else {
+                                               $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v );
+                                       }
                                        $firstTime = false;
                                }
                        } else {
                                if ( is_object( $value ) ) {
                                        $value = $value->__toString();
                                }
-                               $cgi .= urlencode( $key ) . '=' .
-                                       urlencode( $value );
+                               $cgi .= urlencode( $key ) . '=' . urlencode( $value );
                        }
                }
        }
@@ -362,19 +373,34 @@ function wfArrayToCGI( $array1, $array2 = null ) {
  * @return array Array version of input
  */
 function wfCgiToArray( $query ) {
-       if( isset( $query[0] ) && $query[0] == '?' ) {
+       if ( isset( $query[0] ) && $query[0] == '?' ) {
                $query = substr( $query, 1 );
        }
        $bits = explode( '&', $query );
        $ret = array();
-       foreach( $bits as $bit ) {
-               if( $bit === '' ) {
+       foreach ( $bits as $bit ) {
+               if ( $bit === '' ) {
                        continue;
                }
                list( $key, $value ) = explode( '=', $bit );
                $key = urldecode( $key );
                $value = urldecode( $value );
-               $ret[$key] = $value;
+               if ( strpos( $key, '[' ) !== false ) {
+                       $keys = array_reverse( explode( '[', $key ) );
+                       $key = array_pop( $keys );
+                       $temp = $value;
+                       foreach ( $keys as $k ) {
+                               $k = substr( $k, 0, -1 );
+                               $temp = array( $k => $temp );
+                       }
+                       if ( isset( $ret[$key] ) ) {
+                               $ret[$key] = array_merge( $ret[$key], $temp );
+                       } else {
+                               $ret[$key] = $temp;
+                       }
+               } else {
+                       $ret[$key] = $value;
+               }
        }
        return $ret;
 }
@@ -406,20 +432,49 @@ 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
+ *
  * @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
+ * @param $defaultProto Mixed: one of the PROTO_* constants. Determines the protocol to use if $url or $wgServer is protocol-relative
  * @return string Fully-qualified URL
  */
-function wfExpandUrl( $url ) {
-       global $wgServer;
+function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT ) {
+       global $wgServer, $wgCanonicalServer;
+       $serverUrl = $defaultProto === PROTO_CANONICAL ? $wgCanonicalServer : $wgServer;
+
+       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 ( $serverHasProto ) {
+                       $defaultProto = $bits['scheme'] . '://';
+               } else {
+                       // $wgCanonicalServer 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 ) == '//' ) {
-               $bits = wfParseUrl( $wgServer );
-               $scheme = $bits ? $bits['scheme'] : 'http';
-               return $scheme . ':' . $url;
+               return $defaultProtoWithoutSlashes . $url;
        } elseif( substr( $url, 0, 1 ) == '/' ) {
-               return $wgServer . $url;
+               // If $serverUrl is protocol-relative, prepend $defaultProtoWithoutSlashes, otherwise leave it alone
+               return ( $serverHasProto ? '' : $defaultProtoWithoutSlashes ) . $serverUrl . $url;
        } else {
                return $url;
        }
@@ -428,14 +483,18 @@ function wfExpandUrl( $url ) {
 /**
  * Returns a regular expression of url protocols
  *
+ * @param $includeProtocolRelative bool If false, remove '//' from the returned protocol list.
+ *        DO NOT USE this directy, use wfUrlProtocolsWithoutProtRel() instead
  * @return String
  */
-function wfUrlProtocols() {
+function wfUrlProtocols( $includeProtocolRelative = true ) {
        global $wgUrlProtocols;
 
-       static $retval = null;
-       if ( !is_null( $retval ) ) {
-               return $retval;
+       // Cache return values separately based on $includeProtocolRelative
+       static $withProtRel = null, $withoutProtRel = null;
+       $cachedValue = $includeProtocolRelative ? $withProtRel : $withoutProtRel;
+       if ( !is_null( $cachedValue ) ) {
+               return $cachedValue;
        }
 
        // Support old-style $wgUrlProtocols strings, for backwards compatibility
@@ -443,32 +502,64 @@ function wfUrlProtocols() {
        if ( is_array( $wgUrlProtocols ) ) {
                $protocols = array();
                foreach ( $wgUrlProtocols as $protocol ) {
-                       $protocols[] = preg_quote( $protocol, '/' );
+                       // Filter out '//' if !$includeProtocolRelative
+                       if ( $includeProtocolRelative || $protocol !== '//' ) {
+                               $protocols[] = preg_quote( $protocol, '/' );
+                       }
                }
 
                $retval = implode( '|', $protocols );
        } else {
+               // Ignore $includeProtocolRelative in this case
+               // This case exists for pre-1.6 compatibility, and we can safely assume
+               // that '//' won't appear in a pre-1.6 config because protocol-relative
+               // URLs weren't supported until 1.18
                $retval = $wgUrlProtocols;
        }
+
+       // Cache return value
+       if ( $includeProtocolRelative ) {
+               $withProtRel = $retval;
+       } else {
+               $withoutProtRel = $retval;
+       }
        return $retval;
 }
 
+/**
+ * Like wfUrlProtocols(), but excludes '//' from the protocol list. Use this if
+ * you need a regex that matches all URL protocols but does not match protocol-
+ * relative URLs
+ */
+function wfUrlProtocolsWithoutProtRel() {
+       return wfUrlProtocols( false );
+}
+
 /**
  * parse_url() work-alike, but non-broken.  Differences:
  *
  * 1) Does not raise warnings on bad URLs (just returns false)
- * 2) Handles protocols that don't use :// (e.g., mailto: and news:) correctly
- * 3) Adds a "delimiter" element to the array, either '://' or ':' (see (2))
+ * 2) Handles protocols that don't use :// (e.g., mailto: and news: , as well as protocol-relative URLs) correctly
+ * 3) Adds a "delimiter" element to the array, either '://', ':' or '//' (see (2))
  *
  * @param $url String: a URL to parse
  * @return Array: bits of the URL in an associative array, per PHP docs
  */
 function wfParseUrl( $url ) {
        global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
+
+       // Protocol-relative URLs are handled really badly by parse_url(). It's so bad that the easiest
+       // way to handle them is to just prepend 'http:' and strip the protocol out later
+       $wasRelative = substr( $url, 0, 2 ) == '//';
+       if ( $wasRelative ) {
+               $url = "http:$url";
+       }
        wfSuppressWarnings();
        $bits = parse_url( $url );
        wfRestoreWarnings();
-       if ( !$bits ) {
+       // parse_url() returns an array without scheme for some invalid URLs, e.g.
+       // parse_url("%0Ahttp://example.com") == array( 'host' => '%0Ahttp', 'path' => 'example.com' )
+       if ( !$bits || !isset( $bits['scheme'] ) ) {
                return false;
        }
 
@@ -490,12 +581,18 @@ function wfParseUrl( $url ) {
        /* Provide an empty host for eg. file:/// urls (see bug 28627) */
        if ( !isset( $bits['host'] ) ) {
                $bits['host'] = '';
-               
+
                /* parse_url loses the third / for file:///c:/ urls (but not on variants) */
                if ( substr( $bits['path'], 0, 1 ) !== '/' ) {
                        $bits['path'] = '/' . $bits['path'];
                }
        }
+
+       // If the URL was protocol-relative, fix scheme and delimiter
+       if ( $wasRelative ) {
+               $bits['scheme'] = '';
+               $bits['delimiter'] = '//';
+       }
        return $bits;
 }
 
@@ -548,6 +645,26 @@ function wfMakeUrlIndex( $url ) {
        return $index;
 }
 
+/**
+ * Check whether a given URL has a domain that occurs in a given set of domains
+ * @param $url string URL
+ * @param $domains array Array of domains (strings)
+ * @return bool True if the host part of $url ends in one of the strings in $domains
+ */
+function wfMatchesDomainList( $url, $domains ) {
+       $bits = wfParseUrl( $url );
+       if ( is_array( $bits ) && isset( $bits['host'] ) ) {
+               foreach ( (array)$domains as $domain ) {
+                       // FIXME: This gives false positives. http://nds-nl.wikipedia.org will match nl.wikipedia.org
+                       // We should use something that interprets dots instead
+                       if ( substr( $bits['host'], -strlen( $domain ) ) === $domain ) {
+                               return true;
+                       }
+               }
+       }
+       return false;
+}
+
 /**
  * Sends a line to the debug log if enabled or, optionally, to a comment in output.
  * In normal operation this is a NOP.
@@ -602,10 +719,10 @@ function wfIsDebugRawPage() {
        }
        # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
        if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
-               || ( 
-                       isset( $_SERVER['SCRIPT_NAME'] ) 
-                       && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php' 
-               ) )     
+               || (
+                       isset( $_SERVER['SCRIPT_NAME'] )
+                       && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
+               ) )
        {
                $cache = true;
        } else {
@@ -616,7 +733,7 @@ function wfIsDebugRawPage() {
 
 /**
  * Get microsecond timestamps for debug logs
- * 
+ *
  * @return string
  */
 function wfDebugTimer() {
@@ -889,17 +1006,15 @@ function wfGetLangObj( $langcode = false ) {
 }
 
 /**
- * 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).
+ * Old function when $wgBetterDirectionality existed
+ * Removed in core, kept in extensions for backwards compat.
  *
+ * @deprecated since 1.18
  * @return Language
  */
 function wfUILang() {
-       global $wgBetterDirectionality;
-       return wfGetLangObj( !$wgBetterDirectionality );
+       global $wgLang;
+       return $wgLang;
 }
 
 /**
@@ -1124,7 +1239,8 @@ function wfMsgWikiHtml( $key ) {
        $args = func_get_args();
        array_shift( $args );
        return wfMsgReplaceArgs(
-               MessageCache::singleton()->parse( wfMsgGetKey( $key ), null, /* can't be set to false */ true )->getText(),
+               MessageCache::singleton()->parse( wfMsgGetKey( $key ), null,
+               /* can't be set to false */ true, /* interface */ true )->getText(),
                $args );
 }
 
@@ -1224,24 +1340,6 @@ function wfEmptyMsg( $key ) {
        return MessageCache::singleton()->get( $key, /*useDB*/true, /*content*/false ) === false;
 }
 
-/**
- * Print an error message and die, returning nonzero to the shell if any.  Plain die()
- * fails to return nonzero to the shell if you pass a string.  Entry points may customise
- * this function to return a prettier error message, but implementations must not assume
- * access to any of the usual MediaWiki infrastructure (AutoLoader, localisation, database,
- * etc).  This should not be called directly once $wgFullyInitialised is set; instead,
- * throw an exception and let Exception.php handle whether or not it's possible to show
- * a prettier error.
- *
- * @param $msg String
- */
-if( !function_exists( 'wfDie' ) ){
-       function wfDie( $msg = '' ) {
-               echo $msg;
-               die( 1 );
-       }
-}
-
 /**
  * Throw a debugging exception. This function previously once exited the process,
  * but now throws an exception instead, with similar results.
@@ -1256,7 +1354,7 @@ function wfDebugDieBacktrace( $msg = '' ) {
  * Fetch server name for use in error reporting etc.
  * Use real server name if available, so we know which machine
  * in a server farm generated the current page.
- * 
+ *
  * @return string
  */
 function wfHostname() {
@@ -1309,6 +1407,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 ) {
@@ -1334,7 +1434,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 );
        }
@@ -1457,25 +1557,6 @@ function wfShowingResults( $offset, $limit ) {
        );
 }
 
-/**
- * @todo document
- *
- * @param $offset Int
- * @param $limit Int
- * @param $num Int
- * @return String
- */
-function wfShowingResultsNum( $offset, $limit, $num ) {
-       global $wgLang;
-       return wfMsgExt(
-               'showingresultsnum',
-               array( 'parseinline' ),
-               $wgLang->formatNum( $limit ),
-               $wgLang->formatNum( $offset + 1 ),
-               $wgLang->formatNum( $num )
-       );
-}
-
 /**
  * Generate (prev x| next x) (20|50|100...) type links for paging
  *
@@ -2517,12 +2598,24 @@ function wfPercent( $nr, $acc = 2, $round = true ) {
 function in_string( $needle, $str, $insensitive = false ) {
        $func = 'strpos';
        if( $insensitive ) $func = 'stripos';
-       
+
        return $func( $str, $needle ) !== false;
 }
 
-function wfSpecialList( $page, $details ) {
-       $details = $details ? ' ' . wfUILang()->getDirMark() . "($details)" : '';
+/**
+ * Make a list item, used by various special pages
+ *
+ * @param $page String Page link
+ * @param $details String Text between brackets
+ * @param $oppositedm Boolean  Add the direction mark opposite to your
+ *                                                             language, to display text properly
+ * @return String
+ */
+function wfSpecialList( $page, $details, $oppositedm = true ) {
+       global $wgLang;
+       $dirmark = ( $oppositedm ? $wgLang->getDirMark( true ) : '' ) .
+               $wgLang->getDirMark();
+       $details = $details ? $dirmark . " ($details)" : '';
        return $page . $details;
 }
 
@@ -2941,7 +3034,7 @@ function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1, $lowercase = t
  *
  * @param $name String
  * @param $p Array: parameters
- * @deprecated since 1.18, warnings in 1.19, removal in 1.20
+ * @deprecated since 1.18, warnings in 1.18, removal in 1.20
  */
 function wfCreateObject( $name, $p ) {
        wfDeprecated( __FUNCTION__ );
@@ -2975,11 +3068,11 @@ function wfSetupSession( $sessionId = false ) {
                        global $IP;
                        require_once( "$IP/includes/cache/MemcachedSessions.php" );
                }
-               session_set_save_handler( 'memsess_open', 'memsess_close', 'memsess_read', 
+               session_set_save_handler( 'memsess_open', 'memsess_close', 'memsess_read',
                        'memsess_write', 'memsess_destroy', 'memsess_gc' );
 
-               // It's necessary to register a shutdown function to call session_write_close(), 
-               // because by the time the request shutdown function for the session module is 
+               // It's necessary to register a shutdown function to call session_write_close(),
+               // because by the time the request shutdown function for the session module is
                // called, $wgMemc has already been destroyed. Shutdown functions registered
                // this way are called before object destruction.
                register_shutdown_function( 'memsess_write_close' );
@@ -3166,6 +3259,14 @@ function wfLocalFile( $title ) {
        return RepoGroup::singleton()->getLocalRepo()->newFile( $title );
 }
 
+/**
+ * Stream a file to the browser. Back-compat alias for StreamFile::stream()
+ * @deprecated since 1.19
+ */
+function wfStreamFile( $fname, $headers = array() ) {
+       StreamFile::stream( $fname, $headers );
+}
+
 /**
  * Should low-performance queries be disabled?
  *
@@ -3306,7 +3407,7 @@ function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE ) {
  * master position. Use this when updating very large numbers of rows, as
  * in maintenance scripts, to avoid causing too much lag.  Of course, this is
  * a no-op if there are no slaves.
- * 
+ *
  * @param $maxLag Integer (deprecated)
  * @param $wiki mixed Wiki identifier accepted by wfGetLB
  * @return null
@@ -3324,12 +3425,12 @@ function wfWaitForSlaves( $maxLag = false, $wiki = false ) {
 
 /**
  * Used to be used for outputting text in the installer/updater
- * @deprecated since 1.18, warnings in 1.19, remove in 1.20
+ * @deprecated since 1.18, warnings in 1.18, remove in 1.20
  */
 function wfOut( $s ) {
        wfDeprecated( __METHOD__ );
        global $wgCommandLineMode;
-       if ( $wgCommandLineMode && !defined( 'MEDIAWIKI_INSTALL' ) ) {
+       if ( $wgCommandLineMode ) {
                echo $s;
        } else {
                echo htmlspecialchars( $s );
@@ -3456,7 +3557,7 @@ function wfBCP47( $code ) {
        $codeBCP = array();
        foreach ( $codeSegment as $segNo => $seg ) {
                if ( count( $codeSegment ) > 0 ) {
-                       // when previous segment is x, it is a private segment and should be lc 
+                       // 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