Add support for Number grouping(commafy) based on CLDR number grouping patterns like...
[lhc/web/wiklou.git] / includes / WebRequest.php
index 5a883eb..2abc3d2 100644 (file)
@@ -44,6 +44,12 @@ class WebRequest {
         */
        private $response;
 
+       /**
+        * Cached client IP address
+        * @var String
+        */
+       private $ip;
+
        public function __construct() {
                /// @todo FIXME: This preemptive de-quoting can interfere with other web libraries
                ///        and increases our memory footprint. It would be cleaner to do on
@@ -109,6 +115,8 @@ class WebRequest {
                                        }
                                        $matches = self::extractTitle( $path, $variantPaths, 'variant' );
                                }
+
+                               wfRunHooks( 'WebRequestGetPathInfoRequestURI', array( $path, &$matches ) );
                        }
                } elseif ( isset( $_SERVER['ORIG_PATH_INFO'] ) && $_SERVER['ORIG_PATH_INFO'] != '' ) {
                        // Mangled PATH_INFO
@@ -127,15 +135,11 @@ class WebRequest {
        /**
         * Work out an appropriate URL prefix containing scheme and host, based on
         * information detected from $_SERVER
+        *
+        * @return string
         */
        public static function detectServer() {
-               if ( isset( $_SERVER['HTTPS'] ) && $_SERVER['HTTPS'] == 'on') {
-                       $proto = 'https';
-                       $stdPort = 443;
-               } else {
-                       $proto = 'http';
-                       $stdPort = 80;
-               }
+               list( $proto, $stdPort ) = self::detectProtocolAndStdPort();
 
                $varNames = array( 'HTTP_HOST', 'SERVER_NAME', 'HOSTNAME', 'SERVER_ADDR' );
                $host = 'localhost';
@@ -163,6 +167,21 @@ class WebRequest {
                return $proto . '://' . IP::combineHostAndPort( $host, $port, $stdPort );
        }
 
+       /**
+        * @return array
+        */
+       public static function detectProtocolAndStdPort() {
+               return ( isset( $_SERVER['HTTPS'] ) && $_SERVER['HTTPS'] == 'on' ) ? array( 'https', 443 ) : array( 'http', 80 );
+       }
+
+       /**
+        * @return string
+        */
+       public static function detectProtocol() {
+               list( $proto, $stdPort ) = self::detectProtocolAndStdPort();
+               return $proto;
+       }
+
        /**
         * Check for title, action, and/or variant data in the URL
         * and interpolate it into the GET variables.
@@ -187,7 +206,7 @@ class WebRequest {
        }
 
        /**
-        * Internal URL rewriting function; tries to extract page title and,
+        * URL rewriting function; tries to extract page title and,
         * optionally, one other fixed parameter value from a URL path.
         *
         * @param $path string: the URL path given from the client
@@ -196,7 +215,7 @@ class WebRequest {
         *             passed on as the value of this URL parameter
         * @return array of URL variables to interpolate; empty if no match
         */
-       private static function extractTitle( $path, $bases, $key=false ) {
+       static function extractTitle( $path, $bases, $key = false ) {
                foreach( (array)$bases as $keyValue => $base ) {
                        // Find the part after $wgArticlePath
                        $base = str_replace( '$1', '', $base );
@@ -220,16 +239,21 @@ class WebRequest {
         * used for undoing the evil that is magic_quotes_gpc.
         *
         * @param $arr array: will be modified
+        * @param $recursion bool Used to modify behaviour based on recursion
         * @return array the original array
         */
-       private function &fix_magic_quotes( &$arr ) {
+       private function &fix_magic_quotes( &$arr, $recursion = false ) {
+               $clean = array();
                foreach( $arr as $key => $val ) {
                        if( is_array( $val ) ) {
-                               $this->fix_magic_quotes( $arr[$key] );
+                               $cleanKey = !$recursion ? stripslashes( $key ) : $key;
+                               $clean[$cleanKey] = $this->fix_magic_quotes( $arr[$key], true );
                        } else {
-                               $arr[$key] = stripslashes( $val );
+                               $cleanKey = stripslashes( $key );
+                               $clean[$cleanKey] = stripslashes( $val );
                        }
                }
+               $arr = $clean;
                return $arr;
        }
 
@@ -464,6 +488,8 @@ class WebRequest {
         * Extracts the given named values into an array.
         * If no arguments are given, returns all input values.
         * No transformation is performed on the values.
+        *
+        * @return array
         */
        public function getValues() {
                $names = func_get_args();
@@ -481,6 +507,16 @@ class WebRequest {
                return $retVal;
        }
 
+       /**
+        * Returns the names of all input values excluding those in $exclude.
+        *
+        * @param $exclude Array
+        * @return array
+        */
+       public function getValueNames( $exclude = array() ) {
+               return array_diff( array_keys( $this->getValues() ), $exclude );
+       }
+
        /**
         * Get the values passed in the query string.
         * No transformation is performed on the values.
@@ -501,7 +537,7 @@ class WebRequest {
         * @return Boolean
         */
        public function wasPosted() {
-               return $_SERVER['REQUEST_METHOD'] == 'POST';
+               return isset( $_SERVER['REQUEST_METHOD'] ) && $_SERVER['REQUEST_METHOD'] == 'POST';
        }
 
        /**
@@ -536,7 +572,8 @@ class WebRequest {
        }
 
        /**
-        * Return the path portion of the request URI.
+        * Return the path and query string portion of the request URI.
+        * This will be suitable for use as a relative link in HTML output.
         *
         * @return String
         */
@@ -574,13 +611,17 @@ class WebRequest {
        }
 
        /**
-        * Return the request URI with the canonical service and hostname.
+        * Return the request URI with the canonical service and hostname, path,
+        * and query string. This will be suitable for use as an absolute link
+        * in HTML or other output.
+        *
+        * If $wgServer is protocol-relative, this will return a fully
+        * qualified URL with the protocol that was used for this request.
         *
         * @return String
         */
        public function getFullRequestURL() {
-               global $wgServer;
-               return $wgServer . $this->getRequestURL();
+               return wfExpandUrl( $this->getRequestURL(), PROTO_CURRENT );
        }
 
        /**
@@ -603,6 +644,12 @@ class WebRequest {
                return htmlspecialchars( $this->appendQuery( $query ) );
        }
 
+       /**
+        * @param $key
+        * @param $value
+        * @param $onlyquery bool
+        * @return String
+        */
        public function appendQueryValue( $key, $value, $onlyquery = false ) {
                return $this->appendQueryArray( array( $key => $value ), $onlyquery );
        }
@@ -711,7 +758,7 @@ class WebRequest {
        /**
         * Return a WebRequestUpload object corresponding to the key
         *
-        * @param @key string
+        * @param $key string
         * @return WebRequestUpload
         */
        public function getUpload( $key ) {
@@ -746,7 +793,6 @@ class WebRequest {
                                $this->headers[ strtoupper( $tempName ) ] = $tempValue;
                        }
                } else {
-                       $headers = $_SERVER;
                        foreach ( $_SERVER as $name => $value ) {
                                if ( substr( $name, 0, 5 ) === 'HTTP_' ) {
                                        $name = str_replace( '_', '-',  substr( $name, 5 ) );
@@ -771,6 +817,8 @@ class WebRequest {
        /**
         * Get a request header, or false if it isn't set
         * @param $name String: case-insensitive header name
+        *
+        * @return string|false
         */
        public function getHeader( $name ) {
                $this->initHeaders();
@@ -806,10 +854,13 @@ class WebRequest {
        }
 
        /**
-        * Check if Internet Explorer will detect an incorrect cache extension in 
+        * Check if Internet Explorer will detect an incorrect cache extension in
         * PATH_INFO or QUERY_STRING. If the request can't be allowed, show an error
         * message or redirect to a safer URL. Returns true if the URL is OK, and
         * false if an error message has been shown and the request should be aborted.
+        *
+        * @param $extWhitelist array
+        * @return bool
         */
        public function checkUrlExtension( $extWhitelist = array() ) {
                global $wgScriptExtension;
@@ -823,17 +874,18 @@ class WebRequest {
                                        return false;
                                }
                        }
-                       wfHttpError( 403, 'Forbidden',
+                       throw new HttpError( 403,
                                'Invalid file extension found in the path info or query string.' );
-                       
-                       return false;
                }
                return true;
        }
 
        /**
-        * Attempt to redirect to a URL with a QUERY_STRING that's not dangerous in 
+        * Attempt to redirect to a URL with a QUERY_STRING that's not dangerous in
         * IE 6. Returns true if it was successful, false otherwise.
+        *
+        * @param $url string
+        * @return bool
         */
        protected function doSecurityRedirect( $url ) {
                header( 'Location: ' . $url );
@@ -847,11 +899,11 @@ class WebRequest {
 <body>
 <h1>Security redirect</h1>
 <p>
-We can't serve non-HTML content from the URL you have requested, because 
+We can't serve non-HTML content from the URL you have requested, because
 Internet Explorer would interpret it as an incorrect and potentially dangerous
 content type.</p>
-<p>Instead, please use <a href="$encUrl">this URL</a>, which is the same as the URL you have requested, except that 
-"&amp;*" is appended. This prevents Internet Explorer from seeing a bogus file 
+<p>Instead, please use <a href="$encUrl">this URL</a>, which is the same as the URL you have requested, except that
+"&amp;*" is appended. This prevents Internet Explorer from seeing a bogus file
 extension.
 </p>
 </body>
@@ -877,7 +929,11 @@ HTML;
         * QUERY_STRING, since IE 6 and earlier will use this to get the file type
         * if there was no dot before the question mark (bug 28235).
         *
-        * @deprecated Use checkUrlExtension(). 
+        * @deprecated Use checkUrlExtension().
+        *
+        * @param $extWhitelist array
+        *
+        * @return bool
         */
        public function isPathInfoBad( $extWhitelist = array() ) {
                global $wgScriptExtension;
@@ -916,7 +972,7 @@ HTML;
                foreach ( $langs as $lang => $val ) {
                        if ( $val === '' ) {
                                $langs[$lang] = 1;
-                       } else if ( $val == 0 ) {
+                       } elseif ( $val == 0 ) {
                                unset($langs[$lang]);
                        }
                }
@@ -925,6 +981,72 @@ HTML;
                arsort( $langs, SORT_NUMERIC );
                return $langs;
        }
+
+       /**
+        * Fetch the raw IP from the request
+        *
+        * @return String
+        */
+       protected function getRawIP() {
+               if ( isset( $_SERVER['REMOTE_ADDR'] ) ) {
+                       return IP::canonicalize( $_SERVER['REMOTE_ADDR'] );
+               } else {
+                       return null;
+               }
+       }
+
+       /**
+        * Work out the IP address based on various globals
+        * For trusted proxies, use the XFF client IP (first of the chain)
+        * @return string
+        */
+       public function getIP() {
+               global $wgUsePrivateIPs;
+
+               # Return cached result
+               if ( $this->ip !== null ) {
+                       return $this->ip;
+               }
+
+               # collect the originating ips
+               $ip = $this->getRawIP();
+
+               # Append XFF
+               $forwardedFor = $this->getHeader( 'X-Forwarded-For' );
+               if ( $forwardedFor !== false ) {
+                       $ipchain = array_map( 'trim', explode( ',', $forwardedFor ) );
+                       $ipchain = array_reverse( $ipchain );
+                       if ( $ip ) {
+                               array_unshift( $ipchain, $ip );
+                       }
+
+                       # Step through XFF list and find the last address in the list which is a trusted server
+                       # Set $ip to the IP address given by that trusted server, unless the address is not sensible (e.g. private)
+                       foreach ( $ipchain as $i => $curIP ) {
+                               $curIP = IP::canonicalize( $curIP );
+                               if ( wfIsTrustedProxy( $curIP ) ) {
+                                       if ( isset( $ipchain[$i + 1] ) ) {
+                                               if ( $wgUsePrivateIPs || IP::isPublic( $ipchain[$i + 1 ] ) ) {
+                                                       $ip = $ipchain[$i + 1];
+                                               }
+                                       }
+                               } else {
+                                       break;
+                               }
+                       }
+               }
+
+               # Allow extensions to improve our guess
+               wfRunHooks( 'GetIP', array( &$ip ) );
+
+               if ( !$ip ) {
+                       throw new MWException( "Unable to determine IP" );
+               }
+
+               wfDebug( "IP: $ip\n" );
+               $this->ip = $ip;
+               return $ip;
+       }
 }
 
 /**
@@ -1071,15 +1193,26 @@ class FauxRequest extends WebRequest {
                throw new MWException( "{$method}() not implemented" );
        }
 
+       /**
+        * @param $name string
+        * @param $default string
+        * @return string
+        */
        public function getText( $name, $default = '' ) {
                # Override; don't recode since we're using internal data
                return (string)$this->getVal( $name, $default );
        }
 
+       /**
+        * @return Array
+        */
        public function getValues() {
                return $this->data;
        }
 
+       /**
+        * @return array
+        */
        public function getQueryValues() {
                if ( $this->wasPosted ) {
                        return array();
@@ -1088,6 +1221,9 @@ class FauxRequest extends WebRequest {
                }
        }
 
+       /**
+        * @return bool
+        */
        public function wasPosted() {
                return $this->wasPosted;
        }
@@ -1100,10 +1236,18 @@ class FauxRequest extends WebRequest {
                $this->notImplemented( __METHOD__ );
        }
 
+       /**
+        * @param $name
+        * @return bool|string
+        */
        public function getHeader( $name ) {
                return isset( $this->headers[$name] ) ? $this->headers[$name] : false;
        }
 
+       /**
+        * @param $name string
+        * @param $val string
+        */
        public function setHeader( $name, $val ) {
                $this->headers[$name] = $val;
        }
@@ -1121,11 +1265,26 @@ class FauxRequest extends WebRequest {
                return $this->session;
        }
 
+       /**
+        * @param array $extWhitelist
+        * @return bool
+        */
        public function isPathInfoBad( $extWhitelist = array() ) {
                return false;
        }
 
+       /**
+        * @param array $extWhitelist
+        * @return bool
+        */
        public function checkUrlExtension( $extWhitelist = array() ) {
                return true;
        }
+
+       /**
+        * @return string
+        */
+       protected function getRawIP() {
+               return '127.0.0.1';
+       }
 }