class-wc-geolocation.php — WooCommerce 5.0.1

woocommerce / includes / class-wc-geolocation.php

woocommerce / includes Last commit date

class-wc-geolocation.php

357 lines

1	<?php
2	/**
3	* Geolocation class
4	*
5	* Handles geolocation and updating the geolocation database.
6	*
7	* This product includes GeoLite data created by MaxMind, available from http://www.maxmind.com.
8	*
9	* @package WooCommerce\Classes
10	* @version 3.9.0
11	*/
12
13	defined( 'ABSPATH' ) \|\| exit;
14
15	/**
16	* WC_Geolocation Class.
17	*/
18	class WC_Geolocation {
19
20	/**
21	* GeoLite IPv4 DB.
22	*
23	* @deprecated 3.4.0
24	*/
25	const GEOLITE_DB = 'http://geolite.maxmind.com/download/geoip/database/GeoLiteCountry/GeoIP.dat.gz';
26
27	/**
28	* GeoLite IPv6 DB.
29	*
30	* @deprecated 3.4.0
31	*/
32	const GEOLITE_IPV6_DB = 'http://geolite.maxmind.com/download/geoip/database/GeoIPv6.dat.gz';
33
34	/**
35	* GeoLite2 DB.
36	*
37	* @since 3.4.0
38	* @deprecated 3.9.0
39	*/
40	const GEOLITE2_DB = 'http://geolite.maxmind.com/download/geoip/database/GeoLite2-Country.tar.gz';
41
42	/**
43	* API endpoints for looking up user IP address.
44	*
45	* @var array
46	*/
47	private static $ip_lookup_apis = array(
48	'ipify' => 'http://api.ipify.org/',
49	'ipecho' => 'http://ipecho.net/plain',
50	'ident' => 'http://ident.me',
51	'whatismyipaddress' => 'http://bot.whatismyipaddress.com',
52	);
53
54	/**
55	* API endpoints for geolocating an IP address
56	*
57	* @var array
58	*/
59	private static $geoip_apis = array(
60	'ipinfo.io' => 'https://ipinfo.io/%s/json',
61	'ip-api.com' => 'http://ip-api.com/json/%s',
62	);
63
64	/**
65	* Check if geolocation is enabled.
66	*
67	* @since 3.4.0
68	* @param string $current_settings Current geolocation settings.
69	* @return bool
70	*/
71	private static function is_geolocation_enabled( $current_settings ) {
72	return in_array( $current_settings, array( 'geolocation', 'geolocation_ajax' ), true );
73	}
74
75	/**
76	* Get current user IP Address.
77	*
78	* @return string
79	*/
80	public static function get_ip_address() {
81	if ( isset( $_SERVER['HTTP_X_REAL_IP'] ) ) {
82	return sanitize_text_field( wp_unslash( $_SERVER['HTTP_X_REAL_IP'] ) );
83	} elseif ( isset( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
84	// Proxy servers can send through this header like this: X-Forwarded-For: client1, proxy1, proxy2
85	// Make sure we always only send through the first IP in the list which should always be the client IP.
86	return (string) rest_is_ip_address( trim( current( preg_split( '/,/', sanitize_text_field( wp_unslash( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) ) ) ) );
87	} elseif ( isset( $_SERVER['REMOTE_ADDR'] ) ) {
88	return sanitize_text_field( wp_unslash( $_SERVER['REMOTE_ADDR'] ) );
89	}
90	return '';
91	}
92
93	/**
94	* Get user IP Address using an external service.
95	* This can be used as a fallback for users on localhost where
96	* get_ip_address() will be a local IP and non-geolocatable.
97	*
98	* @return string
99	*/
100	public static function get_external_ip_address() {
101	$external_ip_address = '0.0.0.0';
102
103	if ( '' !== self::get_ip_address() ) {
104	$transient_name = 'external_ip_address_' . self::get_ip_address();
105	$external_ip_address = get_transient( $transient_name );
106	}
107
108	if ( false === $external_ip_address ) {
109	$external_ip_address = '0.0.0.0';
110	$ip_lookup_services = apply_filters( 'woocommerce_geolocation_ip_lookup_apis', self::$ip_lookup_apis );
111	$ip_lookup_services_keys = array_keys( $ip_lookup_services );
112	shuffle( $ip_lookup_services_keys );
113
114	foreach ( $ip_lookup_services_keys as $service_name ) {
115	$service_endpoint = $ip_lookup_services[ $service_name ];
116	$response = wp_safe_remote_get( $service_endpoint, array( 'timeout' => 2 ) );
117
118	if ( ! is_wp_error( $response ) && rest_is_ip_address( $response['body'] ) ) {
119	$external_ip_address = apply_filters( 'woocommerce_geolocation_ip_lookup_api_response', wc_clean( $response['body'] ), $service_name );
120	break;
121	}
122	}
123
124	set_transient( $transient_name, $external_ip_address, WEEK_IN_SECONDS );
125	}
126
127	return $external_ip_address;
128	}
129
130	/**
131	* Geolocate an IP address.
132	*
133	* @param string $ip_address IP Address.
134	* @param bool $fallback If true, fallbacks to alternative IP detection (can be slower).
135	* @param bool $api_fallback If true, uses geolocation APIs if the database file doesn't exist (can be slower).
136	* @return array
137	*/
138	public static function geolocate_ip( $ip_address = '', $fallback = false, $api_fallback = true ) {
139	// Filter to allow custom geolocation of the IP address.
140	$country_code = apply_filters( 'woocommerce_geolocate_ip', false, $ip_address, $fallback, $api_fallback );
141
142	if ( false !== $country_code ) {
143	return array(
144	'country' => $country_code,
145	'state' => '',
146	'city' => '',
147	'postcode' => '',
148	);
149	}
150
151	if ( empty( $ip_address ) ) {
152	$ip_address = self::get_ip_address();
153	}
154
155	$country_code = self::get_country_code_from_headers();
156
157	/**
158	* Get geolocation filter.
159	*
160	* @since 3.9.0
161	* @param array $geolocation Geolocation data, including country, state, city, and postcode.
162	* @param string $ip_address IP Address.
163	*/
164	$geolocation = apply_filters(
165	'woocommerce_get_geolocation',
166	array(
167	'country' => $country_code,
168	'state' => '',
169	'city' => '',
170	'postcode' => '',
171	),
172	$ip_address
173	);
174
175	// If we still haven't found a country code, let's consider doing an API lookup.
176	if ( '' === $geolocation['country'] && $api_fallback ) {
177	$geolocation['country'] = self::geolocate_via_api( $ip_address );
178	}
179
180	// It's possible that we're in a local environment, in which case the geolocation needs to be done from the
181	// external address.
182	if ( '' === $geolocation['country'] && $fallback ) {
183	$external_ip_address = self::get_external_ip_address();
184
185	// Only bother with this if the external IP differs.
186	if ( '0.0.0.0' !== $external_ip_address && $external_ip_address !== $ip_address ) {
187	return self::geolocate_ip( $external_ip_address, false, $api_fallback );
188	}
189	}
190
191	return array(
192	'country' => $geolocation['country'],
193	'state' => $geolocation['state'],
194	'city' => $geolocation['city'],
195	'postcode' => $geolocation['postcode'],
196	);
197	}
198
199	/**
200	* Path to our local db.
201	*
202	* @deprecated 3.9.0
203	* @param string $deprecated Deprecated since 3.4.0.
204	* @return string
205	*/
206	public static function get_local_database_path( $deprecated = '2' ) {
207	wc_deprecated_function( 'WC_Geolocation::get_local_database_path', '3.9.0' );
208	$integration = wc()->integrations->get_integration( 'maxmind_geolocation' );
209	return $integration->get_database_service()->get_database_path();
210	}
211
212	/**
213	* Update geoip database.
214	*
215	* @deprecated 3.9.0
216	* Extract files with PharData. Tool built into PHP since 5.3.
217	*/
218	public static function update_database() {
219	wc_deprecated_function( 'WC_Geolocation::update_database', '3.9.0' );
220	$integration = wc()->integrations->get_integration( 'maxmind_geolocation' );
221	$integration->update_database();
222	}
223
224	/**
225	* Fetches the country code from the request headers, if one is available.
226	*
227	* @since 3.9.0
228	* @return string The country code pulled from the headers, or empty string if one was not found.
229	*/
230	private static function get_country_code_from_headers() {
231	$country_code = '';
232
233	$headers = array(
234	'MM_COUNTRY_CODE',
235	'GEOIP_COUNTRY_CODE',
236	'HTTP_CF_IPCOUNTRY',
237	'HTTP_X_COUNTRY_CODE',
238	);
239
240	foreach ( $headers as $header ) {
241	if ( empty( $_SERVER[ $header ] ) ) {
242	continue;
243	}
244
245	$country_code = strtoupper( sanitize_text_field( wp_unslash( $_SERVER[ $header ] ) ) );
246	break;
247	}
248
249	return $country_code;
250	}
251
252	/**
253	* Use APIs to Geolocate the user.
254	*
255	* Geolocation APIs can be added through the use of the woocommerce_geolocation_geoip_apis filter.
256	* Provide a name=>value pair for service-slug=>endpoint.
257	*
258	* If APIs are defined, one will be chosen at random to fulfil the request. After completing, the result
259	* will be cached in a transient.
260	*
261	* @param string $ip_address IP address.
262	* @return string
263	*/
264	private static function geolocate_via_api( $ip_address ) {
265	$country_code = get_transient( 'geoip_' . $ip_address );
266
267	if ( false === $country_code ) {
268	$geoip_services = apply_filters( 'woocommerce_geolocation_geoip_apis', self::$geoip_apis );
269
270	if ( empty( $geoip_services ) ) {
271	return '';
272	}
273
274	$geoip_services_keys = array_keys( $geoip_services );
275
276	shuffle( $geoip_services_keys );
277
278	foreach ( $geoip_services_keys as $service_name ) {
279	$service_endpoint = $geoip_services[ $service_name ];
280	$response = wp_safe_remote_get( sprintf( $service_endpoint, $ip_address ), array( 'timeout' => 2 ) );
281
282	if ( ! is_wp_error( $response ) && $response['body'] ) {
283	switch ( $service_name ) {
284	case 'ipinfo.io':
285	$data = json_decode( $response['body'] );
286	$country_code = isset( $data->country ) ? $data->country : '';
287	break;
288	case 'ip-api.com':
289	$data = json_decode( $response['body'] );
290	$country_code = isset( $data->countryCode ) ? $data->countryCode : ''; // @codingStandardsIgnoreLine
291	break;
292	default:
293	$country_code = apply_filters( 'woocommerce_geolocation_geoip_response_' . $service_name, '', $response['body'] );
294	break;
295	}
296
297	$country_code = sanitize_text_field( strtoupper( $country_code ) );
298
299	if ( $country_code ) {
300	break;
301	}
302	}
303	}
304
305	set_transient( 'geoip_' . $ip_address, $country_code, WEEK_IN_SECONDS );
306	}
307
308	return $country_code;
309	}
310
311	/**
312	* Hook in geolocation functionality.
313	*
314	* @deprecated 3.9.0
315	* @return null
316	*/
317	public static function init() {
318	wc_deprecated_function( 'WC_Geolocation::init', '3.9.0' );
319	return null;
320	}
321
322	/**
323	* Prevent geolocation via MaxMind when using legacy versions of php.
324	*
325	* @deprecated 3.9.0
326	* @since 3.4.0
327	* @param string $default_customer_address current value.
328	* @return string
329	*/
330	public static function disable_geolocation_on_legacy_php( $default_customer_address ) {
331	wc_deprecated_function( 'WC_Geolocation::disable_geolocation_on_legacy_php', '3.9.0' );
332
333	if ( self::is_geolocation_enabled( $default_customer_address ) ) {
334	$default_customer_address = 'base';
335	}
336
337	return $default_customer_address;
338	}
339
340	/**
341	* Maybe trigger a DB update for the first time.
342	*
343	* @deprecated 3.9.0
344	* @param string $new_value New value.
345	* @param string $old_value Old value.
346	* @return string
347	*/
348	public static function maybe_update_database( $new_value, $old_value ) {
349	wc_deprecated_function( 'WC_Geolocation::maybe_update_database', '3.9.0' );
350	if ( $new_value !== $old_value && self::is_geolocation_enabled( $new_value ) ) {
351	self::update_database();
352	}
353
354	return $new_value;
355	}
356	}
357