455 lines
11 KiB
PHP
455 lines
11 KiB
PHP
<?php
|
|
|
|
// Exit if accessed directly
|
|
if ( ! defined( 'ABSPATH' ) ) {
|
|
exit;
|
|
}
|
|
|
|
/**
|
|
* Geolocation class
|
|
*
|
|
* Handles geolocation and updating the geolocation database.
|
|
*
|
|
* @version 4.5.0
|
|
*/
|
|
|
|
/**
|
|
* ES_Geolocation Class.
|
|
*/
|
|
class ES_Geolocation {
|
|
|
|
|
|
/**
|
|
* 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',
|
|
);
|
|
|
|
/**
|
|
* Icegram API endpoints for geolocating an IP address
|
|
*
|
|
* @var string
|
|
*
|
|
* @since 4.7.3
|
|
*/
|
|
private static $icegram_api_url = 'http://api.icegram.com/geo/';
|
|
|
|
/**
|
|
* Geolocate an IP address.
|
|
*
|
|
* @param string $ip_address IP Address.
|
|
*
|
|
* @return array
|
|
*/
|
|
public static function geolocate_ip( $ip_address = '' ) {
|
|
|
|
/**
|
|
* Get geolocation filter.
|
|
*
|
|
* @param string $ip_address IP Address.
|
|
*
|
|
* @since 4.5.0
|
|
*/
|
|
$geolocation = apply_filters(
|
|
'ig_es_get_geolocation',
|
|
array(),
|
|
$ip_address
|
|
);
|
|
|
|
if ( ! empty( $geolocation ) ) {
|
|
return $geolocation;
|
|
}
|
|
|
|
if ( ! is_array( $geolocation ) ) {
|
|
$geolocation = array();
|
|
}
|
|
|
|
$geolocation = self::geolocate_via_api( $ip_address );
|
|
|
|
return $geolocation;
|
|
}
|
|
|
|
/**
|
|
* Convert the String TimeZone to seconds
|
|
*
|
|
* @param $timezone
|
|
*
|
|
* @return string
|
|
*/
|
|
public static function convert_timezone_to_seconds( $timezone ) {
|
|
if ( empty( $timezone ) ) {
|
|
return '+0:00';
|
|
}
|
|
try {
|
|
$current = timezone_open( $timezone );
|
|
$utcTime = new DateTime( 'now', new DateTimeZone( 'UTC' ) );
|
|
$offset_in_secs = $current->getOffset( $utcTime );
|
|
$hours_and_sec = gmdate( 'H:i', abs( $offset_in_secs ) );
|
|
|
|
return stripos( $offset_in_secs, '-' ) === false ? "+{$hours_and_sec}" : "-{$hours_and_sec}";
|
|
} catch ( Exception $exception ) {
|
|
return '+0:00';
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Use APIs to Geolocate the user.
|
|
*
|
|
* Geolocation APIs can be added through the use of the ig_es_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 array
|
|
*/
|
|
private static function geolocate_via_api( $ip_address ) {
|
|
$geo_ip_data = get_transient( 'ig_es_geoip_' . $ip_address );
|
|
|
|
if ( empty( $geo_ip_data ) ) {
|
|
$geo_ip_data = array();
|
|
$geoip_services = apply_filters( 'ig_es_geolocation_geoip_apis', self::$geoip_apis );
|
|
|
|
if ( empty( $geoip_services ) ) {
|
|
return $geo_ip_data;
|
|
}
|
|
|
|
$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 : '';
|
|
$timezone = isset( $data->timezone ) ? self::convert_timezone_to_seconds( $data->timezone ) : '+0:00';
|
|
break;
|
|
case 'ip-api.com':
|
|
$data = json_decode( $response['body'] );
|
|
$country_code = isset( $data->countryCode ) ? $data->countryCode : ''; // @codingStandardsIgnoreLine
|
|
$timezone = isset( $data->timezone ) ? self::convert_timezone_to_seconds( $data->timezone ) : '+0:00';
|
|
break;
|
|
default:
|
|
$country_code = apply_filters( 'ig_es_geolocation_geoip_response_' . $service_name, '', $response['body'] );
|
|
$timezone = apply_filters( 'ig_es_geolocation_geoip_timezone_response_' . $service_name, '', $response['body'] );
|
|
break;
|
|
}
|
|
|
|
$country_code = sanitize_text_field( strtoupper( $country_code ) );
|
|
|
|
if ( $country_code ) {
|
|
$geo_ip_data['country_code'] = $country_code;
|
|
$geo_ip_data['timezone'] = $timezone;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
// Use Icegram geo location API incase if we still don't have the location data.
|
|
if ( empty( $geo_ip_data ) ) {
|
|
$response = wp_safe_remote_get(
|
|
self::$icegram_api_url . $ip_address,
|
|
array(
|
|
'timeout' => 2,
|
|
)
|
|
);
|
|
if ( ! is_wp_error( $response ) && $response['body'] ) {
|
|
$data = json_decode( $response['body'] );
|
|
$country_code = isset( $data->country_code ) ? $data->country_code : '';
|
|
$timezone = isset( $data->timezone ) ? self::convert_timezone_to_seconds( $data->timezone ) : '+0:00';
|
|
if ( $country_code ) {
|
|
$geo_ip_data['country_code'] = $country_code;
|
|
$geo_ip_data['timezone'] = $timezone;
|
|
}
|
|
}
|
|
}
|
|
|
|
if ( ! empty( $geo_ip_data ) ) {
|
|
set_transient( 'ig_es_geoip_' . $ip_address, $geo_ip_data, WEEK_IN_SECONDS );
|
|
}
|
|
}
|
|
|
|
return $geo_ip_data;
|
|
}
|
|
|
|
/**
|
|
* Method to get country name based on ISO code.
|
|
*
|
|
* @since 4.5.0
|
|
*/
|
|
public static function get_country_name_from_country_code( $country_code = '' ) {
|
|
|
|
$countries_data = self::get_countries();
|
|
|
|
if ( isset( $countries_data[ $country_code ] ) ) {
|
|
return $countries_data[ $country_code ];
|
|
} else {
|
|
return '';
|
|
}
|
|
}
|
|
|
|
public static function get_countries() {
|
|
|
|
$countries_data = array(
|
|
'AF' => 'Afghanistan',
|
|
'AX' => 'Aland Islands',
|
|
'AL' => 'Albania',
|
|
'DZ' => 'Algeria',
|
|
'AS' => 'American Samoa',
|
|
'AD' => 'Andorra',
|
|
'AO' => 'Angola',
|
|
'AI' => 'Anguilla',
|
|
'AQ' => 'Antarctica',
|
|
'AG' => 'Antigua And Barbuda',
|
|
'AR' => 'Argentina',
|
|
'AM' => 'Armenia',
|
|
'AW' => 'Aruba',
|
|
'AU' => 'Australia',
|
|
'AT' => 'Austria',
|
|
'AZ' => 'Azerbaijan',
|
|
'BS' => 'Bahamas',
|
|
'BH' => 'Bahrain',
|
|
'BD' => 'Bangladesh',
|
|
'BB' => 'Barbados',
|
|
'BY' => 'Belarus',
|
|
'BE' => 'Belgium',
|
|
'BZ' => 'Belize',
|
|
'BJ' => 'Benin',
|
|
'BM' => 'Bermuda',
|
|
'BT' => 'Bhutan',
|
|
'BO' => 'Bolivia',
|
|
'BA' => 'Bosnia And Herzegovina',
|
|
'BW' => 'Botswana',
|
|
'BV' => 'Bouvet Island',
|
|
'BR' => 'Brazil',
|
|
'IO' => 'British Indian Ocean Territory',
|
|
'BN' => 'Brunei Darussalam',
|
|
'BG' => 'Bulgaria',
|
|
'BF' => 'Burkina Faso',
|
|
'BI' => 'Burundi',
|
|
'KH' => 'Cambodia',
|
|
'CM' => 'Cameroon',
|
|
'CA' => 'Canada',
|
|
'CV' => 'Cape Verde',
|
|
'KY' => 'Cayman Islands',
|
|
'CF' => 'Central African Republic',
|
|
'TD' => 'Chad',
|
|
'CL' => 'Chile',
|
|
'CN' => 'China',
|
|
'CX' => 'Christmas Island',
|
|
'CC' => 'Cocos Island',
|
|
'CO' => 'Colombia',
|
|
'KM' => 'Comoros',
|
|
'CG' => 'Congo',
|
|
'CD' => 'Congo, Democratic Republic',
|
|
'CK' => 'Cook Islands',
|
|
'CR' => 'Costa Rica',
|
|
'CI' => 'Cote D\'Ivoire',
|
|
'HR' => 'Croatia',
|
|
'CU' => 'Cuba',
|
|
'CY' => 'Cyprus',
|
|
'CZ' => 'Czech Republic',
|
|
'DK' => 'Denmark',
|
|
'DJ' => 'Djibouti',
|
|
'DM' => 'Dominica',
|
|
'DO' => 'Dominican Republic',
|
|
'EC' => 'Ecuador',
|
|
'EG' => 'Egypt',
|
|
'SV' => 'El Salvador',
|
|
'GQ' => 'Equatorial Guinea',
|
|
'ER' => 'Eritrea',
|
|
'EE' => 'Estonia',
|
|
'ET' => 'Ethiopia',
|
|
'FK' => 'Falkland Islands',
|
|
'FO' => 'Faroe Islands',
|
|
'FJ' => 'Fiji',
|
|
'FI' => 'Finland',
|
|
'FR' => 'France',
|
|
'GF' => 'French Guiana',
|
|
'PF' => 'French Polynesia',
|
|
'TF' => 'French Southern Territories',
|
|
'GA' => 'Gabon',
|
|
'GM' => 'Gambia',
|
|
'GE' => 'Georgia',
|
|
'DE' => 'Germany',
|
|
'GH' => 'Ghana',
|
|
'GI' => 'Gibraltar',
|
|
'GR' => 'Greece',
|
|
'GL' => 'Greenland',
|
|
'GD' => 'Grenada',
|
|
'GP' => 'Guadeloupe',
|
|
'GU' => 'Guam',
|
|
'GT' => 'Guatemala',
|
|
'GG' => 'Guernsey',
|
|
'GN' => 'Guinea',
|
|
'GW' => 'Guinea-Bissau',
|
|
'GY' => 'Guyana',
|
|
'HT' => 'Haiti',
|
|
'HM' => 'Heard Island & Mcdonald Islands',
|
|
'VA' => 'Holy See (Vatican City State)',
|
|
'HN' => 'Honduras',
|
|
'HK' => 'Hong Kong',
|
|
'HU' => 'Hungary',
|
|
'IS' => 'Iceland',
|
|
'IN' => 'India',
|
|
'ID' => 'Indonesia',
|
|
'IR' => 'Iran, Islamic Republic Of',
|
|
'IQ' => 'Iraq',
|
|
'IE' => 'Ireland',
|
|
'IM' => 'Isle Of Man',
|
|
'IL' => 'Israel',
|
|
'IT' => 'Italy',
|
|
'JM' => 'Jamaica',
|
|
'JP' => 'Japan',
|
|
'JE' => 'Jersey',
|
|
'JO' => 'Jordan',
|
|
'KZ' => 'Kazakhstan',
|
|
'KE' => 'Kenya',
|
|
'KI' => 'Kiribati',
|
|
'KR' => 'Korea',
|
|
'KW' => 'Kuwait',
|
|
'KG' => 'Kyrgyzstan',
|
|
'LA' => 'Lao People\'s Democratic Republic',
|
|
'LV' => 'Latvia',
|
|
'LB' => 'Lebanon',
|
|
'LS' => 'Lesotho',
|
|
'LR' => 'Liberia',
|
|
'LY' => 'Libyan Arab Jamahiriya',
|
|
'LI' => 'Liechtenstein',
|
|
'LT' => 'Lithuania',
|
|
'LU' => 'Luxembourg',
|
|
'MO' => 'Macao',
|
|
'MK' => 'Macedonia',
|
|
'MG' => 'Madagascar',
|
|
'MW' => 'Malawi',
|
|
'MY' => 'Malaysia',
|
|
'MV' => 'Maldives',
|
|
'ML' => 'Mali',
|
|
'MT' => 'Malta',
|
|
'MH' => 'Marshall Islands',
|
|
'MQ' => 'Martinique',
|
|
'MR' => 'Mauritania',
|
|
'MU' => 'Mauritius',
|
|
'YT' => 'Mayotte',
|
|
'MX' => 'Mexico',
|
|
'FM' => 'Micronesia',
|
|
'MD' => 'Moldova',
|
|
'MC' => 'Monaco',
|
|
'MN' => 'Mongolia',
|
|
'ME' => 'Montenegro',
|
|
'MS' => 'Montserrat',
|
|
'MA' => 'Morocco',
|
|
'MZ' => 'Mozambique',
|
|
'MM' => 'Myanmar',
|
|
'NA' => 'Namibia',
|
|
'NR' => 'Nauru',
|
|
'NP' => 'Nepal',
|
|
'NL' => 'Netherlands',
|
|
'AN' => 'Netherlands',
|
|
'NC' => 'New Caledonia',
|
|
'NZ' => 'New Zealand',
|
|
'NI' => 'Nicaragua',
|
|
'NE' => 'Niger',
|
|
'NG' => 'Nigeria',
|
|
'NU' => 'Niue',
|
|
'NF' => 'Norfolk Island',
|
|
'MP' => 'Northern Mariana Islands',
|
|
'NO' => 'Norway',
|
|
'OM' => 'Oman',
|
|
'PK' => 'Pakistan',
|
|
'PW' => 'Palau',
|
|
'PS' => 'Palestine',
|
|
'PA' => 'Panama',
|
|
'PG' => 'Papua New Guinea',
|
|
'PY' => 'Paraguay',
|
|
'PE' => 'Peru',
|
|
'PH' => 'Philippines',
|
|
'PN' => 'Pitcairn',
|
|
'PL' => 'Poland',
|
|
'PT' => 'Portugal',
|
|
'PR' => 'Puerto Rico',
|
|
'QA' => 'Qatar',
|
|
'RE' => 'Reunion',
|
|
'RO' => 'Romania',
|
|
'RU' => 'Russia',
|
|
'RW' => 'Rwanda',
|
|
'BL' => 'Saint Barthelemy',
|
|
'SH' => 'Saint Helena',
|
|
'KN' => 'Saint Kitts And Nevis',
|
|
'LC' => 'Saint Lucia',
|
|
'MF' => 'Saint Martin',
|
|
'PM' => 'Saint Pierre And Miquelon',
|
|
'VC' => 'Saint Vincent And Grenadines',
|
|
'WS' => 'Samoa',
|
|
'SM' => 'San Marino',
|
|
'ST' => 'Sao Tome And Principe',
|
|
'SA' => 'Saudi Arabia',
|
|
'SN' => 'Senegal',
|
|
'RS' => 'Serbia',
|
|
'SC' => 'Seychelles',
|
|
'SL' => 'Sierra Leone',
|
|
'SG' => 'Singapore',
|
|
'SK' => 'Slovakia',
|
|
'SI' => 'Slovenia',
|
|
'SB' => 'Solomon Islands',
|
|
'SO' => 'Somalia',
|
|
'ZA' => 'South Africa',
|
|
'GS' => 'South Georgia And Sandwich Isl.',
|
|
'ES' => 'Spain',
|
|
'LK' => 'Sri Lanka',
|
|
'SD' => 'Sudan',
|
|
'SR' => 'Suriname',
|
|
'SJ' => 'Svalbard And Jan Mayen',
|
|
'SZ' => 'Swaziland',
|
|
'SE' => 'Sweden',
|
|
'CH' => 'Switzerland',
|
|
'SY' => 'Syrian Arab Republic',
|
|
'TW' => 'Taiwan',
|
|
'TJ' => 'Tajikistan',
|
|
'TZ' => 'Tanzania',
|
|
'TH' => 'Thailand',
|
|
'TL' => 'Timor-Leste',
|
|
'TG' => 'Togo',
|
|
'TK' => 'Tokelau',
|
|
'TO' => 'Tonga',
|
|
'TT' => 'Trinidad And Tobago',
|
|
'TN' => 'Tunisia',
|
|
'TR' => 'Turkey',
|
|
'TM' => 'Turkmenistan',
|
|
'TC' => 'Turks And Caicos Islands',
|
|
'TV' => 'Tuvalu',
|
|
'UG' => 'Uganda',
|
|
'UA' => 'Ukraine',
|
|
'AE' => 'United Arab Emirates',
|
|
'GB' => 'United Kingdom',
|
|
'US' => 'United States',
|
|
'UM' => 'United States Outlying Islands',
|
|
'UY' => 'Uruguay',
|
|
'UZ' => 'Uzbekistan',
|
|
'VU' => 'Vanuatu',
|
|
'VE' => 'Venezuela',
|
|
'VN' => 'Viet Nam',
|
|
'VG' => 'Virgin Islands, British',
|
|
'VI' => 'Virgin Islands, U.S.',
|
|
'WF' => 'Wallis And Futuna',
|
|
'EH' => 'Western Sahara',
|
|
'YE' => 'Yemen',
|
|
'ZM' => 'Zambia',
|
|
'ZW' => 'Zimbabwe',
|
|
);
|
|
|
|
return $countries_data;
|
|
}
|
|
}
|