[change] Rename who_is files/directories

- Added message matching for Validation errors
- Docs update

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

Author: DragnEmperor

docs/index.rst

@@ -49,6 +49,7 @@ the OpenWISP architecture.
     user/openvpn.rst
     user/subnet-division-rules.rst
     user/rest-api.rst
+    user/who-is.rst
     user/settings.rst
 
 .. toctree::

docs/user/settings.rst

@@ -743,53 +743,41 @@ For more information on these settings, you can refer to the `the celery
 documentation regarding automatic retries for known errors.
 <https://docs.celeryq.dev/en/stable/userguide/tasks.html#automatic-retry-for-known-exceptions>`_
 
-``OPENWISP_CONTROLLER_WHO_IS_ENABLED``
---------------------------------------
+``OPENWISP_CONTROLLER_WHOIS_ENABLED``
+-------------------------------------
 
 ============ =========
 **type**:    ``bool``
 **default**: ``False``
 ============ =========
 
-Allows to enable WhoIs lookup feature.
+Allows enabling the optional :doc:`WHOIS Lookup feature <who-is>`.
 
 .. image:: https://github.com/user-attachments/assets/0737d39c-1fad-4fca-aca9-9b42bc321763
-    :alt: who_is admin setting
+    :alt: WHOIS admin setting
 
-This feature is used to fetch details of a device based on its last
-reported public IP address. The fetched details include ASN, CIDR,
-address, timezone and name of organization associated with ASN.
+This feature is disabled by default. To enable it, set this option to
+``True`` and define both :ref:`OPENWISP_CONTROLLER_WHOIS_GEOIP_ACCOUNT
+<OPENWISP_CONTROLLER_WHOIS_GEOIP_ACCOUNT>` and
+:ref:`OPENWISP_CONTROLLER_WHOIS_GEOIP_KEY
+<OPENWISP_CONTROLLER_WHOIS_GEOIP_KEY>`.
 
-This feature is disabled by default and requires setting the
-:ref:`OPENWISP_CONTROLLER_GEOIP_ACCOUNT_ID
-<OPENWISP_CONTROLLER_GEOIP_ACCOUNT_ID>` and
-:ref:`OPENWISP_CONTROLLER_GEOIP_LICENSE_KEY
-<OPENWISP_CONTROLLER_GEOIP_LICENSE_KEY>` settings to enable it.
-
-``OPENWISP_CONTROLLER_GEOIP_ACCOUNT_ID``
-----------------------------------------
+``OPENWISP_CONTROLLER_WHOIS_GEOIP_ACCOUNT``
+-------------------------------------------
 
 ============ =======
 **type**:    ``str``
 **default**: None
 ============ =======
 
-This setting represents the Account ID of your Maxmind Account which can
-be obtained by following the steps mentioned in the :doc:`WhoIs Lookup
-<who-is>`.
+Maxmind Account ID required for :doc:`WHOIS Lookup <who-is>`.
 
-This setting is required for WhoIs lookup feature to work.
-
-``OPENWISP_CONTROLLER_GEOIP_LICENSE_KEY``
------------------------------------------
+``OPENWISP_CONTROLLER_WHOIS_GEOIP_KEY``
+---------------------------------------
 
 ============ =======
 **type**:    ``str``
 **default**: None
 ============ =======
 
-This setting represents the License Key of your Maxmind Account which can
-be obtained by following the steps mentioned in the :doc:`WhoIs Lookup
-<who-is>`.
-
-This setting is required for WhoIs lookup feature to work.
+Maxmind License Key required for :doc:`WHOIS Lookup <who-is>`.

docs/user/who-is.rst

@@ -3,32 +3,32 @@ WHOIS Lookup
 
 .. important::
 
-    The WhoIs Lookup feature is disabled by default.
+    The **WHOIS Lookup** feature is disabled by default.
 
     In order to enable this feature you have to follow the `setup
-    instructions <controller_setup_who_is_lookup_>`_ below and then
+    instructions <controller_setup_whois_lookup_>`_ below and then
     activate it via :ref:`global setting or from the admin interface
-    <OPENWISP_CONTROLLER_WHO_IS_ENABLED>`.
+    <OPENWISP_CONTROLLER_WHOIS_ENABLED>`.
 
 .. warning::
 
-    If the :ref:`OPENWISP_CONTROLLER_WHO_IS_ENABLED` setting is set to
+    If the :ref:`OPENWISP_CONTROLLER_WHOIS_ENABLED` setting is set to
     ``True`` and the required environment variables are not set, then
     ``ImproperlyConfigured`` exception will be raised.
 
-    Both of the settings :ref:`OPENWISP_CONTROLLER_GEOIP_ACCOUNT_ID` and
-    :ref:`OPENWISP_CONTROLLER_GEOIP_LICENSE_KEY` are required to be set,
-    to ensure the WhoIs Lookup feature can be enabled/disabled for each
+    Both of the settings :ref:`OPENWISP_CONTROLLER_WHOIS_GEOIP_ACCOUNT`
+    and :ref:`OPENWISP_CONTROLLER_WHOIS_GEOIP_KEY` are required to be set,
+    to ensure the WHOIS Lookup feature can be enabled/disabled for each
     organization. Else, the feature will be disabled globally and the
     field will not be available to configure on admin interface.
 
