[feature] Added CopyableFieldsAdmin which generalize UUIDAdmin class #328

Closes #328

Author: Aryamanz29

openwisp_utils/admin.py

@@ -1,4 +1,5 @@
 from django.contrib.admin import ModelAdmin, StackedInline
+from django.core.exceptions import FieldError
 from django.urls import reverse
 from django.utils.translation import gettext_lazy as _
 
@@ -69,10 +70,10 @@ def has_changed(self):
         return super().has_changed()
 
 
-class UUIDAdmin(ModelAdmin):
+class UUIDAdmin(ModelAdmin):  # pragma: no cover
     """
     Defines a field name uuid whose value is that
-    of the id of the object
+    of the id of the object (deprecated)
     """
 
     def uuid(self, obj):
@@ -100,6 +101,77 @@ class Media:
     uuid.short_description = _('UUID')
 
 
+class CopyableFieldError(FieldError):
+    pass
+
+
+class CopyableFieldsAdmin(ModelAdmin):
+    """
+    An admin class that allows us to set read-only input fields
+    which makes admin fields easier and quicker to copy and paste.
+    """
+
+    copyable_fields = ()
+    change_form_template = 'admin/change_form.html'
+
+    def uuid(self, obj):
+        return obj.pk
+
+    def _check_copyable_subset_fields(self, copyable_fields, fields):
+        if not set(copyable_fields).issubset(fields):
+            class_name = self.__class__.__name__
+            raise CopyableFieldError(
+                (
+                    f'{copyable_fields} not in {class_name}.fields {fields}, '
+                    f'Check copyable_fields attribute of class {class_name}.'
+                )
+            )
+
+    def _process_copyable_fields(self, fields, request, obj):
+        fields = list(fields)
+        copyable_fields = list(self.copyable_fields)
+        self._check_copyable_subset_fields(copyable_fields, fields)
+        # if `uuid`` is in `copyable_fields` and the
+        # instance doesn't exist (i.e. in the case of "add_view")
+        # then we need to exclude it from model admin fields
+        if 'uuid' in copyable_fields and not obj:
+            fields.remove('uuid')
+        return tuple(fields)
+
+    def get_fields(self, request, obj=None):
+        fields = super().get_fields(request, obj)
+        return self._process_copyable_fields(fields, request, obj)
+
+    def get_readonly_fields(self, request, obj=None):
+        fields = super().get_readonly_fields(request, obj)
+        # model instance doesn't exist (i.e. in the case of "add_view")
+        if not obj:
+            return fields
+        # make sure `copyable_fields` is included `read_only` fields
+        return tuple([*fields, *self.copyable_fields])
+
+    def add_view(self, request, form_url='', extra_context=None):
+        extra_context = extra_context or {}
+        extra_context['copyable_fields'] = []
+        return super().add_view(
+            request,
+            form_url,
+            extra_context=extra_context,
+        )
+
+    def change_view(self, request, object_id, form_url='', extra_context=None):
+        extra_context = extra_context or {}
+        extra_context['copyable_fields'] = list(self.copyable_fields)
+        return super().change_view(
+            request,
+            object_id,
+            form_url,
+            extra_context=extra_context,
+        )
+
+    uuid.short_description = _('UUID')
+
+
 class ReceiveUrlAdmin(ModelAdmin):
     """
     Return a receive_url field whose value is that of

openwisp_utils/admin_theme/templates/admin/change_form.html

@@ -0,0 +1,24 @@
+{% extends "admin/change_form.html" %}
+{% block admin_change_form_document_ready %}
+{{ block.super }}
+<script>
+(function ($) {
+    $(document).ready(function () {
+        var copyableFields = {{ copyable_fields | safe }} || [];
+        
+        copyableFields.forEach(copyableField => {
+            
+            var copyableFieldContainer = $(`.field-${copyableField} .readonly`).eq(0);
+            
+            copyableFieldContainer.html(`<input readonly id="id_${copyableField}" type="text" 
+            class="vTextField readonly" value="${copyableFieldContainer.text()}">`);
+            
+            var copyableFieldSelectedId = $(`#id_${copyableField}`);
+            copyableFieldSelectedId.click(function () {
+                $(this).select();
+            });
+        })
+    })
+}) (django.jQuery);
+</script>    
+{% endblock %}

tests/test_project/admin.py

@@ -4,11 +4,11 @@
 from django.utils.translation import gettext_lazy as _
 from openwisp_utils.admin import (
     AlwaysHasChangedMixin,
+    CopyableFieldsAdmin,
     HelpTextStackedInline,
     ReadOnlyAdmin,
     ReceiveUrlAdmin,
     TimeReadonlyAdminMixin,
-    UUIDAdmin,
 )
 from openwisp_utils.admin_theme.filters import (
     AutocompleteFilter,
@@ -73,12 +73,13 @@ class OperatorInline(HelpTextStackedInline):
 
 
 @admin.register(Project)
-class ProjectAdmin(UUIDAdmin, ReceiveUrlAdmin):
+class ProjectAdmin(CopyableFieldsAdmin, ReceiveUrlAdmin):
     inlines = [OperatorInline]
     list_display = ('name',)
     fields = ('uuid', 'name', 'key', 'receive_url')
-    readonly_fields = ('uuid', 'receive_url')
+    readonly_fields = ('receive_url',)
     receive_url_name = 'receive_project'
+    copyable_fields = ('uuid',)
 
 
 class ShelfFilter(SimpleInputFilter):

tests/test_project/tests/test_admin.py

@@ -6,7 +6,7 @@
 from django.core.exceptions import ImproperlyConfigured
 from django.test import TestCase
 from django.urls import reverse
-from openwisp_utils.admin import ReadOnlyAdmin
+from openwisp_utils.admin import CopyableFieldError, ReadOnlyAdmin
 from openwisp_utils.admin_theme import settings as admin_theme_settings
 from openwisp_utils.admin_theme.apps import OpenWispAdminThemeConfig, _staticfy
 from openwisp_utils.admin_theme.checks import admin_theme_settings_checks
@@ -204,6 +204,15 @@ def test_uuid_field_in_add(self):
         self.assertNotContains(response, 'field-uuid')
         self.assertContains(response, 'field-receive_url')
 
+    def test_invalid_copyable_field_error(self):
+        project = Project.objects.create(name='test_invalid_copyable_field_error')
+        ma = ProjectAdmin(Project, self.site)
+        copyable_field_err = "['invalid_field'] not in ProjectAdmin.fields"
+        ma.copyable_fields = ('invalid_field',)
+        with self.assertRaises(CopyableFieldError) as err:
+            ma.get_fields(self.client.request, project)
+        self.assertIn(copyable_field_err, err.exception.args[0])
+
     def test_receive_url_admin(self):
         p = Project.objects.create(name='test_receive_url_admin_project')
         ma = ProjectAdmin(Project, self.site)