Fastah API datasource: initial implementation #152
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,225 @@ | ||
| <?php | ||
| /* | ||
| Copyright 2013-2021 Yellow Tree, Siegen, Germany | ||
| Author: Benjamin Pick (wp-geoip-detect| |posteo.de) | ||
| This program is free software; you can redistribute it and/or modify | ||
| it under the terms of the GNU General Public License as published by | ||
| the Free Software Foundation; either version 3 of the License, or | ||
| (at your option) any later version. | ||
| This program is distributed in the hope that it will be useful, | ||
| but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| GNU General Public License for more details. | ||
| You should have received a copy of the GNU General Public License | ||
| along with this program; if not, write to the Free Software | ||
| Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA | ||
| */ | ||
|
|
||
| namespace YellowTree\GeoipDetect\DataSources\Fastah; | ||
|
|
||
| use YellowTree\GeoipDetect\DataSources\AbstractDataSource; | ||
|
|
||
| class Reader implements \YellowTree\GeoipDetect\DataSources\ReaderInterface { | ||
|
|
||
| const URL = 'ep.api.getfastah.com/whereis/v1/json/'; | ||
| protected $options = array(); | ||
| protected $params = array(); | ||
|
|
||
| function __construct($params, $locales, $options) { | ||
| $this->params= $params; | ||
| $this->params['language'] = reset($locales); | ||
| // TODO: Fastah API responses only support 'en' at this time | ||
| //if (empty($this->params['language'])) { | ||
| $this->params['language'] = 'en'; | ||
| //} | ||
|
|
||
| $default_options = array( | ||
| 'timeout' => 1, | ||
| ); | ||
| $this->options = $options + $default_options; | ||
| } | ||
|
|
||
| protected function locales($locale, $value) { | ||
| $locales = array('en' => $value); | ||
| if ($locale != 'en') { | ||
| $locales[$locale] = $value; | ||
| } | ||
| return $locales; | ||
| } | ||
|
|
||
| public function city($ip) { | ||
| try { | ||
| $requestArgs = array( | ||
| 'method' => 'GET', | ||
| 'httpversion' => ($this->params['http2'] === 1) ? 2.0 : 1.1, | ||
| 'timeout' => $this->options['timeout'], | ||
| 'headers' => array( | ||
| 'Fastah-Key' => $this->params['key'] | ||
| ) | ||
| ); | ||
| $response = wp_remote_get($this->build_url($ip), $requestArgs); | ||
| $respCode = wp_remote_retrieve_response_code( $response ); | ||
| if (is_wp_error($response)) { | ||
| return _geoip_detect2_get_new_empty_record($ip, $response->get_error_message()); | ||
| } | ||
| $body = wp_remote_retrieve_body( $response ); | ||
| $data = json_decode( $body, true ); | ||
| if ($respCode !== 200) { | ||
| if ($data && isset($data['error']) && isset($data['error']['message'])) { | ||
| return _geoip_detect2_get_new_empty_record($ip, $data['error']['message']); | ||
| } | ||
| if ($data && isset($data['message'])) { | ||
| return _geoip_detect2_get_new_empty_record($ip, $data['message']); | ||
| } | ||
| } | ||
| } catch (\Exception $e) { | ||
| return _geoip_detect2_get_new_empty_record($ip, $e->getMessage()); | ||
|
Member
There was a problem hiding this comment. Could you please check for the "HTTP/2 not supported" Error and make a more user-friendly error string out of it? "Please disable HTTP/2-support ..." |
||
| } | ||
|
|
||
| $r = array(); | ||
| $r['extra']['original'] = $data; | ||
|
|
||
| $locale = 'en'; // The REST API only support English at this time | ||
|
|
||
| if (!empty($data['locationData'])) { | ||
| // Continent | ||
| $r['continent']['code'] = strtoupper($data['locationData']['continentCode']); | ||
| // Country | ||
| $r['country']['names'] = $this->locales($locale, $data['locationData']['countryName']); | ||
| $r['country']['iso_code'] = strtoupper($data['locationData']['countryCode']); | ||
| // City | ||
| $r['city']['names'] = $this->locales($locale, $data['locationData']['cityName']); | ||
| $r['city']['geoname_id'] = $data['locationData']['cityGeonamesId']; | ||
| // Lat, Lng | ||
| $r['location']['latitude'] = $data['locationData']['lat']; | ||
benjaminpick marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| $r['location']['longitude'] = $data['locationData']['lng']; | ||
| // TZ | ||
| $r['location']['time_zone'] = $data['locationData']['tz']; | ||
| } | ||
|
|
||
| // EU flag | ||
| $r['country']['isInEuropeanUnion'] = $data['isEuropeanUnion']; | ||
|
|
||
| $r['traits']['ip_address'] = $data['ip']; | ||
|
|
||
| $record = new \GeoIp2\Model\City($r, array('en')); | ||
|
|
||
| return $record; | ||
| } | ||
|
|
||
| public function country($ip) { | ||
| return $this->city($ip); | ||
| } | ||
|
|
||
| public function close() { | ||
|
|
||
| } | ||
|
|
||
| private function build_url($ip) { | ||
| $url = 'https'; | ||
| $url .= '://' . self::URL . $ip; | ||
| return $url . '?' . \http_build_query($params); | ||
| } | ||
|
|
||
| } | ||
|
|
||
|
|
||
| class FastahSource extends AbstractDataSource { | ||
| protected $params = array(); | ||
| // PHP-Curl with functional TLS 1.2 (secure ciphers) and HTTP 1.1 are minimum requirements | ||
| protected $bestAvailHTTP = CURL_HTTP_VERSION_1_1; | ||
|
|
||
| public function __construct() { | ||
| $this->params['key'] = get_option('geoip-detect-fastah_key', ''); | ||
|
|
||
| // Set default by probing PHP/Curl capabilities - minimum is HTTP 1.1 over TLSv1.2 | ||
| // HTTP/2 ought to be available in PHP-Curl > v7.47.0 @see https://curl.se/docs/http2.html | ||
| if (curl_version()["features"] & CURL_HTTP_VERSION_2_0 !== 0) { | ||
| $this->bestAvailHTTP = CURL_HTTP_VERSION_2_0; | ||
| if (curl_version()["features"] & CURL_HTTP_VERSION_2TLS !== 0) { | ||
| $this->bestAvailHTTP = CURL_HTTP_VERSION_2TLS; | ||
| } | ||
| } | ||
| if ($this->bestAvailHTTP < CURL_HTTP_VERSION_2_0) { | ||
| $this->params['http2'] = get_option('geoip-detect-fastah_http2', 0); | ||
| } else { | ||
| $this->params['http2'] = get_option('geoip-detect-fastah_http2', 1); | ||
benjaminpick marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
| } | ||
|
|
||
| public function getId() { return 'fastah'; } | ||
| public function getLabel() { return __('Fastah Web API <sup><em>beta</em></sup>', 'geoip-detect'); } | ||
|
|
||
| public function getDescriptionHTML() { return __('Commercial, with enterprise-friendly support and billing. <a href="https://aws.amazon.com/marketplace/pp/prodview-k5gjowexrefl2" target="_blank">Sign-up on AWS Marketplace</a>. <a href="https://docs.getfastah.com/docs/quick-start" target="_blank">API Documentation</a>', 'geoip-detect'); } | ||
| public function getStatusInformationHTML() { | ||
| $html = ''; | ||
|
|
||
| $html .= \sprintf(__('HTTP2: %s', 'geoip-detect'), $this->params['http2'] ? __('Enabled', 'geoip-detect') : __('Disabled', 'geoip-detect')) . '<br />'; | ||
|
|
||
| if (!$this->isWorking()) { | ||
| if (!is_callable('curl_init')) { | ||
| $html .= '<div class="geoip_detect_error">' . __('Fastah requires PHP-Curl for secure HTTPS requests.', 'geoip-detect') . '</div>'; | ||
| } else { | ||
| $html .= '<div class="geoip_detect_error">' . __('Fastah only works with an API key.', 'geoip-detect') . '</div>'; | ||
| } | ||
| } | ||
|
|
||
| return $html; | ||
| } | ||
|
|
||
| public function getParameterHTML() { | ||
| $label_key = __('API Access Key :', 'geoip-detect'); | ||
| $label_http2 = __('Use HTTP/2 :', 'geoip-detect'); | ||
|
|
||
| $key = esc_attr($this->params['key']); | ||
|
|
||
| $html = <<<HTML | ||
| $label_key <input type="text" autocomplete="off" size="20" name="options_fastah[key]" value="$key" /> <br /> | ||
| <a href="https://aws.amazon.com/marketplace/pp/prodview-k5gjowexrefl2" target="_blank">Sign-up for a 30-day trial key</a>, <a href="https://console.api.getfastah.com" target="_blank">API usage dashboard</a><br><br> | ||
| $label_http2 <select name="options_fastah[http2]"> | ||
| HTML; | ||
| $html .= '<option value="0" ' . (!$this->params['http2'] ? ' selected="selected"' : '') . '">' . __('HTTP/2 is OFF (slower, but more compatible with older PHP versions)', 'geoip-detect') . '</option>'; | ||
| $html .= '<option value="1" ' . ($this->params['http2'] ? ' selected="selected"' : '') . '">' . __('HTTP/2 is ON (faster performance)', 'geoip-detect') . '</option>'; | ||
| $html .= '</select>'; | ||
|
|
||
| return $html; | ||
| } | ||
|
|
||
| public function saveParameters($post) { | ||
| $message = ''; | ||
|
|
||
| if (isset($post['options_fastah']['key'])) { | ||
| $key = sanitize_key($post['options_fastah']['key']); | ||
| update_option('geoip-detect-fastah_key', $key); | ||
| $this->params['key']= $key; | ||
| } | ||
|
|
||
| if (isset($post['options_fastah']['http2'])) { | ||
| $http2 = (int) $post['options_fastah']['http2']; | ||
| update_option('geoip-detect-fastah_http2', $http2); | ||
| // Show warning if HTTP/2 requested but actually not available via PHP-Curl | ||
| if ($http2 == 1 and $this->bestAvailHTTP < CURL_HTTP_VERSION_2_0) { | ||
| $message .= __('Fastah requires PHP-Curl with HTTP/2 support.<br>', 'geoip-detect'); | ||
| $http2 = 0; // Turn it OFF forcefully | ||
| } | ||
| $this->params['http2'] = $http2; | ||
| } | ||
|
|
||
| if (geoip_detect2_is_source_active('fastah') && !$this->isWorking()) | ||
| $message .= __('Fastah only works with an API key.', 'geoip-detect'); | ||
|
|
||
| return $message; | ||
| } | ||
|
|
||
| public function getReader($locales = array('en'), $options = array()) { | ||
| return new Reader($this->params, $locales, $options); | ||
| } | ||
|
|
||
| public function isWorking() { | ||
| return (!empty($this->params['key']) and is_callable('curl_init')); | ||
| } | ||
|
|
||
| } | ||
| geoip_detect2_register_source(new FastahSource()); | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.