-WhoIs feature includes fetching details of the last public ip address
+WHOIS feature includes fetching details of the last public ip address
 reported by a device to ensure better device management.
 
-The fetched details include Organization Name, ASN, CIDR, Address,
-Timezone.
+The fetched details include ASN, CIDR, Address, Timezone and Name of
+Organization associated with ASN.
 
-.. _controller_setup_who_is_lookup:
+.. _controller_setup_whois_lookup:
 
 Setup
 -----
@@ -38,11 +38,11 @@ follows:
 
 .. code-block:: python
 
-    OPENWISP_CONTROLLER_GEOIP_ACCOUNT_ID = os.getenv(
-        "OPENWISP_CONTROLLER_GEOIP_ACCOUNT_ID", ""
+    OPENWISP_CONTROLLER_WHOIS_GEOIP_ACCOUNT = os.getenv(
+        "OPENWISP_CONTROLLER_WHOIS_GEOIP_ACCOUNT", ""
     )
-    OPENWISP_CONTROLLER_GEOIP_LICENSE_KEY = os.getenv(
-        "OPENWISP_CONTROLLER_GEOIP_LICENSE_KEY", ""
+    OPENWISP_CONTROLLER_WHOIS_GEOIP_KEY = os.getenv(
+        "OPENWISP_CONTROLLER_WHOIS_GEOIP_KEY", ""
     )
 
 Steps to obtain values of above settings
@@ -58,5 +58,5 @@ Steps to obtain values of above settings
 - Generate a New license Key. Name it whatever you like .. image::
   https://github.com/user-attachments/assets/57df27bc-4f9d-4701-88bf-91e6b715e4a6
 - Copy the *Account Id* and *License Key* and Paste it in the environment
-  variables: **OPENWISP_CONTROLLER_GEOIP_ACCOUNT_ID** and
-  **OPENWISP_CONTROLLER_GEOIP_LICENSE_KEY**.
+  variables: **OPENWISP_CONTROLLER_WHOIS_GEOIP_ACCOUNT** and
+  **OPENWISP_CONTROLLER_WHOIS_GEOIP_KEY**.

openwisp_controller/config/admin.py

@@ -1364,8 +1364,8 @@ class ConfigSettingsInline(admin.StackedInline):
 
         def get_fields(self, request, obj=None):
             fields = super().get_fields(request, obj)
-            if not app_settings.WHO_IS_CONFIGURED:
-                fields.remove("who_is_enabled")
+            if not app_settings.WHOIS_CONFIGURED:
+                fields.remove("whois_enabled")
             return fields
 
     OrganizationAdmin.save_on_top = True

openwisp_controller/config/apps.py

@@ -31,7 +31,7 @@
     vpn_peers_changed,
     vpn_server_modified,
 )
-from .who_is.handlers import connect_who_is_handlers
+from .whois.handlers import connect_whois_handlers
 
 # ensure Device.hardware_id field is not flagged as unique
 # (because it's flagged as unique_together with organization)
@@ -53,7 +53,7 @@ def ready(self, *args, **kwargs):
         self.register_dashboard_charts()
         self.register_menu_groups()
         self.notification_cache_update()
-        connect_who_is_handlers()
+        connect_whois_handlers()
 
     def __setmodels__(self):
         self.device_model = load_model("config", "Device")

openwisp_controller/config/base/device.py

@@ -19,7 +19,7 @@
     management_ip_changed,
 )
 from ..validators import device_name_validator, mac_address_validator
-from ..who_is.service import WhoIsService
+from ..whois.service import WhoIsService
 from .base import BaseModel
 
 
@@ -122,7 +122,7 @@ def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         # Initial value for last_ip is required in WhoIs
         # to remove WhoIs info related to that ip address.
-        if app_settings.WHO_IS_CONFIGURED:
+        if app_settings.WHOIS_CONFIGURED:
             self._changed_checked_fields.append("last_ip")
 
         self._set_initial_values_for_changed_checked_fields()
@@ -286,7 +286,7 @@ def save(self, *args, **kwargs):
                 self.key = self.generate_key(shared_secret)
         state_adding = self._state.adding
         super().save(*args, **kwargs)
-        if app_settings.WHO_IS_CONFIGURED:
+        if app_settings.WHOIS_CONFIGURED:
             self._check_last_ip()
         if state_adding and self.group and self.group.templates.exists():
             self.create_default_config()
@@ -379,9 +379,7 @@ def _check_last_ip(self):
         """Trigger WhoIs lookup if last_ip is not deferred."""
         if self._initial_last_ip == models.DEFERRED:
             return
