­ ­ ­ ­ ­ ­ ­ ­ ­ ­ ­ ­ ­ ­ ­ ­ ­ ­ 'http://icanhazip.com', 'ipify' => 'http://api.ipify.org/', 'ipecho' => 'http://ipecho.net/plain', 'ident' => 'http://ident.me', 'whatismyipaddress' => 'http://bot.whatismyipaddress.com', 'ip.appspot' => 'http://ip.appspot.com', ); /** * API endpoints for geolocating an IP address * * @var array */ private static $geoip_apis = array( 'freegeoip' => 'https://freegeoip.net/json/%s', 'ipinfo.io' => 'https://ipinfo.io/%s/json', 'ip-api.com' => 'http://ip-api.com/json/%s', ); /** * Hook in tabs. */ public static function init() { // Only download the database from MaxMind if the geolocation function is enabled, or a plugin specifically requests it. if ( 'geolocation' === get_option( 'woocommerce_default_customer_address' ) || apply_filters( 'woocommerce_geolocation_update_database_periodically', false ) ) { add_action( 'woocommerce_geoip_updater', array( __CLASS__, 'update_database' ) ); } add_filter( 'pre_update_option_woocommerce_default_customer_address', array( __CLASS__, 'maybe_update_database' ), 10, 2 ); } /** * Maybe trigger a DB update for the first time. * * @param string $new_value New value. * @param string $old_value Old value. * @return string */ public static function maybe_update_database( $new_value, $old_value ) { if ( $new_value !== $old_value && 'geolocation' === $new_value ) { self::update_database(); } return $new_value; } /** * Get current user IP Address. * * @return string */ public static function get_ip_address() { if ( isset( $_SERVER['HTTP_X_REAL_IP'] ) ) { // WPCS: input var ok, CSRF ok. return sanitize_text_field( wp_unslash( $_SERVER['HTTP_X_REAL_IP'] ) ); // WPCS: input var ok, CSRF ok. } elseif ( isset( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) { // WPCS: input var ok, CSRF ok. // Proxy servers can send through this header like this: X-Forwarded-For: client1, proxy1, proxy2 // Make sure we always only send through the first IP in the list which should always be the client IP. return (string) rest_is_ip_address( trim( current( preg_split( '/[,:]/', sanitize_text_field( wp_unslash( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) ) ) ) ); // WPCS: input var ok, CSRF ok. } elseif ( isset( $_SERVER['REMOTE_ADDR'] ) ) { // @codingStandardsIgnoreLine return sanitize_text_field( wp_unslash( $_SERVER['REMOTE_ADDR'] ) ); // @codingStandardsIgnoreLine } return ''; } /** * Get user IP Address using an external service. * This is used mainly as a fallback for users on localhost where * get_ip_address() will be a local IP and non-geolocatable. * * @return string */ public static function get_external_ip_address() { $external_ip_address = '0.0.0.0'; if ( '' !== self::get_ip_address() ) { $transient_name = 'external_ip_address_' . self::get_ip_address(); $external_ip_address = get_transient( $transient_name ); } if ( false === $external_ip_address ) { $external_ip_address = '0.0.0.0'; $ip_lookup_services = apply_filters( 'woocommerce_geolocation_ip_lookup_apis', self::$ip_lookup_apis ); $ip_lookup_services_keys = array_keys( $ip_lookup_services ); shuffle( $ip_lookup_services_keys ); foreach ( $ip_lookup_services_keys as $service_name ) { $service_endpoint = $ip_lookup_services[ $service_name ]; $response = wp_safe_remote_get( $service_endpoint, array( 'timeout' => 2 ) ); if ( ! is_wp_error( $response ) && $response['body'] ) { $external_ip_address = apply_filters( 'woocommerce_geolocation_ip_lookup_api_response', wc_clean( $response['body'] ), $service_name ); break; } } set_transient( $transient_name, $external_ip_address, WEEK_IN_SECONDS ); } return $external_ip_address; } /** * Geolocate an IP address. * * @param string $ip_address IP Address. * @param bool $fallback If true, fallbacks to alternative IP detection (can be slower). * @param bool $api_fallback If true, uses geolocation APIs if the database file doesn't exist (can be slower). * @return array */ public static function geolocate_ip( $ip_address = '', $fallback = true, $api_fallback = true ) { // Filter to allow custom geolocation of the IP address. $country_code = apply_filters( 'woocommerce_geolocate_ip', false, $ip_address, $fallback, $api_fallback ); if ( false === $country_code ) { // If GEOIP is enabled in CloudFlare, we can use that (Settings -> CloudFlare Settings -> Settings Overview). if ( ! empty( $_SERVER['HTTP_CF_IPCOUNTRY'] ) ) { // WPCS: input var ok, CSRF ok. $country_code = strtoupper( sanitize_text_field( wp_unslash( $_SERVER['HTTP_CF_IPCOUNTRY'] ) ) ); // WPCS: input var ok, CSRF ok. } elseif ( ! empty( $_SERVER['GEOIP_COUNTRY_CODE'] ) ) { // WPCS: input var ok, CSRF ok. // WP.com VIP has a variable available. $country_code = strtoupper( sanitize_text_field( wp_unslash( $_SERVER['GEOIP_COUNTRY_CODE'] ) ) ); // WPCS: input var ok, CSRF ok. } elseif ( ! empty( $_SERVER['HTTP_X_COUNTRY_CODE'] ) ) { // WPCS: input var ok, CSRF ok. // VIP Go has a variable available also. $country_code = strtoupper( sanitize_text_field( wp_unslash( $_SERVER['HTTP_X_COUNTRY_CODE'] ) ) ); // WPCS: input var ok, CSRF ok. } else { $ip_address = $ip_address ? $ip_address : self::get_ip_address(); if ( self::is_ipv6( $ip_address ) ) { $database = self::get_local_database_path( 'v6' ); } else { $database = self::get_local_database_path(); } if ( file_exists( $database ) ) { $country_code = self::geolocate_via_db( $ip_address ); } elseif ( $api_fallback ) { $country_code = self::geolocate_via_api( $ip_address ); } else { $country_code = ''; } if ( ! $country_code && $fallback ) { // May be a local environment - find external IP. return self::geolocate_ip( self::get_external_ip_address(), false, $api_fallback ); } } } return array( 'country' => $country_code, 'state' => '', ); } /** * Path to our local db. * * @param string $version Version. * @return string */ public static function get_local_database_path( $version = 'v4' ) { $version = 'v4' === $version ? '' : 'v6'; $upload_dir = wp_upload_dir(); return apply_filters( 'woocommerce_geolocation_local_database_path', $upload_dir['basedir'] . '/GeoIP' . $version . '.dat', $version ); } /** * Update geoip database. Adapted from https://wordpress.org/plugins/geoip-detect/. */ public static function update_database() { $logger = wc_get_logger(); if ( ! is_callable( 'gzopen' ) ) { $logger->notice( 'Server does not support gzopen', array( 'source' => 'geolocation' ) ); return; } require_once ABSPATH . 'wp-admin/includes/file.php'; $tmp_databases = array( 'v4' => download_url( self::GEOLITE_DB ), 'v6' => download_url( self::GEOLITE_IPV6_DB ), ); foreach ( $tmp_databases as $tmp_database_version => $tmp_database_path ) { if ( ! is_wp_error( $tmp_database_path ) ) { $gzhandle = @gzopen( $tmp_database_path, 'r' ); // @codingStandardsIgnoreLine $handle = @fopen( self::get_local_database_path( $tmp_database_version ), 'w' ); // @codingStandardsIgnoreLine if ( $gzhandle && $handle ) { while ( $string = gzread( $gzhandle, 4096 ) ) { // @codingStandardsIgnoreLine fwrite( $handle, $string, strlen( $string ) ); // @codingStandardsIgnoreLine } gzclose( $gzhandle ); $s_array = fstat( $handle ); fclose( $handle ); // @codingStandardsIgnoreLine if ( ! isset( $s_array['size'] ) || 0 === $s_array['size'] ) { $logger->notice( 'Empty database file, deleting local copy.', array( 'source' => 'geolocation' ) ); // Delete empty DB, we do not want to keep empty files around. @unlink( self::get_local_database_path( $tmp_database_version ) ); // @codingStandardsIgnoreLine // Reschedule download of DB. wp_clear_scheduled_hook( 'woocommerce_geoip_updater' ); wp_schedule_event( strtotime( 'first tuesday of next month' ), 'monthly', 'woocommerce_geoip_updater' ); } } else { $logger->notice( 'Unable to open database file', array( 'source' => 'geolocation' ) ); } @unlink( $tmp_database_path ); // @codingStandardsIgnoreLine } else { $logger->notice( 'Unable to download GeoIP Database: ' . $tmp_database_path->get_error_message(), array( 'source' => 'geolocation' ) ); } } } /** * Use MAXMIND GeoLite database to geolocation the user. * * @param string $ip_address IP address. * @return string */ private static function geolocate_via_db( $ip_address ) { if ( ! class_exists( 'WC_Geo_IP', false ) ) { include_once WC_ABSPATH . 'includes/class-wc-geo-ip.php'; } $gi = new WC_Geo_IP(); if ( self::is_ipv6( $ip_address ) ) { $database = self::get_local_database_path( 'v6' ); if ( ! self::get_file_size( $database ) ) { return false; } $gi->geoip_open( $database, 0 ); $country_code = $gi->geoip_country_code_by_addr_v6( $ip_address ); } else { $database = self::get_local_database_path(); if ( ! self::get_file_size( $database ) ) { return false; } $gi->geoip_open( $database, 0 ); $country_code = $gi->geoip_country_code_by_addr( $ip_address ); } $gi->geoip_close(); return sanitize_text_field( strtoupper( $country_code ) ); } /** * Check file size * Check the file size, if empty file also delete it. * * @param string $filename Name of the file to check. * @return bool|int */ private static function get_file_size( $filename ) { $handle = @fopen( $filename, 'r' ); // @codingStandardsIgnoreLine $s_array = fstat( $handle ); // @codingStandardsIgnoreLine @fclose( $handle ); // @codingStandardsIgnoreLine if ( ! isset( $s_array['size'] ) || 0 === $s_array['size'] ) { $logger = wc_get_logger(); $logger->notice( 'Empty database file, deleting local copy.', array( 'source' => 'geolocation' ) ); // Delete the file as we do not want to keep empty files around. @unlink( $filename ); // @codingStandardsIgnoreLine return false; } return $s_array['size']; } /** * Use APIs to Geolocate the user. * * @param string $ip_address IP address. * @return string|bool */ private static function geolocate_via_api( $ip_address ) { $country_code = get_transient( 'geoip_' . $ip_address ); if ( false === $country_code ) { $geoip_services = apply_filters( 'woocommerce_geolocation_geoip_apis', self::$geoip_apis ); $geoip_services_keys = array_keys( $geoip_services ); shuffle( $geoip_services_keys ); foreach ( $geoip_services_keys as $service_name ) { $service_endpoint = $geoip_services[ $service_name ]; $response = wp_safe_remote_get( sprintf( $service_endpoint, $ip_address ), array( 'timeout' => 2 ) ); if ( ! is_wp_error( $response ) && $response['body'] ) { switch ( $service_name ) { case 'ipinfo.io': $data = json_decode( $response['body'] ); $country_code = isset( $data->country ) ? $data->country : ''; break; case 'ip-api.com': $data = json_decode( $response['body'] ); $country_code = isset( $data->countryCode ) ? $data->countryCode : ''; // @codingStandardsIgnoreLine break; case 'freegeoip': $data = json_decode( $response['body'] ); $country_code = isset( $data->country_code ) ? $data->country_code : ''; break; default: $country_code = apply_filters( 'woocommerce_geolocation_geoip_response_' . $service_name, '', $response['body'] ); break; } $country_code = sanitize_text_field( strtoupper( $country_code ) ); if ( $country_code ) { break; } } } set_transient( 'geoip_' . $ip_address, $country_code, WEEK_IN_SECONDS ); } return $country_code; } /** * Test if is IPv6. * * @since 2.4.0 * * @param string $ip_address IP Address. * @return bool */ private static function is_ipv6( $ip_address ) { return false !== filter_var( $ip_address, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6 ); } } WC_Geolocation::init();