openwisp-controller 1.1__tar.gz → 1.1.2__tar.gz

{openwisp_controller-1.1 → openwisp_controller-1.1.2}/CHANGES.rst

@@ -1,6 +1,58 @@
 Changelog
 =========
 
+Version 1.1.2 [2025-08-01]
+--------------------------
+
+Bugfixes
+~~~~~~~~
+
+- Fixed `compatibility of OpenWrt.update_config with openwisp-config >=
+  1.1.0 <https://github.com/openwisp/openwisp-controller/issues/964>`__.
+- Fixed `VPN-client template switch issue when switching between VPN
+  servers with the same address
+  <https://github.com/openwisp/openwisp-controller/issues/973>`__.
+- Fixed `missing config_changed signal when reverting a template
+  <https://github.com/openwisp/openwisp-controller/issues/836>`__.
+- Fixed `Zerotier network name being set to "ow_zt" instead of "global"
+  <https://github.com/openwisp/openwisp-controller/issues/982>`__.
+- Fixed error in preview when device has no name set.
+- Fixed live updates for "Send commands" when multiple websocket
+  connections are open for the same device.
+- Limited command results in the device admin to 30 entries to avoid
+  loading issues.
+- Fixed uncaught exception in ``leaflet.draw.i18n.js``.
+- Fixed `handling of devices without a DeviceConnection when creating
+  commands
+  <https://github.com/openwisp/openwisp-controller/issues/1016>`__.
+- Prevented `adding multiple VPN client templates pointing to the same VPN
+  server <https://github.com/openwisp/openwisp-controller/issues/832>`__.
+- Fixed timeout issues in VPN checksum and download configuration views
+  for large VPN setups (e.g., 2000+ WireGuard peers) by caching the
+  checksum and generated configuration.
+- Fixed an issue where enforcing required templates was accidentally
+  deleting `VpnClient` objects, causing them to be recreated whenever
+  device templates were modified in the Django admin.
+- Fixed ``HTTP 500 Server Error`` when geographic REST API endpoints
+  receive a malformed resource ID.
+
+Version 1.1.1 [2025-01-31]
+--------------------------
+
+Bugfixes
+~~~~~~~~
+
+- Fixed `recovering deleted device with related location
+  <https://github.com/openwisp/openwisp-controller/issues/936>`__.
+- Fixed `deleting device with "deactivating" config status
+  <https://github.com/openwisp/openwisp-controller/issues/949>`__.
+- Fixed `conversion of MAC address to uppercase format
+  <https://github.com/openwisp/openwisp-controller/issues/922>`__ with the
+  openwisp-config agent.
+- Fixed `updating templates with invalid configurations to prevent
+  ValidationError due to cache invalidation mechanism
+  <https://github.com/openwisp/openwisp-controller/pull/948>`__.
+
 Version 1.1.0 [2024-11-22]
 --------------------------
 
@@ -8,14 +60,14 @@ Features
 ~~~~~~~~
 
 - Added `support for ZeroTier
-  <https://openwisp.io/docs/dev/controller/user/zerotier.html>`_.
+  <https://openwisp.io/docs/stable/controller/user/zerotier.html>`_.
 - Added support for adding `configuration templates
-  <https://openwisp.io/docs/dev/controller/user/device-groups.html#group-templates>`_
+  <https://openwisp.io/docs/stable/controller/user/device-groups.html#group-templates>`_
   and `configuration variables
-  <https://openwisp.io/docs/dev/controller/user/device-groups.html#group-configuration-variables>`_
+  <https://openwisp.io/docs/stable/controller/user/device-groups.html#group-configuration-variables>`_
   to device groups.
 - Implemented support for `SNMP credentials
-  <https://openwisp.io/docs/dev/controller/user/intro.html#snmp>`_.
+  <https://openwisp.io/docs/stable/controller/user/intro.html#snmp>`_.
 - Added support for device deactivation and reactivation.
 - Introduced an admin action to quickly move devices between groups.
 - Added autocomplete support for filters in the admin interface.