-
-        self.who_is_service.trigger_who_is_lookup()
-
+        self.whois_service.trigger_whois_lookup()
         self._initial_last_ip = self.last_ip
 
     def _check_organization_id_changed(self):
@@ -423,7 +421,7 @@ def status(self):
         return self._get_config_attr("get_status_display")
 
     @cached_property
-    def who_is_service(self):
+    def whois_service(self):
         """
         Used as a shortcut to get WhoIsService instance
         for the device.

openwisp_controller/config/base/multitenancy.py

@@ -34,6 +34,11 @@ class AbstractOrganizationConfigSettings(UUIDModel):
         verbose_name=_("shared secret"),
         help_text=_("used for automatic registration of devices"),
     )
+    whois_enabled = FallbackBooleanChoiceField(
+        help_text=_("Whether the WhoIs lookup feature is enabled"),
+        fallback=app_settings.WHOIS_ENABLED,
+        verbose_name=_("WhoIs Enabled"),
+    )
     context = JSONField(
         blank=True,
         default=dict,
@@ -44,11 +49,6 @@ class AbstractOrganizationConfigSettings(UUIDModel):
         ),
         verbose_name=_("Configuration Variables"),
     )
-    who_is_enabled = FallbackBooleanChoiceField(
-        help_text=_("Whether the WhoIs lookup feature is enabled"),
-        fallback=app_settings.WHO_IS_ENABLED,
-        verbose_name=_("WhoIs Enabled"),
-    )
 
     class Meta:
         verbose_name = _("Configuration management settings")
@@ -62,12 +62,14 @@ def get_context(self):
         return deepcopy(self.context)
 
     def clean(self):
-        if not app_settings.WHO_IS_CONFIGURED and self.who_is_enabled:
+        if not app_settings.WHOIS_CONFIGURED and self.whois_enabled:
             raise ValidationError(
-                _(
-                    "GEOIP_ACCOUNT_ID and GEOIP_LICENSE_KEY must be set "
-                    + "before enabling WhoIs feature."
-                )
+                {
+                    "whois_enabled": _(
+                        "WHOIS_GEOIP_ACCOUNT and WHOIS_GEOIP_KEY must be set "
+                        + "before enabling WhoIs feature."
+                    )
+                }
             )
         return super().clean()
 

openwisp_controller/config/base/who_is.py renamed to openwisp_controller/config/base/whois.py

@@ -8,7 +8,7 @@
 
 from openwisp_utils.base import TimeStampedEditableModel
 
-from ..who_is.service import WhoIsService
+from ..whois.service import WhoIsService
 
 
 class AbstractWhoIsInfo(TimeStampedEditableModel):
@@ -51,7 +51,11 @@ class Meta:
     def clean(self):
         if ip_address(self.ip_address).is_private:
             raise ValidationError(
-                _("WhoIs information cannot be created for private IP addresses.")
+                {
+                    "ip_address": _(
+                        "WhoIs information cannot be created for private IP addresses."
+                    )
+                }
             )
         if self.cidr:
             try:
@@ -61,19 +65,19 @@ def clean(self):
                 ip_network(self.cidr, strict=False)
             except ValueError as e:
                 raise ValidationError(
-                    _("Invalid CIDR format: %(error)s") % {"error": str(e)}
+                    {"cidr": _("Invalid CIDR format: %(error)s") % {"error": str(e)}}
                 )
         return super().clean()
 
     @staticmethod
-    def device_who_is_info_delete_handler(instance, **kwargs):
+    def device_whois_info_delete_handler(instance, **kwargs):
         """
         Delete WhoIs information for a device when the last IP address is removed or
         when device is deleted.
         """
-        if instance._get_organization__config_settings().who_is_enabled:
+        if instance._get_organization__config_settings().whois_enabled:
             transaction.on_commit(
-                lambda: WhoIsService.delete_who_is_record.delay(instance.last_ip)
+                lambda: WhoIsService.delete_whois_record.delay(instance.last_ip)
             )
 
     # this method is kept here instead of in OrganizationConfigSettings because

openwisp_controller/config/migrations/0060_whoisinfo.py

@@ -82,7 +82,7 @@ class Migration(migrations.Migration):
             field=openwisp_utils.fields.FallbackBooleanChoiceField(
                 blank=True,
                 default=None,
-                fallback=app_settings.WHO_IS_ENABLED,
+                fallback=app_settings.WHOIS_ENABLED,
                 help_text="Whether WhoIs details lookup is enabled",
                 null=True,
                 verbose_name="WhoIs Enabled",

openwisp_controller/config/migrations/0062_rename_who_is_enabled_organizationconfigsettings_whois_enabled.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.2.1 on 2025-06-24 15:30
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("config", "0061_remove_whoisinfo_country_and_more"),
+    ]
+
+    operations = [
+        migrations.RenameField(
+            model_name="organizationconfigsettings",
+            old_name="who_is_enabled",
+            new_name="whois_enabled",
+        ),
+    ]