378 lines
13 KiB
PHP
378 lines
13 KiB
PHP
<?php
|
|
/**
|
|
* Geolocation class
|
|
*
|
|
* Handles geolocation and updating the geolocation database.
|
|
*
|
|
* This product includes GeoLite data created by MaxMind, available from http://www.maxmind.com.
|
|
*
|
|
* @package WooCommerce/Classes
|
|
* @version 3.4.0
|
|
*/
|
|
|
|
defined( 'ABSPATH' ) || exit;
|
|
|
|
/**
|
|
* WC_Geolocation Class.
|
|
*/
|
|
class WC_Geolocation {
|
|
|
|
/**
|
|
* GeoLite IPv4 DB.
|
|
*
|
|
* @deprecated 3.4.0
|
|
*/
|
|
const GEOLITE_DB = 'http://geolite.maxmind.com/download/geoip/database/GeoLiteCountry/GeoIP.dat.gz';
|
|
|
|
/**
|
|
* GeoLite IPv6 DB.
|
|
*
|
|
* @deprecated 3.4.0
|
|
*/
|
|
const GEOLITE_IPV6_DB = 'http://geolite.maxmind.com/download/geoip/database/GeoIPv6.dat.gz';
|
|
|
|
/**
|
|
* GeoLite2 DB.
|
|
*
|
|
* @since 3.4.0
|
|
*/
|
|
const GEOLITE2_DB = 'http://geolite.maxmind.com/download/geoip/database/GeoLite2-Country.tar.gz';
|
|
|
|
/**
|
|
* API endpoints for looking up user IP address.
|
|
*
|
|
* @var array
|
|
*/
|
|
private static $ip_lookup_apis = array(
|
|
'ipify' => 'http://api.ipify.org/',
|
|
'ipecho' => 'http://ipecho.net/plain',
|
|
'ident' => 'http://ident.me',
|
|
'whatismyipaddress' => 'http://bot.whatismyipaddress.com',
|
|
);
|
|
|
|
/**
|
|
* API endpoints for geolocating an IP address
|
|
*
|
|
* @var array
|
|
*/
|
|
private static $geoip_apis = array(
|
|
'ipinfo.io' => 'https://ipinfo.io/%s/json',
|
|
'ip-api.com' => 'http://ip-api.com/json/%s',
|
|
);
|
|
|
|
/**
|
|
* Check if server supports MaxMind GeoLite2 Reader.
|
|
*
|
|
* @since 3.4.0
|
|
* @return bool
|
|
*/
|
|
private static function supports_geolite2() {
|
|
return version_compare( PHP_VERSION, '5.4.0', '>=' );
|
|
}
|
|
|
|
/**
|
|
* Check if geolocation is enabled.
|
|
*
|
|
* @since 3.4.0
|
|
* @param string $current_settings Current geolocation settings.
|
|
* @return bool
|
|
*/
|
|
private static function is_geolocation_enabled( $current_settings ) {
|
|
return in_array( $current_settings, array( 'geolocation', 'geolocation_ajax' ), true );
|
|
}
|
|
|
|
/**
|
|
* Prevent geolocation via MaxMind when using legacy versions of php.
|
|
*
|
|
* @since 3.4.0
|
|
* @param string $default_customer_address current value.
|
|
* @return string
|
|
*/
|
|
public static function disable_geolocation_on_legacy_php( $default_customer_address ) {
|
|
if ( self::is_geolocation_enabled( $default_customer_address ) ) {
|
|
$default_customer_address = 'base';
|
|
}
|
|
|
|
return $default_customer_address;
|
|
}
|
|
|
|
/**
|
|
* Hook in geolocation functionality.
|
|
*/
|
|
public static function init() {
|
|
if ( self::supports_geolite2() ) {
|
|
// Only download the database from MaxMind if the geolocation function is enabled, or a plugin specifically requests it.
|
|
if ( self::is_geolocation_enabled( get_option( 'woocommerce_default_customer_address' ) ) || apply_filters( 'woocommerce_geolocation_update_database_periodically', false ) ) {
|
|
add_action( 'woocommerce_geoip_updater', array( __CLASS__, 'update_database' ) );
|
|
}
|
|
|
|
// Trigger database update when settings are changed to enable geolocation.
|
|
add_filter( 'pre_update_option_woocommerce_default_customer_address', array( __CLASS__, 'maybe_update_database' ), 10, 2 );
|
|
} else {
|
|
add_filter( 'pre_option_woocommerce_default_customer_address', array( __CLASS__, 'disable_geolocation_on_legacy_php' ) );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* 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 && self::is_geolocation_enabled( $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 ) && rest_is_ip_address( $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();
|
|
$database = self::get_local_database_path();
|
|
|
|
if ( self::supports_geolite2() && file_exists( $database ) ) {
|
|
$country_code = self::geolocate_via_db( $ip_address, $database );
|
|
} 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 $deprecated Deprecated since 3.4.0.
|
|
* @return string
|
|
*/
|
|
public static function get_local_database_path( $deprecated = '2' ) {
|
|
$upload_dir = wp_get_upload_dir();
|
|
|
|
return apply_filters( 'woocommerce_geolocation_local_database_path', $upload_dir['basedir'] . '/GeoLite2-Country.mmdb', $deprecated );
|
|
}
|
|
|
|
/**
|
|
* Update geoip database.
|
|
*/
|
|
public static function update_database() {
|
|
$logger = wc_get_logger();
|
|
|
|
if ( ! self::supports_geolite2() ) {
|
|
$logger->notice( 'Requires PHP 5.4 to be able to download MaxMind GeoLite2 database', array( 'source' => 'geolocation' ) );
|
|
return;
|
|
}
|
|
|
|
require_once ABSPATH . 'wp-admin/includes/file.php';
|
|
|
|
$upload_dir = wp_upload_dir();
|
|
$tmp_database_path = download_url( self::GEOLITE2_DB );
|
|
|
|
if ( ! is_wp_error( $tmp_database_path ) ) {
|
|
try {
|
|
// GeoLite2 database name.
|
|
$database = 'GeoLite2-Country.mmdb';
|
|
$dest_path = trailingslashit( $upload_dir['basedir'] ) . $database;
|
|
|
|
// Extract files with PharData. Tool built into PHP since 5.3.
|
|
$file = new PharData( $tmp_database_path ); // phpcs:ignore PHPCompatibility.Classes.NewClasses.phardataFound
|
|
$file_path = trailingslashit( $file->current()->getFileName() ) . $database;
|
|
|
|
// Extract under uploads directory.
|
|
$file->extractTo( $upload_dir['basedir'], $file_path, true );
|
|
|
|
// Remove old database.
|
|
@unlink( $dest_path ); // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged, WordPress.VIP.FileSystemWritesDisallow.file_ops_unlink
|
|
|
|
// Copy database and delete tmp directories.
|
|
@rename( trailingslashit( $upload_dir['basedir'] ) . $file_path, $dest_path ); // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged, WordPress.VIP.FileSystemWritesDisallow.file_ops_rename
|
|
@rmdir( trailingslashit( $upload_dir['basedir'] ) . $file->current()->getFileName() ); // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged, WordPress.VIP.FileSystemWritesDisallow.directory_rmdir
|
|
|
|
// Set correct file permission.
|
|
@chmod( $dest_path, 0644 ); // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged, WordPress.VIP.FileSystemWritesDisallow.chmod_chmod
|
|
} catch ( Exception $e ) {
|
|
$logger->notice( $e->getMessage(), array( 'source' => 'geolocation' ) );
|
|
|
|
// Reschedule download of DB.
|
|
wp_clear_scheduled_hook( 'woocommerce_geoip_updater' );
|
|
wp_schedule_event( strtotime( 'first tuesday of next month' ), 'monthly', 'woocommerce_geoip_updater' );
|
|
}
|
|
|
|
@unlink( $tmp_database_path ); // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged, WordPress.VIP.FileSystemWritesDisallow.file_ops_unlink
|
|
} 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.
|
|
* @param string $database Database path.
|
|
* @return string
|
|
*/
|
|
private static function geolocate_via_db( $ip_address, $database ) {
|
|
if ( ! class_exists( 'WC_Geolite_Integration', false ) ) {
|
|
require_once WC_ABSPATH . 'includes/class-wc-geolite-integration.php';
|
|
}
|
|
|
|
$geolite = new WC_Geolite_Integration( $database );
|
|
|
|
return $geolite->get_country_iso( $ip_address );
|
|
}
|
|
|
|
/**
|
|
* Use APIs to Geolocate the user.
|
|
*
|
|
* Geolocation APIs can be added through the use of the woocommerce_geolocation_geoip_apis filter.
|
|
* Provide a name=>value pair for service-slug=>endpoint.
|
|
*
|
|
* If APIs are defined, one will be chosen at random to fulfil the request. After completing, the result
|
|
* will be cached in a transient.
|
|
*
|
|
* @param string $ip_address IP address.
|
|
* @return string
|
|
*/
|
|
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 );
|
|
|
|
if ( empty( $geoip_services ) ) {
|
|
return '';
|
|
}
|
|
|
|
$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;
|
|
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;
|
|
}
|
|
}
|
|
|
|
WC_Geolocation::init();
|