[changes] Rename 'approximate' to 'estimated'

Signed-off-by: DragnEmperor <[email protected]>

Author: DragnEmperor

docs/index.rst

@@ -49,7 +49,7 @@ the OpenWISP architecture.
     user/openvpn.rst
     user/subnet-division-rules.rst
     user/whois.rst
-    user/approximate-location.rst
+    user/estimated-location.rst
     user/rest-api.rst
     user/settings.rst
 

docs/user/approximate-location.rst renamed to docs/user/estimated-location.rst

@@ -1,13 +1,13 @@
-Approximate Location
-====================
+Estimated Location
+==================
 
 .. important::
 
-    The **Approximate Location** feature is **disabled by default**.
+    The **Estimated Location** feature is **disabled by default**.
 
     Before enabling it, the :doc:`WHOIS Lookup feature <whois>` must be
     enabled. Then set
-    :ref:`OPENWISP_CONTROLLER_APPROXIMATE_LOCATION_ENABLED` to ``True``
+    :ref:`OPENWISP_CONTROLLER_ESTIMATED_LOCATION_ENABLED` to ``True``
 
 .. contents:: **Table of contents**:
     :depth: 1
@@ -16,20 +16,20 @@ Approximate Location
 Overview
 --------
 
-The Approximate Location feature automatically creates or updates a
-device’s location based on latitude and longitude information retrieved
-from the WHOIS Lookup feature.
+The Estimated Location feature automatically creates or updates a device’s
+location based on latitude and longitude information retrieved from the
+WHOIS Lookup feature.
 
 Trigger Conditions
 ------------------
 
-Approximate Location is triggered when:
+Estimated Location is triggered when:
 
 - A **fresh WHOIS lookup** is performed for a device.
 - Or when a WHOIS record already exists for the device’s IP **and**:
 
   - The device’s last IP address is **public**.
-  - WHOIS lookup and Approximate Location is **enabled** for the device’s
+  - WHOIS lookup and Estimated Location is **enabled** for the device’s
     organization.
 
 Behavior
@@ -40,13 +40,13 @@ another device with same ip to the current device if:
 
 - Only one device is found with that IP and it has a location.
 - The current device **has no location** or that location is
-  **approximate**.
+  **estimated**.
 
 If there are multiple devices with location for the same IP, the system
 will **not attach any location** to the current device and a notification
 will be sent suggesting the user to manually assign/create a location for
 the device.
 
-If there is **no matching location**, a new approximate location is
-created or the existing one is updated using coordinates from the WHOIS
-record, but only if the existing location is approximate.
+If there is **no matching location**, a new estimated location is created
+or the existing one is updated using coordinates from the WHOIS record,
+but only if the existing location is estimated.

docs/user/settings.rst

@@ -796,19 +796,19 @@ Maxmind Account ID required for the :doc:`WHOIS Lookup feature <whois>`.
 
 Maxmind License Key required for the :doc:`WHOIS Lookup feature <whois>`.
 
-.. _openwisp_controller_whois_approximate_location_enabled:
+.. _openwisp_controller_whois_estimated_location_enabled:
 
-``OPENWISP_CONTROLLER_WHOIS_APPROXIMATE_LOCATION_ENABLED``
-----------------------------------------------------------
+``OPENWISP_CONTROLLER_WHOIS_ESTIMATED_LOCATION_ENABLED``
+--------------------------------------------------------
 
 ============ =========
 **type**:    ``bool``
 **default**: ``False``
 ============ =========
 
-Allows enabling the optional :doc:`Approximate Location feature
-<approximate-location>`.
+Allows enabling the optional :doc:`Estimated Location feature
+<estimated-location>`.
 
-.. image:: https://raw.githubusercontent.com/openwisp/openwisp-controller/docs/docs/1.3/approximate-location-setting.png
-    :target: https://raw.githubusercontent.com/openwisp/openwisp-controller/docs/docs/1.3/approximate-location-setting.png
-    :alt: Approximate Location setting
+.. image:: https://raw.githubusercontent.com/openwisp/openwisp-controller/docs/docs/1.3/estimated-location-setting.png
+    :target: https://raw.githubusercontent.com/openwisp/openwisp-controller/docs/docs/1.3/estimated-location-setting.png
+    :alt: Estimated Location setting

openwisp_controller/config/admin.py

@@ -1384,7 +1384,7 @@ def get_fields(self, request, obj=None):
         if app_settings.REGISTRATION_ENABLED:
             fields += ["registration_enabled", "shared_secret"]
         if app_settings.WHOIS_CONFIGURED:
-            fields += ["whois_enabled", "approximate_location_enabled"]
+            fields += ["whois_enabled", "estimated_location_enabled"]
         fields += ["context"]
         return fields
 

openwisp_controller/config/base/multitenancy.py

@@ -39,10 +39,10 @@ class AbstractOrganizationConfigSettings(UUIDModel):
         fallback=app_settings.WHOIS_ENABLED,
         verbose_name=_("WHOIS Enabled"),
     )
-    approximate_location_enabled = FallbackBooleanChoiceField(
-        help_text=_("Whether the approximate location feature is enabled"),
-        fallback=app_settings.APPROXIMATE_LOCATION_ENABLED,
-        verbose_name=_("Approximate Location Enabled"),
+    estimated_location_enabled = FallbackBooleanChoiceField(
+        help_text=_("Whether the estimated location feature is enabled"),
+        fallback=app_settings.ESTIMATED_LOCATION_ENABLED,
+        verbose_name=_("Estimated Location Enabled"),
     )
     context = JSONField(
         blank=True,
@@ -76,11 +76,11 @@ def clean(self):
                     )
                 }
             )
