[feature] Implemented device deactivation and reactivation #625

.github/workflows/ci.yml

@@ -78,6 +78,7 @@ jobs:
         pip install -U pip wheel setuptools
         pip install -U -r requirements-test.txt
         pip install -U -e .
+        pip install -U --force-reinstall --no-deps https://github.com/openwisp/openwisp-utils/tarball/extendable-submit-line
         pip install ${{ matrix.django-version }}
 
     - name: QA checks

docs/developer/utils.rst

@@ -146,6 +146,43 @@ object are changed, but only on ``post_add`` or ``post_remove`` actions,
 ``post_clear`` is ignored for the same reason explained in the previous
 section.
 
+``config_deactivating``
+~~~~~~~~~~~~~~~~~~~~~~~
+
+**Path**: ``openwisp_controller.config.signals.config_deactivating``
+
+**Arguments**:
+
+- ``instance``: instance of the object being deactivated
+- ``previous_status``: previous status of the object before deactivation
+
+This signal is emitted when a configuration status of device is set to
+``deactivating``.
+
+``config_deactivated``
+~~~~~~~~~~~~~~~~~~~~~~
+
+**Path**: ``openwisp_controller.config.signals.config_deactivated``
+
+**Arguments**:
+
+- ``instance``: instance of the object being deactivated
+- ``previous_status``: previous status of the object before deactivation
+
+This signal is emitted when a configuration status of device is set to
+``deactivated``.
+
+``device_deactivated``
+~~~~~~~~~~~~~~~~~~~~~~
+
+**Path**: ``openwisp_controller.config.signals.device_deactivated``
+
+**Arguments**:
+
+- ``instance``: instance of the device being deactivated
+
+This signal is emitted when a device is deactivated.
+
 .. _config_backend_changed:
 
 ``config_backend_changed``

openwisp_controller/config/admin.py

@@ -19,7 +19,9 @@
 from django.template.loader import get_template
 from django.template.response import TemplateResponse
 from django.urls import path, re_path, reverse
+from django.utils.html import format_html, mark_safe
 from django.utils.translation import gettext_lazy as _
+from django.utils.translation import ngettext_lazy
 from flat_json_widget.widgets import FlatJsonWidget
 from import_export.admin import ImportExportMixin
 from openwisp_ipam.filters import SubnetFilter
@@ -73,6 +75,30 @@ class BaseAdmin(TimeReadonlyAdminMixin, ModelAdmin):
     history_latest_first = True
 
 
+class DeactivatedDeviceReadOnlyMixin(object):
+    def _has_permission(self, request, obj, perm):
+        if not obj or getattr(request, '_recover_view', False):
+            return perm
+        return perm and not obj.is_deactivated()
+
+    def has_add_permission(self, request, obj):
+        perm = super().has_add_permission(request, obj)
+        return self._has_permission(request, obj, perm)
+
+    def has_change_permission(self, request, obj=None):
+        perm = super().has_change_permission(request, obj)
+        return self._has_permission(request, obj, perm)
+
+    def has_delete_permission(self, request, obj=None):
+        perm = super().has_delete_permission(request, obj)
+        return self._has_permission(request, obj, perm)
+
+    def get_extra(self, request, obj=None, **kwargs):
+        if obj and obj.is_deactivated():
+            return 0
+        return super().get_extra(request, obj, **kwargs)
+
+
 class BaseConfigAdmin(BaseAdmin):
     change_form_template = 'admin/config/change_form.html'
     preview_template = None
@@ -390,6 +416,7 @@ class Meta(BaseForm.Meta):
 
 
 class ConfigInline(
+    DeactivatedDeviceReadOnlyMixin,
     MultitenantAdminMixin,
     TimeReadonlyAdminMixin,
     SystemDefinedVariableMixin,
@@ -452,6 +479,10 @@ def __init__(self, org_id, **kwargs):
 
 
 class DeviceAdmin(MultitenantAdminMixin, BaseConfigAdmin, UUIDAdmin):
+    change_form_template = 'admin/config/device/change_form.html'
+    delete_selected_confirmation_template = (
+        'admin/config/device/delete_selected_confirmation.html'
+    )
     list_display = [
         'name',
         'backend',
@@ -499,7 +530,12 @@ class DeviceAdmin(MultitenantAdminMixin, BaseConfigAdmin, UUIDAdmin):
     ]
     inlines = [ConfigInline]
     conditional_inlines = []
-    actions = ['change_group']
+    actions = [
+        'change_group',
+        'deactivate_device',
+        'activate_device',
+        'delete_selected',
+    ]
     org_position = 1 if not app_settings.HARDWARE_ID_ENABLED else 2
     list_display.insert(org_position, 'organization')
     _state_adding = False
@@ -520,6 +556,20 @@ class Media(BaseConfigAdmin.Media):
             f'{prefix}js/relevant_templates.js',
         ]
 
+    def has_change_permission(self, request, obj=None):
+        perm = super().has_change_permission(request)
+        if not obj or getattr(request, '_recover_view', False):
+            return perm
+        return perm and not obj.is_deactivated()
+
+    def has_delete_permission(self, request, obj=None):
+        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):
         self._state_adding = form.instance._state.adding
         return super().save_form(request, form, change)
@@ -624,6 +674,114 @@ def change_group(self, request, queryset):
             request, 'admin/config/change_device_group.html', context
         )
 
