Merge branch 'beta'

Author: Benjamin Pick

README.md

@@ -121,56 +121,20 @@ See [Documentation](https://github.com/yellowtree/geoip-detect/wiki) for more in
 1. Lookup page (under Tools > Geolocation Lookup)
 2. Options page (under Preferences > Geolocation IP Detection)
 
-= 5.0.0 =
-
-If you are using AJAX mode, please read the changelog.
-
-= 4.0.1 =
-
-Hotfix - avoid fatal erros if another plugin also has the Maxmind library included
-
-= 4.0.0 =
-
-Improving Shortcodes (and Shortcodes for AJAX!)
-New Minimum Requirements: PHP 7.2.5, and if you use WooCommerce it needs to be 3.9.0 or later.
-
-= 3.3.0 =
-
-Improving AJAX mode - now you can use it for specific pages.
-
-= 3.2.1 = 
-
-This update fixes an issue of 3.2.0 if your installation has WP_DEBUG enabled.
-
-= 3.2.0 =
-
-This plugin version simplifies complying the the EULA of Maxmind by automatically retrieving and honoring their Privacy Exclusion List. 
-You need to enter your Account ID in the options. 
-Find more information about the Privacy Exclusion API in the FAQ of the plugin.
+= 5.5.0 =
 
-= 3.1.0 =
+When using the default datasource "hostip.info", the region code (i.e. CA) is now correctly moved to the property `mostSpecificSubdivision` (previously, it was part of the property `city`)
 
-The property access for shortcodes has been rewritten so that property names such as "extra.original.zip" (Datasource: ipstack) are possible now.
-
-= 3.0.3.1 = 
-
-Hotfix for the Manual download Maxmind datasource.
-The Plugin was renamed to Geolocation IP Detection in order to prevent trademark issues. 
-
-= 3.0.3 = 
-
-The Plugin was renamed to Geolocation IP Detection in order to prevent trademark issues. 
-
-= 3.0.1 = 
-
-3.0 was not compatible with the WooCommerce plugin.
-
-= 3.0 =
+= 5.0.0 =
 
-If you use Maxmind "Automatic download" then you need to upgrade to this plugin version in order to continue to receive database update. The Database license changed and you will need to register at their website and agree to the EULA.
+If you are using AJAX mode, please read the changelog.
 
 ## Changelog ##
 
+= 5.5.0 =
+* FIX [!]: In the datasource "hostip.info", the region code (i.e. CA) is now correctly moved to the property `mostSpecificSubdivision` (previously, it was part of the property `city`)
+* Library updates
+
 = 5.4.1 =
 * NEW: JS now emit events 'geoip-detect-shortcodes-done' and 'geoip-detect-body-classes-done', see https://github.com/yellowtree/geoip-detect/wiki/API:-AJAX#events
 * FIX: Remove Fatal Error in check_requirements ("Undefined constand GEOIP_DETECT_DEBUG")
@@ -246,123 +210,6 @@ Other minor changes:
 * Update some internal libraries & dev tools
 * Checked compatibility with PHP 8.1
 
-= 4.2.3 =
-* FIX: Further improve the Maxmind admin notice UI
-* Update some smaller libraries
-
-= 4.2.2 =
-* FIX: Show Maxmind admin notice only on GeoIP pages to make it less intrusive
-
-= 4.2.1 =
-* FIX: Do not disable lookup automatically when potentially incompatible Maxmind libraries are found.
-
-= 4.2.0 =
-* NEW: Show a warning on the options page when there are incompatibilities with other plugins that also use the Maxmind libraries.
-* FIX: Remove an incompatibility of the libraries with Toolset or other Laravel-based plugins
-* NEW: In CF7, you can now add any property to the mail body with a special syntax, e.g. `[geoip_detect2_property_country__iso_code]`
-* FIX (JS): Replace the internally used library 'lodash' with 'just' to reduce the JS file size
-* FIX (JS): Improve error handling in AJAX mode
-* FIX: Port numbers in reverse proxies are ignored now (removes incompatibility with Azure reverse proxies)
-* FIX: Prevent Cloudflare APO from caching when using AJAX mode or page caching is disabled in the plugin options
-
-= 4.1.0 =
-* NEW: An `else` shortcode for `geoip_detect2_show_if` and `geoip_detect2_hide_if`: `[geoip_detect2_show_if city="Berlin"]You are in Berlin[else]You are not in Berlin[/geoip_detect2_show_if]`
-* FIX: The JS for AJAX wasn't working for Safari browsers
-* FIX: Improving some edge cases of `Record.get_with_locales()` and other methods of `Record` to be consistent with non-AJAX mode
-* FIX: Revert more Maxmind libraries to fix incompatibility with WooCommerce
-
-= 4.0.1 =
-* FIX: Revert Maxmind library to 2.10.0 for now as the most current version seems to be incompatible with Wordfence and other plugins using the older version of the Maxmind library
-
-= 4.0.0 =
-This version has many changes regarding the Shortcodes API. It is a major version because it increases some system requirements (see below).
-
-* NEW: Shortcodes can now also be resolved in AJAX mode (without coding JS). 
-If you are using a page cache, AJAX mode is the best solution for you. And thanks to shortcodes, this doesn't need custom coding anymore. 
-You can keep using the same shortcodes as before - just tick the options "Enable AJAX endpoint" and "Resolve shortcodes (via AJAX)". 
-Instead of doing the geo-lookup while generating the HTML, it will generate boilerplate HTML (for the cache) that will be filled by the plugin's JS automatically (in the client's browser).
-* NEW: JS has a new function called `set_override(record, duration_in_days)` (see [AJAX documentation](https://github.com/yellowtree/geoip-detect/wiki/API:-AJAX)) so that the record information can be overridden manually (e.g. when the user selects a certain country manually). A PHP equivalent will follow.
-* NEW: The JS syntax of the shortcodes now supports both underscore_case and camelCase (e.g. both country.is_in_european_union and country.isInEuropeanUnion are valid)
-* NEW: [geoip_detect2_show_if] and [geoip_detect2_hide_if] now have a new attribute `operator="OR"` - this can be used to create conditions such as "continent = EU OR country = US"
-
-Other Improvements:
-* NEW (UI): Add a "Empty Cache"-Button on the Lookup page if the data source is caching the results
-* FIX: In some cases, the Privacy Exclusions Update wasn't rescheduled properly before
-* FIX: Ipstack: The property country.isInEuropeanUnion is now filled properly.
-* Updated vendor code
-
-Also note:
-* The minimum PHP version is now 7.2.5
-* Minimum Wordpress version is now 5.0
-* The plugin is now using PHP Type-Hinting for API functions - if you used the PHP API, please check if you see PHP errors
-* If you are using WooCommerce, you need at least version 3.9.0 (released Jan 2020) - otherwise this plugin lookup disables itself
-
-As always, if you are happy about the plugin, please consider [donating](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=BSYUZHS8FH3CL), [becoming a Beta-Tester](https://github.com/yellowtree/geoip-detect/wiki/Beta_Testing) or otherwise [contributing](https://github.com/yellowtree/geoip-detect/blob/master/CONTRIBUTING.md) to it.
-
-
-= 3.3.0 =
-* NEW shortcode `[geoip_detect2_enqueue_javascript]` if you are using AJAX mode, but only on certain wordpress pages.
-* NEW option "Add a country-specific CSS class to the <body>-Tag (via AJAX)." It is enabled automatically when upgrading the plugin, if the options "AJAX" and the "body tag" was enabled before.
-* Some UI fixes
-
-= 3.2.1 =
-* FIX: Fix a fatal error that can occur in 3.2.0 if WP_DEBUG is enabled on your installation.
-
-= 3.2.0 =
-* NEW: The plugin now integrates the Maxmind Privacy Exclusion API. If you are using a Maxmind datasource, the plugin will return an empty result when looking up an IP that is on the privacy blacklist. You need to enter your Account ID for this.
-* FIX: If timeZone is unknown, leave empty value instead of NULL
-* FIX: Improve compatibility with PHP 8.0
-* UI: Improving some strings for clearer documentation
-* AJAX mode is now declared stable (no code change)
-
-= 3.1.2 =
-* NEW: The shortcode `[geoip_detect2_text_input]` now has a parameter `type` for hidden or other HTML5 input types (see [Postal code example](https://github.com/yellowtree/geoip-detect/wiki/API:-Shortcodes-for-Contact-Form-7#create-a-text-input-that-is-prefilled-with-a-geodetected-property))
-* FIX: The Backend UI "Lookup" does not show an empty timezone anymore if there is no data attached to this IP.
-* NEW: In all datasources, the new record property `$record->extra->currencyCode` for the currency code of the detected country has been added
-* FIX: Compatibility with PHP 8.0
-
-= 3.1.1 =
-* NEW: Add the possibility to access the ISO-3166 alpha3 version of `$record->country`: `$record->extra->countryIsoCode3` or `[geoip_detect2 property="extra.countryIsoCode3"]`
-* FIX: The (CF7) shortcode `[geoip_detect2_countries]` now selects the selected country on page reload (the HTML tag autocomplete is set to `off` now)
-* FIX: Subnets can now be entered in the preferences of the reverse proxy again (this was a regression of the Admin UI changes in 3.0.3)
-* FIX: Do not log "It has not changed since the last update." as a cron-related error that should be shown to the user.
-
-= 3.1.0 =
-* FIX: The property access for shortcodes has been rewritten so that property names such as "extra.original.zip" (Datasource: ipstack) are possible now.
-* FIX: The lookup page now also shows subdivisions (e.g. for IPs from Uk that have 2 levels of subdivisions)
-* NEW: The (CF7) shortcode `[geoip_detect2_countries mycountry include_blank flag tel]` now adds the flag emoji (or ISO code in Windows) and the telephone international code to the country name
-* FIX: AJAX mode: Using localStorage instead of Cookies for caching (as we hit the Cookie size limitation sometimes)
-* FIX: AJAX mode: Remove jQuery dependency
-* FIX: AJAX mode: `geoip_detect2_enqueue_javascript()` can be used now in function.php or templates (see [PHP Example](https://github.com/yellowtree/geoip-detect/wiki/API-Usage-Examples#ajax-enqueue-the-js-file-manually))
-
-= 3.0.4 =
-* When an error occurs during the Cron update of the Maxmind database, it is now shown in the backend.
-* FIX: All times shown in the Admin backend now use the timezone set by Wordpress
-* FIX: In the Admin Options, it was not possible to revert an hardcoded "External IP of this server" back to "automatic detection"
-* FIX: `[geoip_detect2_show_if property="country.isInEuropeanUnion" property_value="true"]Products list for EU[/geoip_detect2_show_if]` now works properly (boolean values can be "true"/"yes" or "false"/"no")
-* FIX: `[geoip_detect2_current_flag]` now compatible with the [SVG Flags](https://wordpress.org/plugins/svg-flags-lite/) version 0.9.0. See [Documentation](https://github.com/yellowtree/geoip-detect/wiki/API:-Shortcodes#add-a-flag-of-the-visitors-country) for more infos. 
-* Minor admin improvement: If the value "IPs of trusted proxies" is set, but "The server is behind a reverse proxy" is not ticked, issue an warning
-
-= 3.0.3.1 =
-* Hotfix: The filename specified in the manual datasource can be changed properly again.
-
-= 3.0.3 =
-* The Plugin has been renamed to "Geolocation IP Detection" in order to prevent trademark issues
-* FIX: Minor improvements in the backend UI
-* FIX: Security hardening against XSS
-
-= 3.0.2 =
-(Was not released)
-
-= 3.0.1 =
-* FIX: Button "Update now" now works also on the lookup page.
-* FIX: Reverted the vendor code to the one used in 2.13 because it broke installations with the WooCommerce-plugin. I will update the vendor code again once we found a long-term solution for this interdepency.
-
-= 3.0 =
-* MAJOR CHANGE: Due to legal reasons, Maxmind now requires registration and some use cases are no longer allowed with the free data. If you use the Maxmind data source with automatic update, the update will fail for versions < 3.0 or if you have not entered a license key yet.
-* Updated the Maxmind update mechanism
-* Updated Maxmind vendor code 
-
 The code of the plugin has not changed much, I have named this version 3.0 to indicate the major change on Maxmind's side of things. They explain it in this blog post:
 https://blog.maxmind.com/2019/12/18/significant-changes-to-accessing-and-using-geolite2-databases/
 

data-sources/hostinfo.php

@@ -36,6 +36,19 @@ public function city($ip) {
 			$r['country']['iso_code'] = strtoupper($data['country_code']);
 
 		if ($data['city']) {
+			// In USA, region code is part of the city parameter
+			$cityParts = explode(',', $data['city']);
+			$data['city'] = trim($cityParts[0]);
+			if (!empty($cityParts[1])) {
+				$region = trim($cityParts[1]);
+				if (!empty($region)) {
+					$r['subdivisions'][0] = array(
+						'iso_code' => $region,
+						'names' => array('en' => $region),
+					);
+				}
+			}
+
 			$r['city']['names'] = [ 'en' => $data['city'] ];
 		}
 
@@ -80,6 +93,7 @@ private function api_call($ip) {
 					if ($key == 'country_code' && $value == 'XX')
 						$value = '';
 				}
+				
 				$hasInfo = $data['country_name'] || $data['country_code'] || $data['city'];
 			}
 

data-sources/ipstack.php

@@ -84,7 +84,7 @@ public function city($ip) {
 		if (!empty($data['country_code']))
             $r['country']['iso_code'] = strtoupper($data['country_code']);
 
-            if (!empty($data['region_code'])) {
+        if (!empty($data['region_code'])) {
             $r['subdivisions'][0] = array(
                 'iso_code' => $data['region_code'],
                 'names' => $this->locales($locale, $data['region_name']),

geoip-detect.php

@@ -5,7 +5,7 @@
 Description:     Provides geographic information detected by an IP adress.
 Author:          Yellow Tree (Benjamin Pick)
 Author URI:      http://www.yellowtree.de
-Version:         5.4.1
+Version:         5.5.0
 License:         GPLv3 or later
 License URI:     http://www.gnu.org/licenses/gpl-3.0.html
 Text Domain:     geoip-detect
@@ -16,7 +16,7 @@
 Requires PHP:    7.2.5
 */
 
-define('GEOIP_DETECT_VERSION', '5.4.1');
+define('GEOIP_DETECT_VERSION', '5.5.0');
 
 /*
 Copyright 2013-2023 Yellow Tree, Siegen, Germany

js/dist/frontend_base.js.map

@@ -1,5 +1,5 @@
 <?php
-// Generated at Mon, 14 Aug 2023 10:51:50 +0200 
+// Generated at Mon, 13 Jan 2025 15:06:50 +0000 
 return array (
   'countries' => 
   array (
@@ -3246,7 +3246,7 @@
       'continent' => 'AS',
       'location' => 
       array (
-        'latitude' => 21.131296248312502,
+        'latitude' => 21.2152279209553,
         'longitude' => 82.93322521645375,
       ),
       'extra' => 
@@ -4796,8 +4796,8 @@
       'continent' => 'AS',
       'location' => 
       array (
-        'latitude' => 3.1953621375,
-        'longitude' => 73.152777619,
+        'latitude' => 3.195189949496238,
+        'longitude' => 73.1527255694414,
       ),
       'extra' => 
       array (
@@ -5123,7 +5123,7 @@
         'geoname_id' => 2750405,
         'names' => 
         array (
-          'en' => 'Netherlands',
+          'en' => 'The Netherlands',
           'de' => 'Niederlande',
           'it' => 'Paesi Bassi',
           'es' => 'Holanda',
@@ -6952,7 +6952,7 @@
         'geoname_id' => 298795,
         'names' => 
         array (
-          'en' => 'Turkey',
+          'en' => 'Türkiye',
           'de' => 'Türkei',
           'it' => 'Turchia',
           'es' => 'Turquía',

js/dist/frontend_full.js.map

@@ -1,5 +1,5 @@
 <?php
-// Generated at Mon, 14 Aug 2023 10:51:50 +0200 
+// Generated at Mon, 13 Jan 2025 15:06:50 +0000 
 return array (
   'en' => 
   array (
@@ -156,7 +156,6 @@
     'NA' => 'Namibia',
     'NR' => 'Nauru',
     'NP' => 'Nepal',
-    'NL' => 'Netherlands',
     'NC' => 'New Caledonia',
     'NZ' => 'New Zealand',
     'NI' => 'Nicaragua',
@@ -224,16 +223,17 @@
     'TZ' => 'Tanzania',
     'TH' => 'Thailand',
     'GM' => 'The Gambia',
+    'NL' => 'The Netherlands',
     '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',
+    'TR' => 'Türkiye',
     'UM' => 'U.S. Outlying Islands',
     'VI' => 'U.S. Virgin Islands',
     'UG' => 'Uganda',

js/dist/frontend_minimal.js.map

@@ -18,7 +18,7 @@
 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */
 
-// Usage: $ php lib/geonames/generators/geonames.php {api_username}
+// Usage: $ php lib/geonames/generators/geonames.php [api_username]
 // Requires PHP 5.4
 
 if (php_sapi_name() != "cli")