Small todo note about ApiMain
[lhc/web/wiklou.git] / includes / WebRequest.php
index 6c20324..8f2bafd 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
@@ -161,10 +167,16 @@ 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;
@@ -227,16 +239,24 @@ class WebRequest {
         * used for undoing the evil that is magic_quotes_gpc.
         *
         * @param $arr array: will be modified
+        * @param $topLevel bool Specifies if the array passed is from the top
+        * level of the source. In PHP5 magic_quotes only escapes the first level
+        * of keys that belong to an array.
         * @return array the original array
+        * @see http://www.php.net/manual/en/function.get-magic-quotes-gpc.php#49612
         */
-       private function &fix_magic_quotes( &$arr ) {
+       private function &fix_magic_quotes( &$arr, $topLevel = true ) {
+               $clean = array();
                foreach( $arr as $key => $val ) {
                        if( is_array( $val ) ) {
-                               $this->fix_magic_quotes( $arr[$key] );
+                               $cleanKey = $topLevel ? stripslashes( $key ) : $key;
+                               $clean[$cleanKey] = $this->fix_magic_quotes( $arr[$key], false );
                        } else {
-                               $arr[$key] = stripslashes( $val );
+                               $cleanKey = stripslashes( $key );
+                               $clean[$cleanKey] = stripslashes( $val );
                        }
                }
+               $arr = $clean;
                return $arr;
        }
 
@@ -598,13 +618,13 @@ class WebRequest {
         * and query string. This will be suitable for use as an absolute link
         * in HTML or other output.
         *
-        * NOTE: This will output a protocol-relative URL if $wgServer is protocol-relative
+        * 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 );
        }
 
        /**
@@ -857,10 +877,8 @@ 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;
        }
@@ -915,6 +933,10 @@ HTML;
         * if there was no dot before the question mark (bug 28235).
         *
         * @deprecated Use checkUrlExtension().
+        *
+        * @param $extWhitelist array
+        *
+        * @return bool
         */
        public function isPathInfoBad( $extWhitelist = array() ) {
                global $wgScriptExtension;
@@ -924,7 +946,7 @@ HTML;
 
        /**
         * Parse the Accept-Language header sent by the client into an array
-        * @return array( languageCode => q-value ) sorted by q-value in descending order
+        * @return array array( languageCode => q-value ) sorted by q-value in descending order
         * May contain the "language" '*', which applies to languages other than those explicitly listed.
         * This is aligned with rfc2616 section 14.4
         */
@@ -940,7 +962,7 @@ HTML;
 
                // Break up string into pieces (languages and q factors)
                $lang_parse = null;
-               preg_match_all( '/([a-z]{1,8}(-[a-z]{1,8})?|\*)\s*(;\s*q\s*=\s*(1|0(\.[0-9]+)?)?)?/',
+               preg_match_all( '/([a-z]{1,8}(-[a-z]{1,8})*|\*)\s*(;\s*q\s*=\s*(1(\.0{0,3})?|0(\.[0-9]{0,3})?)?)?/',
                        $acceptLang, $lang_parse );
 
                if ( !count( $lang_parse[1] ) ) {
@@ -962,6 +984,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;
+       }
 }
 
 /**
@@ -1104,19 +1192,34 @@ class FauxRequest extends WebRequest {
                        $this->session = $session;
        }
 
+       /**
+        * @param $method string
+        * @throws MWException
+        */
        private function notImplemented( $method ) {
                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();
@@ -1125,6 +1228,9 @@ class FauxRequest extends WebRequest {
                }
        }
 
+       /**
+        * @return bool
+        */
        public function wasPosted() {
                return $this->wasPosted;
        }
@@ -1137,10 +1243,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;
        }
@@ -1158,11 +1272,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';
+       }
 }