Changed doQuery() -> query()
[lhc/web/wiklou.git] / includes / ProxyTools.php
index aaf2ee1..13c1996 100644 (file)
@@ -1,20 +1,32 @@
 <?php
 /**
  * Functions for dealing with proxies
+ *
+ * @file
  */
 
+/**
+ * Extracts the XFF string from the request header
+ * Checks first for "X-Forwarded-For", then "Client-ip"
+ * Note: headers are spoofable
+ * @return string
+ */
 function wfGetForwardedFor() {
        if( function_exists( 'apache_request_headers' ) ) {
                // More reliable than $_SERVER due to case and -/_ folding
-               $set = apache_request_headers();
-               $index = 'X-Forwarded-For';
-               $index2 = 'Client-ip';
+               $set = array ();
+               foreach ( apache_request_headers() as $tempName => $tempValue ) {
+                       $set[ strtoupper( $tempName ) ] = $tempValue;
+               }
+               $index = strtoupper ( 'X-Forwarded-For' );
+               $index2 = strtoupper ( 'Client-ip' );
        } else {
                // Subject to spoofing with headers like X_Forwarded_For
                $set = $_SERVER;
                $index = 'HTTP_X_FORWARDED_FOR';
                $index2 = 'CLIENT-IP';
        }
+
        #Try a couple of headers
        if( isset( $set[$index] ) ) {
                return $set[$index];
@@ -26,29 +38,18 @@ function wfGetForwardedFor() {
 }
 
 /**
- * Locates the client IP within a given XFF string
- * @param string $xff
+ * Returns the browser/OS data from the request header
+ * Note: headers are spoofable
  * @return string
  */
-function wfGetClientIPfromXFF( $xff ) {
-       if ( !$xff ) return null;
-       $xff = substr( $xff, 0, 511 );
-       // Just look for the first IP match
-       // We might have a mix of IPv4/IPv6
-       if ( preg_match('#\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}|:(:[0-9A-Fa-f]{1,4}){1,7}|[0-9A-Fa-f]{1,4}(:{1,2}[0-9A-Fa-f]{1,4}|::$){1,7}#', $xff, $ip) ) {       
-               // Check if the numbers are valid
-               if ( IP::isIPAddress($ip) )
-                  return $ip;
-       }
-       
-       return null;
-}
-
 function wfGetAgent() {
        if( function_exists( 'apache_request_headers' ) ) {
                // More reliable than $_SERVER due to case and -/_ folding
-               $set = apache_request_headers();
-               $index = 'User-Agent';
+               $set = array ();
+               foreach ( apache_request_headers() as $tempName => $tempValue ) {
+                       $set[ strtoupper( $tempName ) ] = $tempValue;
+               }
+               $index = strtoupper ( 'User-Agent' );
        } else {
                // Subject to spoofing with headers like X_Forwarded_For
                $set = $_SERVER;
@@ -61,24 +62,32 @@ function wfGetAgent() {
        }
 }
 
-/** Work out the IP address based on various globals */
+/**
+ * Work out the IP address based on various globals
+ * For trusted proxies, use the XFF client IP (first of the chain)
+ * @return string
+ */
 function wfGetIP() {
-       global $wgIP;
+       global $wgUsePrivateIPs, $wgCommandLineMode;
+       static $ip = false;
 
        # Return cached result
-       if ( !empty( $wgIP ) ) {
-               return $wgIP;
+       if ( !empty( $ip ) ) {
+               return $ip;
        }
 
+       $ipchain = array();
+
        /* collect the originating ips */
        # Client connecting to this webserver
        if ( isset( $_SERVER['REMOTE_ADDR'] ) ) {
-               $ipchain = array( IP::canonicalize( $_SERVER['REMOTE_ADDR'] ) );
-       } else {
-               # Running on CLI?
-               $ipchain = array( '127.0.0.1' );
+               $ip = IP::canonicalize( $_SERVER['REMOTE_ADDR'] );
+       } elseif( $wgCommandLineMode ) {
+               $ip = '127.0.0.1';
+       }
+       if( $ip ) {
+               $ipchain[] = $ip;
        }
-       $ip = $ipchain[0];
 
        # Append XFF on to $ipchain
        $forwardedFor = wfGetForwardedFor();
@@ -87,31 +96,45 @@ function wfGetIP() {
                $xff = array_reverse( $xff );
                $ipchain = array_merge( $ipchain, $xff );
        }
-       
+
        # 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] ) && IP::isPublic( $ipchain[$i + 1] ) ) {
-                               $ip = $ipchain[$i + 1];
+                       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" );
-       $wgIP = $ip;
        return $ip;
 }
 
+/**
+ * Checks if an IP is a trusted proxy providor
+ * Useful to tell if X-Fowarded-For data is possibly bogus
+ * Squid cache servers for the site and AOL are whitelisted
+ * @param $ip String
+ * @return bool
+ */
 function wfIsTrustedProxy( $ip ) {
        global $wgSquidServers, $wgSquidServersNoPurge;
 
-       if ( in_array( $ip, $wgSquidServers ) || 
-               in_array( $ip, $wgSquidServersNoPurge ) || 
-               wfIsAOLProxy( $ip ) 
+       if ( in_array( $ip, $wgSquidServers ) ||
+               in_array( $ip, $wgSquidServersNoPurge )
        ) {
                $trusted = true;
        } else {
@@ -127,7 +150,7 @@ function wfIsTrustedProxy( $ip ) {
  */
 function wfProxyCheck() {
        global $wgBlockOpenProxies, $wgProxyPorts, $wgProxyScriptPath;
-       global $wgUseMemCached, $wgMemc, $wgProxyMemcExpiry;
+       global $wgMemc, $wgProxyMemcExpiry;
        global $wgProxyKey;
 
        if ( !$wgBlockOpenProxies ) {
@@ -137,14 +160,9 @@ function wfProxyCheck() {
        $ip = wfGetIP();
 
        # Get MemCached key
-       $skip = false;
-       if ( $wgUseMemCached ) {
-               $mcKey = wfMemcKey( 'proxy', 'ip', $ip );
-               $mcValue = $wgMemc->get( $mcKey );
-               if ( $mcValue ) {
-                       $skip = true;
-               }
-       }
+       $mcKey = wfMemcKey( 'proxy', 'ip', $ip );
+       $mcValue = $wgMemc->get( $mcKey );
+       $skip = (bool)$mcValue;
 
        # Fork the processes
        if ( !$skip ) {
@@ -159,33 +177,35 @@ function wfProxyCheck() {
                                                escapeshellarg( $port ),
                                                escapeshellarg( $url )
                                                ));
-                       exec( "php $params &>/dev/null &" );
+                       exec( "php $params >" . wfGetNull() . " 2>&1 &" );
                }
                # Set MemCached key
-               if ( $wgUseMemCached ) {
-                       $wgMemc->set( $mcKey, 1, $wgProxyMemcExpiry );
-               }
+               $wgMemc->set( $mcKey, 1, $wgProxyMemcExpiry );
        }
 }
 
 /**
  * Convert a network specification in CIDR notation to an integer network and a number of bits
+ *
+ * @deprecated Call IP::parseCIDR() directly, will be removed in 1.19
+ * @return array(string, int)
  */
 function wfParseCIDR( $range ) {
+       wfDeprecated( __FUNCTION__ );
        return IP::parseCIDR( $range );
 }
 
 /**
  * Check if an IP address is in the local proxy list
+ * @return bool
  */
 function wfIsLocallyBlockedProxy( $ip ) {
        global $wgProxyList;
-       $fname = 'wfIsLocallyBlockedProxy';
 
        if ( !$wgProxyList ) {
                return false;
        }
-       wfProfileIn( $fname );
+       wfProfileIn( __METHOD__ );
 
        if ( !is_array( $wgProxyList ) ) {
                # Load from the specified file
@@ -202,56 +222,7 @@ function wfIsLocallyBlockedProxy( $ip ) {
        } else {
                $ret = false;
        }
-       wfProfileOut( $fname );
+       wfProfileOut( __METHOD__ );
        return $ret;
 }
 
-/**
- * TODO: move this list to the database in a global IP info table incorporating
- * trusted ISP proxies, blocked IP addresses and open proxies.
- */
-function wfIsAOLProxy( $ip ) {
-       $ranges = array(
-               '64.12.96.0/19',
-               '149.174.160.0/20',
-               '152.163.240.0/21',
-               '152.163.248.0/22',
-               '152.163.252.0/23',
-               '152.163.96.0/22',
-               '152.163.100.0/23',
-               '195.93.32.0/22',
-               '195.93.48.0/22',
-               '195.93.64.0/19',
-               '195.93.96.0/19',
-               '195.93.16.0/20',
-               '198.81.0.0/22',
-               '198.81.16.0/20',
-               '198.81.8.0/23',
-               '202.67.64.128/25',
-               '205.188.192.0/20',
-               '205.188.208.0/23',
-               '205.188.112.0/20',
-               '205.188.146.144/30',
-               '207.200.112.0/21',
-       );
-
-       static $parsedRanges;
-       if ( is_null( $parsedRanges ) ) {
-               $parsedRanges = array();
-               foreach ( $ranges as $range ) {
-                       $parsedRanges[] =  IP::parseRange( $range );
-               }
-       }
-
-       $hex = IP::toHex( $ip );
-       foreach ( $parsedRanges as $range ) {
-               if ( $hex >= $range[0] && $hex <= $range[1] ) {
-                       return true;
-               }
-       }
-       return false;
-}
-
-
-
-?>