<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Geolocation class

[2] Fix | Delete

*

[3] Fix | Delete

* Handles geolocation and updating the geolocation database.

[4] Fix | Delete

*

[5] Fix | Delete

* This product includes GeoLite data created by MaxMind, available from http://www.maxmind.com.

[6] Fix | Delete

*

[7] Fix | Delete

* @package WooCommerce\Classes

[8] Fix | Delete

* @version 3.9.0

[9] Fix | Delete

*/

[10] Fix | Delete

[11] Fix | Delete

defined( 'ABSPATH' ) || exit;

[12] Fix | Delete

[13] Fix | Delete

/**

[14] Fix | Delete

* WC_Geolocation Class.

[15] Fix | Delete

*/

[16] Fix | Delete

class WC_Geolocation {

[17] Fix | Delete

[18] Fix | Delete

/**

[19] Fix | Delete

* GeoLite IPv4 DB.

[20] Fix | Delete

*

[21] Fix | Delete

* @deprecated 3.4.0

[22] Fix | Delete

*/

[23] Fix | Delete

const GEOLITE_DB = 'http://geolite.maxmind.com/download/geoip/database/GeoLiteCountry/GeoIP.dat.gz';

[24] Fix | Delete

[25] Fix | Delete

/**

[26] Fix | Delete

* GeoLite IPv6 DB.

[27] Fix | Delete

*

[28] Fix | Delete

* @deprecated 3.4.0

[29] Fix | Delete

*/

[30] Fix | Delete

const GEOLITE_IPV6_DB = 'http://geolite.maxmind.com/download/geoip/database/GeoIPv6.dat.gz';

[31] Fix | Delete

[32] Fix | Delete

/**

[33] Fix | Delete

* GeoLite2 DB.

[34] Fix | Delete

*

[35] Fix | Delete

* @since 3.4.0

[36] Fix | Delete

* @deprecated 3.9.0

[37] Fix | Delete

*/

[38] Fix | Delete

const GEOLITE2_DB = 'http://geolite.maxmind.com/download/geoip/database/GeoLite2-Country.tar.gz';

[39] Fix | Delete

[40] Fix | Delete

/**

[41] Fix | Delete

* API endpoints for looking up user IP address.

[42] Fix | Delete

*

[43] Fix | Delete

* @var array

[44] Fix | Delete

*/

[45] Fix | Delete

private static $ip_lookup_apis = array(

[46] Fix | Delete

'ipify' => 'http://api.ipify.org/',

[47] Fix | Delete

'ipecho' => 'http://ipecho.net/plain',

[48] Fix | Delete

'ident' => 'http://ident.me',

[49] Fix | Delete

'tnedi' => 'http://tnedi.me',

[50] Fix | Delete

);

[51] Fix | Delete

[52] Fix | Delete

/**

[53] Fix | Delete

* API endpoints for geolocating an IP address

[54] Fix | Delete

*

[55] Fix | Delete

* @var array

[56] Fix | Delete

*/

[57] Fix | Delete

private static $geoip_apis = array(

[58] Fix | Delete

'ipinfo.io' => 'https://ipinfo.io/%s/json',

[59] Fix | Delete

'ip-api.com' => 'http://ip-api.com/json/%s',

[60] Fix | Delete

);

[61] Fix | Delete

[62] Fix | Delete

/**

[63] Fix | Delete

* Check if geolocation is enabled.

[64] Fix | Delete

*

[65] Fix | Delete

* @since 3.4.0

[66] Fix | Delete

* @param string $current_settings Current geolocation settings.

[67] Fix | Delete

* @return bool

[68] Fix | Delete

*/

[69] Fix | Delete

private static function is_geolocation_enabled( $current_settings ) {

[70] Fix | Delete

return in_array( $current_settings, array( 'geolocation', 'geolocation_ajax' ), true );

[71] Fix | Delete

}

[72] Fix | Delete

[73] Fix | Delete

/**

[74] Fix | Delete

* Get current user IP Address.

[75] Fix | Delete

*

[76] Fix | Delete

* @return string

[77] Fix | Delete

*/

[78] Fix | Delete

public static function get_ip_address() {

[79] Fix | Delete

if ( isset( $_SERVER['HTTP_X_REAL_IP'] ) ) {

[80] Fix | Delete

return sanitize_text_field( wp_unslash( $_SERVER['HTTP_X_REAL_IP'] ) );

[81] Fix | Delete

} elseif ( isset( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {

[82] Fix | Delete

// Proxy servers can send through this header like this: X-Forwarded-For: client1, proxy1, proxy2

[83] Fix | Delete

// Make sure we always only send through the first IP in the list which should always be the client IP.

[84] Fix | Delete

$value = trim( current( preg_split( '/,/', sanitize_text_field( wp_unslash( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) ) ) );

[85] Fix | Delete

// Account for the '<IPv4 address>:<port>', '[<IPv6>]' and '[<IPv6>]:<port>' cases, removing the port.

[86] Fix | Delete

// The regular expression is oversimplified on purpose, later 'rest_is_ip_address' will do the actual IP address validation.

[87] Fix | Delete

$value = preg_replace( '/([0-9]+\.[0-9]+\.[0-9]+\.[0-9]+)\:.*|\[([^]]+)\].*/', '$1$2', $value );

[88] Fix | Delete

return (string) rest_is_ip_address( $value );

[89] Fix | Delete

} elseif ( isset( $_SERVER['REMOTE_ADDR'] ) ) {

[90] Fix | Delete

// Make sure we always only send through the first IP in the list which should always be the client IP.

[91] Fix | Delete

$value = trim( current( preg_split( '/,/', sanitize_text_field( wp_unslash( $_SERVER['REMOTE_ADDR'] ) ) ) ) );

[92] Fix | Delete

return (string) rest_is_ip_address( $value );

[93] Fix | Delete

}

[94] Fix | Delete

return '';

[95] Fix | Delete

}

[96] Fix | Delete

[97] Fix | Delete

/**

[98] Fix | Delete

* Get user IP Address using an external service.

[99] Fix | Delete

* This can be used as a fallback for users on localhost where

[100] Fix | Delete

* get_ip_address() will be a local IP and non-geolocatable.

[101] Fix | Delete

*

[102] Fix | Delete

* @return string

[103] Fix | Delete

*/

[104] Fix | Delete

public static function get_external_ip_address() {

[105] Fix | Delete

$external_ip_address = '0.0.0.0';

[106] Fix | Delete

[107] Fix | Delete

if ( '' !== self::get_ip_address() ) {

[108] Fix | Delete

$transient_name = 'external_ip_address_' . self::get_ip_address();

[109] Fix | Delete

$external_ip_address = get_transient( $transient_name );

[110] Fix | Delete

}

[111] Fix | Delete

[112] Fix | Delete

if ( false === $external_ip_address ) {

[113] Fix | Delete

$external_ip_address = '0.0.0.0';

[114] Fix | Delete

$ip_lookup_services = apply_filters( 'woocommerce_geolocation_ip_lookup_apis', self::$ip_lookup_apis );

[115] Fix | Delete

$ip_lookup_services_keys = array_keys( $ip_lookup_services );

[116] Fix | Delete

shuffle( $ip_lookup_services_keys );

[117] Fix | Delete

[118] Fix | Delete

foreach ( $ip_lookup_services_keys as $service_name ) {

[119] Fix | Delete

$service_endpoint = $ip_lookup_services[ $service_name ];

[120] Fix | Delete

$response = wp_safe_remote_get(

[121] Fix | Delete

$service_endpoint,

[122] Fix | Delete

array(

[123] Fix | Delete

'timeout' => 2,

[124] Fix | Delete

'user-agent' => 'WooCommerce/' . wc()->version,

[125] Fix | Delete

)

[126] Fix | Delete

);

[127] Fix | Delete

[128] Fix | Delete

if ( ! is_wp_error( $response ) && rest_is_ip_address( $response['body'] ) ) {

[129] Fix | Delete

$external_ip_address = apply_filters( 'woocommerce_geolocation_ip_lookup_api_response', wc_clean( $response['body'] ), $service_name );

[130] Fix | Delete

break;

[131] Fix | Delete

}

[132] Fix | Delete

}

[133] Fix | Delete

[134] Fix | Delete

set_transient( $transient_name, $external_ip_address, DAY_IN_SECONDS );

[135] Fix | Delete

}

[136] Fix | Delete

[137] Fix | Delete

return $external_ip_address;

[138] Fix | Delete

}

[139] Fix | Delete

[140] Fix | Delete

/**

[141] Fix | Delete

* Geolocate an IP address.

[142] Fix | Delete

*

[143] Fix | Delete

* @param string $ip_address IP Address.

[144] Fix | Delete

* @param bool $fallback If true, fallbacks to alternative IP detection (can be slower).

[145] Fix | Delete

* @param bool $api_fallback If true, uses geolocation APIs if the database file doesn't exist (can be slower).

[146] Fix | Delete

* @return array

[147] Fix | Delete

*/

[148] Fix | Delete

public static function geolocate_ip( $ip_address = '', $fallback = false, $api_fallback = true ) {

[149] Fix | Delete

/**

[150] Fix | Delete

* Filter to allow custom geolocation of the IP address.

[151] Fix | Delete

*

[152] Fix | Delete

* @since 3.9.0

[153] Fix | Delete

* @param string $geolocation Country code.

[154] Fix | Delete

* @param string $ip_address IP Address.

[155] Fix | Delete

* @param bool $fallback If true, fallbacks to alternative IP detection (can be slower).

[156] Fix | Delete

* @param bool $api_fallback If true, uses geolocation APIs if the database file doesn't exist (can be slower).

[157] Fix | Delete

* @return string

[158] Fix | Delete

*/

[159] Fix | Delete

$country_code = apply_filters( 'woocommerce_geolocate_ip', false, $ip_address, $fallback, $api_fallback );

[160] Fix | Delete

[161] Fix | Delete

if ( false !== $country_code ) {

[162] Fix | Delete

return array(

[163] Fix | Delete

'country' => $country_code,

[164] Fix | Delete

'state' => '',

[165] Fix | Delete

'city' => '',

[166] Fix | Delete

'postcode' => '',

[167] Fix | Delete

);

[168] Fix | Delete

}

[169] Fix | Delete

[170] Fix | Delete

if ( empty( $ip_address ) ) {

[171] Fix | Delete

$ip_address = self::get_ip_address();

[172] Fix | Delete

$country_code = self::get_country_code_from_headers();

[173] Fix | Delete

}

[174] Fix | Delete

[175] Fix | Delete

/**

[176] Fix | Delete

* Get geolocation filter.

[177] Fix | Delete

*

[178] Fix | Delete

* @since 3.9.0

[179] Fix | Delete

* @param array $geolocation Geolocation data, including country, state, city, and postcode.

[180] Fix | Delete

* @param string $ip_address IP Address.

[181] Fix | Delete

*/

[182] Fix | Delete

$geolocation = apply_filters(

[183] Fix | Delete

'woocommerce_get_geolocation',

[184] Fix | Delete

array(

[185] Fix | Delete

'country' => $country_code ? $country_code : '',

[186] Fix | Delete

'state' => '',

[187] Fix | Delete

'city' => '',

[188] Fix | Delete

'postcode' => '',

[189] Fix | Delete

),

[190] Fix | Delete

$ip_address

[191] Fix | Delete

);

[192] Fix | Delete

[193] Fix | Delete

// If we still haven't found a country code, let's consider doing an API lookup.

[194] Fix | Delete

if ( '' === $geolocation['country'] && $api_fallback ) {

[195] Fix | Delete

$geolocation['country'] = self::geolocate_via_api( $ip_address );

[196] Fix | Delete

}

[197] Fix | Delete

[198] Fix | Delete

// It's possible that we're in a local environment, in which case the geolocation needs to be done from the

[199] Fix | Delete

// external address.

[200] Fix | Delete

if ( '' === $geolocation['country'] && $fallback ) {

[201] Fix | Delete

$external_ip_address = self::get_external_ip_address();

[202] Fix | Delete

[203] Fix | Delete

// Only bother with this if the external IP differs.

[204] Fix | Delete

if ( '0.0.0.0' !== $external_ip_address && $external_ip_address !== $ip_address ) {

[205] Fix | Delete

return self::geolocate_ip( $external_ip_address, false, $api_fallback );

[206] Fix | Delete

}

[207] Fix | Delete

}

[208] Fix | Delete

[209] Fix | Delete

return array(

[210] Fix | Delete

'country' => $geolocation['country'],

[211] Fix | Delete

'state' => $geolocation['state'],

[212] Fix | Delete

'city' => $geolocation['city'],

[213] Fix | Delete

'postcode' => $geolocation['postcode'],

[214] Fix | Delete

);

[215] Fix | Delete

}

[216] Fix | Delete

[217] Fix | Delete

/**

[218] Fix | Delete

* Path to our local db.

[219] Fix | Delete

*

[220] Fix | Delete

* @deprecated 3.9.0

[221] Fix | Delete

* @param string $deprecated Deprecated since 3.4.0.

[222] Fix | Delete

* @return string

[223] Fix | Delete

*/

[224] Fix | Delete

public static function get_local_database_path( $deprecated = '2' ) {

[225] Fix | Delete

wc_deprecated_function( 'WC_Geolocation::get_local_database_path', '3.9.0' );

[226] Fix | Delete

$integration = wc()->integrations->get_integration( 'maxmind_geolocation' );

[227] Fix | Delete

return $integration->get_database_service()->get_database_path();

[228] Fix | Delete

}

[229] Fix | Delete

[230] Fix | Delete

/**

[231] Fix | Delete

* Update geoip database.

[232] Fix | Delete

*

[233] Fix | Delete

* @deprecated 3.9.0

[234] Fix | Delete

* Extract files with PharData. Tool built into PHP since 5.3.

[235] Fix | Delete

*/

[236] Fix | Delete

public static function update_database() {

[237] Fix | Delete

wc_deprecated_function( 'WC_Geolocation::update_database', '3.9.0' );

[238] Fix | Delete

$integration = wc()->integrations->get_integration( 'maxmind_geolocation' );

[239] Fix | Delete

$integration->update_database();

[240] Fix | Delete

}

[241] Fix | Delete

[242] Fix | Delete

/**

[243] Fix | Delete

* Fetches the country code from the request headers, if one is available.

[244] Fix | Delete

*

[245] Fix | Delete

* @since 3.9.0

[246] Fix | Delete

* @return string The country code pulled from the headers, or empty string if one was not found.

[247] Fix | Delete

*/

[248] Fix | Delete

private static function get_country_code_from_headers() {

[249] Fix | Delete

$country_code = '';

[250] Fix | Delete

[251] Fix | Delete

$headers = array(

[252] Fix | Delete

'MM_COUNTRY_CODE',

[253] Fix | Delete

'GEOIP_COUNTRY_CODE',

[254] Fix | Delete

'HTTP_CF_IPCOUNTRY',

[255] Fix | Delete

'HTTP_X_COUNTRY_CODE',

[256] Fix | Delete

);

[257] Fix | Delete

[258] Fix | Delete

foreach ( $headers as $header ) {

[259] Fix | Delete

if ( empty( $_SERVER[ $header ] ) ) {

[260] Fix | Delete

continue;

[261] Fix | Delete

}

[262] Fix | Delete

[263] Fix | Delete

$country_code = strtoupper( sanitize_text_field( wp_unslash( $_SERVER[ $header ] ) ) );

[264] Fix | Delete

break;

[265] Fix | Delete

}

[266] Fix | Delete

[267] Fix | Delete

return $country_code;

[268] Fix | Delete

}

[269] Fix | Delete

[270] Fix | Delete

/**

[271] Fix | Delete

* Use APIs to Geolocate the user.

[272] Fix | Delete

*

[273] Fix | Delete

* Geolocation APIs can be added through the use of the woocommerce_geolocation_geoip_apis filter.

[274] Fix | Delete

* Provide a name=>value pair for service-slug=>endpoint.

[275] Fix | Delete

*

[276] Fix | Delete

* If APIs are defined, one will be chosen at random to fulfil the request. After completing, the result

[277] Fix | Delete

* will be cached in a transient.

[278] Fix | Delete

*

[279] Fix | Delete

* @param string $ip_address IP address.

[280] Fix | Delete

* @return string

[281] Fix | Delete

*/

[282] Fix | Delete

private static function geolocate_via_api( $ip_address ) {

[283] Fix | Delete

$country_code = get_transient( 'geoip_' . $ip_address );

[284] Fix | Delete

[285] Fix | Delete

if ( false === $country_code ) {

[286] Fix | Delete

$geoip_services = apply_filters( 'woocommerce_geolocation_geoip_apis', self::$geoip_apis );

[287] Fix | Delete

[288] Fix | Delete

if ( empty( $geoip_services ) ) {

[289] Fix | Delete

return '';

[290] Fix | Delete

}

[291] Fix | Delete

[292] Fix | Delete

$geoip_services_keys = array_keys( $geoip_services );

[293] Fix | Delete

[294] Fix | Delete

shuffle( $geoip_services_keys );

[295] Fix | Delete

[296] Fix | Delete

foreach ( $geoip_services_keys as $service_name ) {

[297] Fix | Delete

$service_endpoint = $geoip_services[ $service_name ];

[298] Fix | Delete

$response = wp_safe_remote_get(

[299] Fix | Delete

sprintf( $service_endpoint, $ip_address ),

[300] Fix | Delete

array(

[301] Fix | Delete

'timeout' => 2,

[302] Fix | Delete

'user-agent' => 'WooCommerce/' . wc()->version,

[303] Fix | Delete

)

[304] Fix | Delete

);

[305] Fix | Delete

[306] Fix | Delete

if ( ! is_wp_error( $response ) && $response['body'] ) {

[307] Fix | Delete

switch ( $service_name ) {

[308] Fix | Delete

case 'ipinfo.io':

[309] Fix | Delete

$data = json_decode( $response['body'] );

[310] Fix | Delete

$country_code = isset( $data->country ) ? $data->country : '';

[311] Fix | Delete

break;

[312] Fix | Delete

case 'ip-api.com':

[313] Fix | Delete

$data = json_decode( $response['body'] );

[314] Fix | Delete

$country_code = isset( $data->countryCode ) ? $data->countryCode : ''; // @codingStandardsIgnoreLine

[315] Fix | Delete

break;

[316] Fix | Delete

default:

[317] Fix | Delete

$country_code = apply_filters( 'woocommerce_geolocation_geoip_response_' . $service_name, '', $response['body'] );

[318] Fix | Delete

break;

[319] Fix | Delete

}

[320] Fix | Delete

[321] Fix | Delete

$country_code = sanitize_text_field( strtoupper( $country_code ) );

[322] Fix | Delete

[323] Fix | Delete

if ( $country_code ) {

[324] Fix | Delete

break;

[325] Fix | Delete

}

[326] Fix | Delete

}

[327] Fix | Delete

}

[328] Fix | Delete

[329] Fix | Delete

set_transient( 'geoip_' . $ip_address, $country_code, DAY_IN_SECONDS );

[330] Fix | Delete

}

[331] Fix | Delete

[332] Fix | Delete

return $country_code;

[333] Fix | Delete

}

[334] Fix | Delete

[335] Fix | Delete

/**

[336] Fix | Delete

* Hook in geolocation functionality.

[337] Fix | Delete

*

[338] Fix | Delete

* @deprecated 3.9.0

[339] Fix | Delete

* @return null

[340] Fix | Delete

*/

[341] Fix | Delete

public static function init() {

[342] Fix | Delete

wc_deprecated_function( 'WC_Geolocation::init', '3.9.0' );

[343] Fix | Delete

return null;

[344] Fix | Delete

}

[345] Fix | Delete

[346] Fix | Delete

/**

[347] Fix | Delete

* Prevent geolocation via MaxMind when using legacy versions of php.

[348] Fix | Delete

*

[349] Fix | Delete

* @deprecated 3.9.0

[350] Fix | Delete

* @since 3.4.0

[351] Fix | Delete

* @param string $default_customer_address current value.

[352] Fix | Delete

* @return string

[353] Fix | Delete

*/

[354] Fix | Delete

public static function disable_geolocation_on_legacy_php( $default_customer_address ) {

[355] Fix | Delete

wc_deprecated_function( 'WC_Geolocation::disable_geolocation_on_legacy_php', '3.9.0' );

[356] Fix | Delete

[357] Fix | Delete

if ( self::is_geolocation_enabled( $default_customer_address ) ) {

[358] Fix | Delete

$default_customer_address = 'base';

[359] Fix | Delete

}

[360] Fix | Delete

[361] Fix | Delete

return $default_customer_address;

[362] Fix | Delete

}

[363] Fix | Delete

[364] Fix | Delete

/**

[365] Fix | Delete

* Maybe trigger a DB update for the first time.

[366] Fix | Delete

*

[367] Fix | Delete

* @deprecated 3.9.0

[368] Fix | Delete

* @param string $new_value New value.

[369] Fix | Delete

* @param string $old_value Old value.

[370] Fix | Delete

* @return string

[371] Fix | Delete

*/

[372] Fix | Delete

public static function maybe_update_database( $new_value, $old_value ) {

[373] Fix | Delete

wc_deprecated_function( 'WC_Geolocation::maybe_update_database', '3.9.0' );

[374] Fix | Delete

if ( $new_value !== $old_value && self::is_geolocation_enabled( $new_value ) ) {

[375] Fix | Delete

self::update_database();

[376] Fix | Delete

}

[377] Fix | Delete

[378] Fix | Delete

return $new_value;

[379] Fix | Delete

}

[380] Fix | Delete

}

[381] Fix | Delete

[382] Fix | Delete