@@ -23,13 +75,13 @@ Features
   config agent.
 - Enabled filtering of subnets by Subnet Division Rule type.
 - Allowed `limiting the number of devices per organization
-  <https://openwisp.io/docs/dev/controller/user/organization-limits.html>`_.
+  <https://openwisp.io/docs/stable/controller/user/organization-limits.html>`_.
 - Added support for defining organization-level variables.
 - Enabled `bulk import and export of devices
-  <https://openwisp.io/docs/dev/controller/user/import-export.html>`_.
+  <https://openwisp.io/docs/stable/controller/user/import-export.html>`_.
 - Added `functionality to configure available commands for each
   organization
-  <https://openwisp.io/docs/dev/controller/user/settings.html#openwisp-controller-organization-enabled-commands>`_.
+  <https://openwisp.io/docs/stable/controller/user/settings.html#openwisp-controller-organization-enabled-commands>`_.
 - Added a dashboard chart showing the distribution of devices across
   different groups.
 - Added filters to the REST API.

{openwisp_controller-1.1/openwisp_controller.egg-info → openwisp_controller-1.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: openwisp-controller
-Version: 1.1
+Version: 1.1.2
 Summary: OpenWISP Controller
 Home-page: http://openwisp.org
 Download-URL: https://github.com/openwisp/openwisp-controller/releases
@@ -37,6 +37,18 @@ Requires-Dist: django-cache-memoize~=0.2.0
 Requires-Dist: shortuuid~=1.0.13
 Requires-Dist: netaddr~=1.3.0
 Requires-Dist: django-import-export~=3.3.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: download-url
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: platform
+Dynamic: requires-dist
+Dynamic: summary
 
 openwisp-controller
 ===================
@@ -89,30 +101,31 @@ built on top of its building blocks.
 
 Other popular building blocks that are part of the OpenWISP ecosystem are:
 
-- `openwisp-monitoring <https://openwisp.io/docs/dev/monitoring/>`_:
+- `openwisp-monitoring <https://openwisp.io/docs/stable/monitoring/>`_:
   provides device status monitoring, collection of metrics, charts,
   alerts, possibility to define custom checks
 - `openwisp-firmware-upgrader
-  <https://openwisp.io/docs/dev/firmware-upgrader/>`_: automated firmware
-  upgrades (single devices or mass network upgrades)
-- `openwisp-radius <https://openwisp.io/docs/dev/user/radius.html>`_:
-  based on FreeRADIUS, allows to implement network access authentication
-  systems like 802.1x WPA2 Enterprise, captive portal authentication,
-  Hotspot 2.0 (802.11u)
+  <https://openwisp.io/docs/stable/firmware-upgrader/>`_: automated
+  firmware upgrades (single devices or mass network upgrades)
+- `openwisp-radius <https://openwisp.io/docs/stable/radius/>`_: based on
+  FreeRADIUS, allows to implement network access authentication systems
+  like 802.1x WPA2 Enterprise, captive portal authentication, Hotspot 2.0
+  (802.11u)
 - `openwisp-network-topology
-  <https://openwisp.io/docs/dev/network-topology/>`_: provides way to
+  <https://openwisp.io/docs/stable/network-topology/>`_: provides way to
   collect and visualize network topology data from dynamic mesh routing
   daemons or other network software (e.g.: OpenVPN); it can be used in
   conjunction with openwisp-monitoring to get a better idea of the state
   of the network
-- `openwisp-ipam <https://openwisp.io/docs/dev/ipam/>`_: allows to manage
-  the assignment of IP addresses used in the network
-- `openwisp-notifications <https://openwisp.io/docs/dev/notifications/>`_:
-  allows users to be aware of important events happening in the network.
+- `openwisp-ipam <https://openwisp.io/docs/stable/ipam/>`_: allows to
+  manage the assignment of IP addresses used in the network
+- `openwisp-notifications
+  <https://openwisp.io/docs/stable/notifications/>`_: allows users to be
+  aware of important events happening in the network.
 
 **For a more complete overview of the OpenWISP modules and architecture**,
 see the `OpenWISP Architecture Overview
-<https://openwisp.io/docs/dev/general/architecture.html>`_.
+<https://openwisp.io/docs/stable/general/architecture.html>`_.
 
 .. image:: https://raw.githubusercontent.com/openwisp/openwisp2-docs/master/assets/design/openwisp-logo-black.svg
     :target: http://openwisp.org
@@ -121,9 +134,9 @@ see the `OpenWISP Architecture Overview
 Documentation
 -------------
 
-- `Usage documentation <https://openwisp.io/docs/dev/controller/>`_
+- `Usage documentation <https://openwisp.io/docs/stable/controller/>`_
 - `Developer documentation
-  <https://openwisp.io/docs/dev/controller/developer/>`_
+  <https://openwisp.io/docs/stable/controller/developer/>`_
 
 Contributing
 ------------

{openwisp_controller-1.1 → openwisp_controller-1.1.2}/README.rst

@@ -49,30 +49,31 @@ built on top of its building blocks.
 
 Other popular building blocks that are part of the OpenWISP ecosystem are:
 
-- `openwisp-monitoring <https://openwisp.io/docs/dev/monitoring/>`_:
+- `openwisp-monitoring <https://openwisp.io/docs/stable/monitoring/>`_:
   provides device status monitoring, collection of metrics, charts,
   alerts, possibility to define custom checks
 - `openwisp-firmware-upgrader
-  <https://openwisp.io/docs/dev/firmware-upgrader/>`_: automated firmware
-  upgrades (single devices or mass network upgrades)
-- `openwisp-radius <https://openwisp.io/docs/dev/user/radius.html>`_:
-  based on FreeRADIUS, allows to implement network access authentication
-  systems like 802.1x WPA2 Enterprise, captive portal authentication,
-  Hotspot 2.0 (802.11u)
+  <https://openwisp.io/docs/stable/firmware-upgrader/>`_: automated
+  firmware upgrades (single devices or mass network upgrades)
+- `openwisp-radius <https://openwisp.io/docs/stable/radius/>`_: based on
+  FreeRADIUS, allows to implement network access authentication systems
+  like 802.1x WPA2 Enterprise, captive portal authentication, Hotspot 2.0
+  (802.11u)
 - `openwisp-network-topology
-  <https://openwisp.io/docs/dev/network-topology/>`_: provides way to
+  <https://openwisp.io/docs/stable/network-topology/>`_: provides way to
   collect and visualize network topology data from dynamic mesh routing
   daemons or other network software (e.g.: OpenVPN); it can be used in
   conjunction with openwisp-monitoring to get a better idea of the state
   of the network
-- `openwisp-ipam <https://openwisp.io/docs/dev/ipam/>`_: allows to manage
-  the assignment of IP addresses used in the network
-- `openwisp-notifications <https://openwisp.io/docs/dev/notifications/>`_:
-  allows users to be aware of important events happening in the network.
+- `openwisp-ipam <https://openwisp.io/docs/stable/ipam/>`_: allows to
+  manage the assignment of IP addresses used in the network
+- `openwisp-notifications
+  <https://openwisp.io/docs/stable/notifications/>`_: allows users to be
+  aware of important events happening in the network.
 
 **For a more complete overview of the OpenWISP modules and architecture**,
 see the `OpenWISP Architecture Overview
-<https://openwisp.io/docs/dev/general/architecture.html>`_.
+<https://openwisp.io/docs/stable/general/architecture.html>`_.
 
 .. image:: https://raw.githubusercontent.com/openwisp/openwisp2-docs/master/assets/design/openwisp-logo-black.svg
     :target: http://openwisp.org
@@ -81,9 +82,9 @@ see the `OpenWISP Architecture Overview
 Documentation
 -------------
 
-- `Usage documentation <https://openwisp.io/docs/dev/controller/>`_
+- `Usage documentation <https://openwisp.io/docs/stable/controller/>`_
 - `Developer documentation
-  <https://openwisp.io/docs/dev/controller/developer/>`_
+  <https://openwisp.io/docs/stable/controller/developer/>`_
 
 Contributing
 ------------

{openwisp_controller-1.1 → openwisp_controller-1.1.2}/openwisp_controller/__init__.py

@@ -1,4 +1,4 @@
-VERSION = (1, 1, 0, 'final')
+VERSION = (1, 1, 2, 'final')
 __version__ = VERSION  # alias
 
 

{openwisp_controller-1.1 → openwisp_controller-1.1.2}/openwisp_controller/config/admin.py

@@ -1,11 +1,13 @@
 import json
 import logging
+from collections.abc import Iterable
 
 import reversion
 from django import forms
 from django.conf import settings
 from django.contrib import admin, messages
 from django.contrib.admin import helpers
+from django.contrib.admin.actions import delete_selected
 from django.contrib.admin.models import ADDITION, LogEntry
 from django.contrib.contenttypes.models import ContentType
 from django.core.exceptions import (
@@ -309,7 +311,8 @@ class BaseConfigAdmin(BaseAdmin):
             config = instance.config
         else:
             raise Http404()
-        config_archive = config.generate()
+        get_configuration = getattr(config, "get_cached_configuration", config.generate)
+        config_archive = get_configuration()
         return send_file(
             filename='{0}.tar.gz'.format(config.name),
             contents=config_archive.getvalue(),
@@ -566,8 +569,6 @@ class DeviceAdmin(MultitenantAdminMixin, BaseConfigAdmin, UUIDAdmin):
         perm = super().has_delete_permission(request)
         if not obj:
             return perm
-        if obj._has_config():
-            perm = perm and obj.config.is_deactivated()
         return perm and obj.is_deactivated()
 
     def save_form(self, request, form, change):
@@ -765,22 +766,42 @@ class DeviceAdmin(MultitenantAdminMixin, BaseConfigAdmin, UUIDAdmin):
     def activate_device(self, request, queryset):
         self._change_device_status(request, queryset, 'activate')
 
-    def get_deleted_objects(self, objs, request, *args, **kwargs):
-        # Ensure that all selected devices can be deleted, i.e.
-        # the device should be flagged as deactivated and if it has
-        # a config object, it's status should be "deactivated".
-        active_devices = []
-        for obj in objs:
-            if not self.has_delete_permission(request, obj):
-                active_devices.append(obj)
-        if active_devices:
-            return (
-                active_devices,
-                {self.model._meta.verbose_name_plural: len(active_devices)},
-                ['active_devices'],
-                [],
+    @admin.action(description=delete_selected.short_description, permissions=['delete'])
+    def delete_selected(self, request, queryset):
+        response = delete_selected(self, request, queryset)
+        if not response:
+            return response
+        if 'active_devices' in response.context_data.get('perms_lacking', {}):
+            active_devices = []
+            for device in queryset.iterator():
+                if not device.is_deactivated() or (
+                    device._has_config() and not device.config.is_deactivated()
+                ):
+                    active_devices.append(self._get_device_path(device))
+            response.context_data.update(
+                {
+                    'active_devices': active_devices,
+                    'perms_lacking': set(),
+                    'title': _('Are you sure?'),
+                }
             )
-        return super().get_deleted_objects(objs, request, *args, **kwargs)
+        return response
+
+    def get_deleted_objects(self, objs, request, *args, **kwargs):
+        to_delete, model_count, perms_needed, protected = super().get_deleted_objects(
+            objs, request, *args, **kwargs
+        )
+        if (
+            isinstance(perms_needed, Iterable)
+            and len(perms_needed) == 1
+            and list(perms_needed)[0] == self.model._meta.verbose_name
+            and objs.filter(_is_deactivated=False).exists()
+        ):
+            if request.POST.get("post"):
+                perms_needed = set()
+            else:
+                perms_needed = {'active_devices'}
+        return to_delete, model_count, perms_needed, protected
 
     def get_fields(self, request, obj=None):
         """
@@ -900,6 +921,17 @@ class DeviceAdmin(MultitenantAdminMixin, BaseConfigAdmin, UUIDAdmin):
         request._recover_view = True
         return super().recover_view(request, version_id, extra_context)
 
+    def delete_view(self, request, object_id, extra_context=None):
+        extra_context = extra_context or {}
+        obj = self.get_object(request, object_id)
+        if obj and obj._has_config() and not obj.config.is_deactivated():
+            extra_context['deactivating_warning'] = True
+        return super().delete_view(request, object_id, extra_context)
+
+    def delete_model(self, request, obj):
+        force_delete = request.POST.get('force_delete') == 'true'
+        obj.delete(check_deactivated=not force_delete)
+
     def get_inlines(self, request, obj):
         inlines = super().get_inlines(request, obj)
         # this only makes sense in existing devices

{openwisp_controller-1.1 → openwisp_controller-1.1.2}/openwisp_controller/config/api/views.py

@@ -107,6 +107,10 @@ class DeviceDetailView(ProtectedAPIMixin, RetrieveUpdateDestroyAPIView):
     queryset = Device.objects.select_related('config', 'group', 'organization')
     permission_classes = ProtectedAPIMixin.permission_classes + (DevicePermission,)
 
+    def perform_destroy(self, instance):
+        force_deletion = self.request.query_params.get('force', None) == 'true'
+        instance.delete(check_deactivated=(not force_deletion))
+
 
 class DeviceActivateView(ProtectedAPIMixin, GenericAPIView):
     serializer_class = serializers.Serializer

{openwisp_controller-1.1 → openwisp_controller-1.1.2}/openwisp_controller/config/apps.py

@@ -55,6 +55,7 @@ class ConfigConfig(AppConfig):
 
     def __setmodels__(self):
         self.device_model = load_model('config', 'Device')
+        self.template_model = load_model('config', 'Template')
         self.devicegroup_model = load_model('config', 'DeviceGroup')
         self.config_model = load_model('config', 'Config')
         self.vpn_model = load_model('config', 'Vpn')
@@ -135,11 +136,21 @@ class ConfigConfig(AppConfig):
             sender=self.config_model,
             dispatch_uid='devicegroup_templates_change_handler.backend_changed',
         )
+        pre_save.connect(
+            self.template_model.pre_save_handler,
+            sender=self.template_model,
+            dispatch_uid='template_pre_save_handler',
+        )
         pre_save.connect(
             handlers.organization_disabled_handler,
             sender=self.org_model,
             dispatch_uid='organization_disabled_pre_save_clear_device_checksum_cache',
         )
+        post_save.connect(
+            self.template_model.post_save_handler,
+            sender=self.template_model,
+            dispatch_uid='template_post_save_handler',
+        )
         post_save.connect(
             self.org_limits.post_save_handler,
             sender=self.org_model,
@@ -294,7 +305,7 @@ class ConfigConfig(AppConfig):
         Triggers the cache invalidation for the
         device config checksum (view and model method)
         """
-        from .controller.views import DeviceChecksumView
+        from .controller.views import DeviceChecksumView, GetVpnView
         from .handlers import (
             device_cache_invalidation_handler,
             devicegroup_change_handler,
@@ -323,6 +334,21 @@ class ConfigConfig(AppConfig):
             DeviceChecksumView.invalidate_checksum_cache,
             dispatch_uid='invalidate_checksum_cache',
         )
+        # VPN cache invalidation
+        post_save.connect(
+            GetVpnView.invalidate_get_vpn_cache,
+            sender=self.vpn_model,
+            dispatch_uid="invalidate_get_vpn_cache",
+        )
+        pre_delete.connect(
+            GetVpnView.invalidate_get_vpn_cache,
+            sender=self.vpn_model,
+            dispatch_uid="vpn_server_pre_delete_invalidate_get_vpn_cache",
+        )
+        vpn_server_modified.connect(
+            GetVpnView.invalidate_get_vpn_cache,
+            dispatch_uid="vpn_server_modified_invalidate_get_vpn_cache",
+        )
         device_group_changed.connect(
             devicegroup_change_handler,
             sender=self.device_model,

{openwisp_controller-1.1 → openwisp_controller-1.1.2}/openwisp_controller/config/base/base.py

@@ -1,8 +1,10 @@
 import collections
 import hashlib
 import json
+import logging
 from copy import deepcopy
 
+from cache_memoize import cache_memoize
 from django.core.exceptions import ValidationError
 from django.db import models
 from django.utils.functional import cached_property
@@ -15,6 +17,82 @@ from openwisp_utils.base import TimeStampedEditableModel
 
 from .. import settings as app_settings
 
+logger = logging.getLogger(__name__)
+
+
+def get_cached_args_rewrite(instance):
+    """
+    Use only the PK parameter for calculating the cache key
+    """
+    return instance.pk.hex
+
+
+class ChecksumCacheMixin:
+    """
+    Mixin that provides caching for checksum.
+    """
+
+    _CHECKSUM_CACHE_TIMEOUT = 60 * 60 * 24 * 30  # 30 days
+
+    @cache_memoize(
+        timeout=_CHECKSUM_CACHE_TIMEOUT, args_rewrite=get_cached_args_rewrite
+    )
+    def get_cached_checksum(self):
+        """
+        Handles caching,
+        timeout=None means value is cached indefinitely
+        (invalidation handled on post_save/post_delete signal)
+        """
+        logger.debug(f"calculating checksum for {self.__class__.__name__} ID {self.pk}")
+        return self.checksum
+
+    @classmethod
+    def bulk_invalidate_get_cached_checksum(cls, query_params):
+        """
+        Bulk invalidate checksum cache for multiple instances
+        """
+        for instance in cls.objects.only("id").filter(**query_params).iterator():
+            instance.get_cached_checksum.invalidate(instance)
+
+    def invalidate_checksum_cache(self):
+        """
+        Invalidate the checksum cache for this instance
+        """
+        self.get_cached_checksum.invalidate(self)
+        logger.debug(
+            f"invalidated checksum cache for {self.__class__.__name__} ID {self.pk}"
+        )
+
+
+class ConfigChecksumCacheMixin(ChecksumCacheMixin):
+    """
+    Mixin that provides caching for both checksum and configuration.
+    """
+
+    @cache_memoize(
+        timeout=ChecksumCacheMixin._CHECKSUM_CACHE_TIMEOUT,
+        args_rewrite=get_cached_args_rewrite,
+    )
+    def get_cached_configuration(self):
+        """
+        Returns cached configuration
+        """
+        return self.generate()
+
+    def invalidate_configuration_cache(self):
+        """
+        Invalidate the configuration cache for this instance
+        """
+        self.get_cached_configuration.invalidate(self)
+        logger.debug(
+            f"invalidated configuration cache for {self.__class__.__name__}"
+            f" ID {self.pk}"
+        )
+
+    def invalidate_checksum_cache(self):
+        super().invalidate_checksum_cache()
+        self.invalidate_configuration_cache()
+
 
 class BaseModel(TimeStampedEditableModel):
     """
@@ -89,7 +167,7 @@ class BaseConfig(BaseModel):
             return config
         c = deepcopy(config)
         is_config = not any([self.__template__, self.__vpn__])
-        if 'hostname' not in c.get('general', {}) and is_config:
+        if all(('hostname' not in c.get('general', {}), is_config, self.name)):
             c.setdefault('general', {})
             c['general']['hostname'] = self.name.replace(':', '-')
         return c