-        if not self.whois_enabled and self.approximate_location_enabled:
+        if not self.whois_enabled and self.estimated_location_enabled:
             raise ValidationError(
                 {
-                    "approximate_location_enabled": _(
-                        "Approximate Location feature requires "
+                    "estimated_location_enabled": _(
+                        "Estimated Location feature requires "
                         "WHOIS Lookup feature to be enabled."
                     )
                 }

openwisp_controller/config/migrations/0062_organizationconfigsettings_approximate_location_enabled_and_more.py

@@ -15,14 +15,14 @@ class Migration(migrations.Migration):
     operations = [
         migrations.AddField(
             model_name="organizationconfigsettings",
-            name="approximate_location_enabled",
+            name="estimated_location_enabled",
             field=openwisp_utils.fields.FallbackBooleanChoiceField(
                 blank=True,
                 default=None,
                 fallback=False,
-                help_text="Whether the approximate location feature is enabled",
+                help_text="Whether the estimated location feature is enabled",
                 null=True,
-                verbose_name="Approximate Location Enabled",
+                verbose_name="Estimated Location Enabled",
             ),
         ),
         migrations.AddField(

openwisp_controller/config/settings.py

@@ -77,8 +77,8 @@ def get_setting(option, default):
         "WHOIS_GEOIP_ACCOUNT and WHOIS_GEOIP_KEY must be set "
         + "when WHOIS_ENABLED is True."
     )
-APPROXIMATE_LOCATION_ENABLED = get_setting("APPROXIMATE_LOCATION_ENABLED", False)
-if APPROXIMATE_LOCATION_ENABLED and not WHOIS_ENABLED:
+ESTIMATED_LOCATION_ENABLED = get_setting("ESTIMATED_LOCATION_ENABLED", False)
+if ESTIMATED_LOCATION_ENABLED and not WHOIS_ENABLED:
     raise ImproperlyConfigured(
-        "WHOIS must be enabled before enabling APPROXIMATE_LOCATION globally"
+        "WHOIS must be enabled before enabling ESTIMATED_LOCATION globally"
     )

openwisp_controller/config/whois/service.py

@@ -6,7 +6,7 @@
 
 from openwisp_controller.config import settings as app_settings
 
-from .tasks import fetch_whois_details, manage_approximate_locations
+from .tasks import fetch_whois_details, manage_estimated_locations
 
 
 class WHOISService:
@@ -73,16 +73,16 @@ def is_whois_enabled(self):
         return getattr(org_settings, "whois_enabled", app_settings.WHOIS_ENABLED)
 
     @property
-    def is_approximate_location_enabled(self):
+    def is_estimated_location_enabled(self):
         """
-        Check if the Approximate location feature is enabled.
+        Check if the Estimated location feature is enabled.
         This does not require to set cache as `is_whois_enabled` already sets it
         """
         org_settings = cache.get(self.get_cache_key(org_id=self.device.organization.pk))
         return getattr(
             org_settings,
-            "approximate_location_enabled",
-            app_settings.APPROXIMATE_LOCATION_ENABLED,
+            "estimated_location_enabled",
+            app_settings.ESTIMATED_LOCATION_ENABLED,
         )
 
     def _need_whois_lookup(self, new_ip):
@@ -105,9 +105,9 @@ def _need_whois_lookup(self, new_ip):
 
         return self.is_whois_enabled
 
-    def _need_approximate_location_management(self, new_ip):
+    def _need_estimated_location_management(self, new_ip):
         """
-        Used to determine if Approximate locations need to be created/updated
+        Used to determine if Estimated locations need to be created/updated
         or not during WHOIS lookup.
         """
         if not self.is_valid_public_ip_address(new_ip):
@@ -116,7 +116,7 @@ def _need_approximate_location_management(self, new_ip):
         if not self.is_whois_enabled:
             return False
 
-        return self.is_approximate_location_enabled
+        return self.is_estimated_location_enabled
 
     def get_device_whois_info(self):
         """
@@ -145,10 +145,10 @@ def trigger_whois_lookup(self):
             )
         # `add_existing` is `True` to handle the case when WHOIS already exists
         # as in that case WHOIS lookup is not triggered but we still need to
-        # manage approximate locations.
-        elif self._need_approximate_location_management(new_ip):
+        # manage estimated locations.
+        elif self._need_estimated_location_management(new_ip):
             transaction.on_commit(
-                lambda: manage_approximate_locations.delay(
+                lambda: manage_estimated_locations.delay(
                     device_pk=self.device.pk, ip_address=new_ip, add_existing=True
                 )
             )

openwisp_controller/config/whois/tasks.py

@@ -7,9 +7,7 @@
 from geoip2 import webservice as geoip2_webservice
 from swapper import load_model
 
-from openwisp_controller.geo.approximate_location.tasks import (
-    manage_approximate_locations,
-)
+from openwisp_controller.geo.estimated_location.tasks import manage_estimated_locations
 from openwisp_utils.tasks import OpenwispCeleryTask
 
 from .. import settings as app_settings
@@ -126,8 +124,8 @@ def fetch_whois_details(self, device_pk, initial_ip_address, new_ip_address):
         whois_obj.save()
         logger.info(f"Successfully fetched WHOIS details for {new_ip_address}.")
 
-        if device._get_organization__config_settings().approximate_location_enabled:
-            manage_approximate_locations.delay(
+        if device._get_organization__config_settings().estimated_location_enabled:
+            manage_estimated_locations.delay(
                 device_pk=device_pk, ip_address=new_ip_address
             )
 

openwisp_controller/config/whois/utils.py

@@ -22,7 +22,7 @@
     },
     "location_error": {
         "message": _(
-            "Unable to create approximate location for device "
+            "Unable to create estimated location for device "
             "[{notification.target}]({notification.target_link}). "
             "Please assign/create a location manually."
         ),