+    def _get_device_path(self, device):
+        app_label = self.opts.app_label
+        model_name = self.model._meta.model_name
+        return format_html(
+            '<a href="{}">{}</a>',
+            reverse(
+                f'admin:{app_label}_{model_name}_change',
+                args=[device.id],
+            ),
+            device,
+        )
+
+    _device_status_messages = {
+        'deactivate': {
+            messages.SUCCESS: ngettext_lazy(
+                'The device %(devices_html)s was deactivated successfully.',
+                (
+                    'The following devices were deactivated successfully:'
+                    ' %(devices_html)s.'
+                ),
+                'devices',
+            ),
+            messages.ERROR: ngettext_lazy(
+                'An error occurred while deactivating the device %(devices_html)s.',
+                (
+                    'An error occurred while deactivating the following devices:'
+                    ' %(devices_html)s.'
+                ),
+                'devices',
+            ),
+        },
+        'activate': {
+            messages.SUCCESS: ngettext_lazy(
+                'The device %(devices_html)s was activated successfully.',
+                'The following devices were activated successfully: %(devices_html)s.',
+                'devices',
+            ),
+            messages.ERROR: ngettext_lazy(
+                'An error occurred while activating the device %(devices_html)s.',
+                (
+                    'An error occurred while activating the following devices:'
+                    ' %(devices_html)s.'
+                ),
+                'devices',
+            ),
+        },
+    }
+
+    def _message_user_device_status(self, request, devices, method, message_level):
+        if not devices:
+            return
+        if len(devices) == 1:
+            devices_html = devices[0]
+        else:
+            devices_html = ', '.join(devices[:-1]) + ' and ' + devices[-1]
+        message = self._device_status_messages[method][message_level]
+        self.message_user(
+            request,
+            mark_safe(
+                message % {'devices_html': devices_html, 'devices': len(devices)}
+            ),
+            message_level,
+        )
+
+    def _change_device_status(self, request, queryset, method):
+        """
+        This helper method provides re-usability of code for
+        device activation and deactivation actions.
+        """
+        success_devices = []
+        error_devices = []
+        for device in queryset.iterator():
+            try:
+                getattr(device, method)()
+            except Exception:
+                error_devices.append(self._get_device_path(device))
+            else:
+                success_devices.append(self._get_device_path(device))
+        self._message_user_device_status(
+            request, success_devices, method, messages.SUCCESS
+        )
+        self._message_user_device_status(request, error_devices, method, messages.ERROR)
+
+    @admin.action(description=_('Deactivate selected devices'), permissions=['change'])
+    def deactivate_device(self, request, queryset):
+        self._change_device_status(request, queryset, 'deactivate')
+
+    @admin.action(description=_('Activate selected devices'), permissions=['change'])
+    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'],
+                [],
+            )
+        return super().get_deleted_objects(objs, request, *args, **kwargs)
+
     def get_fields(self, request, obj=None):
         """
         Do not show readonly fields in add form
@@ -642,7 +800,12 @@ def ip(self, obj):
     ip.short_description = _('IP address')
 
     def config_status(self, obj):
-        return obj.config.status
+        if obj._has_config():
+            return obj.config.status
+        # The device does not have a related config object
+        if obj.is_deactivated():
+            return _('deactivated')
+        return _('unknown')
 
     config_status.short_description = _('config status')
 
@@ -687,6 +850,35 @@ def get_urls(self):
 
     def get_extra_context(self, pk=None):
         ctx = super().get_extra_context(pk)
+        if pk:
+            device = self.model.objects.select_related('config').get(id=pk)
+            ctx.update(
+                {
+                    'show_deactivate': not device.is_deactivated(),
+                    'show_activate': device.is_deactivated(),
+                    'action_checkbox_name': helpers.ACTION_CHECKBOX_NAME,
+                }
+            )
+            if device.is_deactivated():
+                ctx['additional_buttons'].append(
+                    {
+                        'html': mark_safe(
+                            '<input class="default" type="submit"'
+                            f' value="{_("Activate")}" form="act_deact_device_form">'
+                        )
+                    }
+                )
+            else:
+                ctx['additional_buttons'].append(
+                    {
+                        'html': mark_safe(
+                            '<p class="deletelink-box">'
+                            '<input class="deletelink" type="submit"'
+                            f' value="{_("Deactivate")}" form="act_deact_device_form">'
+                            '</p>'
+                        )
+                    }
+                )
         ctx.update(
             {
                 'relevant_template_url': reverse(
@@ -704,6 +896,10 @@ def add_view(self, request, form_url='', extra_context=None):
         extra_context = self.get_extra_context()
         return super().add_view(request, form_url, extra_context)
 
+    def recover_view(self, request, version_id, extra_context=None):
+        request._recover_view = True
+        return super().recover_view(request, version_id, extra_context)
+
     def get_inlines(self, request, obj):
         inlines = super().get_inlines(request, obj)
         # this only makes sense in existing devices

openwisp_controller/config/api/serializers.py

@@ -249,6 +249,7 @@ class DeviceDetailConfigSerializer(BaseConfigSerializer):
 
 class DeviceDetailSerializer(DeviceConfigMixin, BaseSerializer):
     config = DeviceDetailConfigSerializer(allow_null=True)
+    is_deactivated = serializers.BooleanField(read_only=True)
 
     class Meta(BaseMeta):
         model = Device
@@ -261,6 +262,7 @@ class Meta(BaseMeta):
             'key',
             'last_ip',
             'management_ip',
+            'is_deactivated',
             'model',
             'os',
             'system',

openwisp_controller/config/api/urls.py

@@ -53,6 +53,16 @@ def get_api_urls(api_views):
                 api_views.device_detail,
                 name='device_detail',
             ),
+            path(
+                'controller/device/<str:pk>/activate/',
+                api_views.device_activate,
+                name='device_activate',
+            ),
+            path(
+                'controller/device/<str:pk>/deactivate/',
+                api_views.device_deactivate,
+                name='device_deactivate',
+            ),
             path(
                 'controller/group/',
                 api_views.devicegroup_list,