Add UDF to study and endpoint forms

hawc/apps/assessment/models.py

@@ -10,6 +10,7 @@
 from django.contrib.contenttypes.fields import GenericForeignKey
 from django.contrib.contenttypes.models import ContentType
 from django.core.cache import cache
+from django.core.exceptions import ObjectDoesNotExist
 from django.core.validators import MinValueValidator
 from django.db import models
 from django.http import HttpRequest
@@ -314,6 +315,19 @@ def get_assessment_logs_url(self):
     def get_udf_list_url(self):
         return reverse("udf:binding-list", args=(self.id,))
 
+    def get_model_udf(self, model: type[models.Model] | models.Model, *args, **kwargs):
+        """Get the form instance from this assessment's UDF for the given model class/instance.
+
+        Args:
+            model: a model class or an instance of a model that has a UDF bound to it in this
+            assessment.
+        """
+        content_type = ContentType.objects.get_for_model(model)
+        try:
+            return self.udf_bindings.get(content_type=content_type).form_instance(*args, **kwargs)
+        except ObjectDoesNotExist:
+            return None
+
     def get_clear_cache_url(self):
         return reverse("assessment:clear_cache", args=(self.id,))
 

hawc/apps/common/dynamic_forms/forms.py

@@ -90,35 +90,3 @@ def auto_wrap_fields(self):
 
         self[:].wrap_together(cfl.Row)
         self.add_field_wraps()
-
-
-class DynamicFormWidget(forms.Widget):
-    """Widget to display dynamic form inline."""
-
-    template_name = "common/widgets/dynamic_form.html"
-
-    def __init__(self, prefix, form_class, form_kwargs=None, *args, **kwargs):
-        """Create dynamic form widget."""
-        super().__init__(*args, **kwargs)
-        self.prefix = prefix
-        self.form_class = form_class
-        if form_kwargs is None:
-            form_kwargs = {}
-        self.form_kwargs = {"prefix": prefix, **form_kwargs}
-
-    def add_prefix(self, field_name):
-        """Add prefix in the same way Django forms add prefixes."""
-        return f"{self.prefix}-{field_name}"
-
-    def format_value(self, value):
-        """Value used in rendering."""
-        value = json.loads(value)
-        if value:
-            value = {self.add_prefix(k): v for k, v in value.items()}
-        return self.form_class(data=value, **self.form_kwargs)
-
-    def value_from_datadict(self, data, files, name):
-        """Parse value from POST request."""
-        form = self.form_class(data=data, **self.form_kwargs)
-        form.full_clean()
-        return form.cleaned_data

hawc/apps/study/forms.py

@@ -46,11 +46,16 @@ def __init__(self, *args, **kwargs):
             self.instance.assessment = parent
         elif type(parent) is Reference:
             self.instance.reference_ptr = parent
+        assessment = self.instance.get_assessment()
+        udf = assessment.get_model_udf(self.Meta.model, label="User defined fields")
+        if udf:
+            self.fields["udf"] = udf
         if self.instance:
             self.fields["internal_communications"].initial = self.instance.get_communications()
 
         self.helper = self.setHelper()
 
+    # TODO: For some reason, form actions div is being 'pushed' outside the form tag
     def setHelper(self, inputs: dict | None = None):
         if inputs is None:
             inputs = {}

hawc/apps/study/templates/study/study_detail.html

@@ -133,6 +133,10 @@ <h3>{{assessment.get_rob_name_display}}</h3>
       {% include "eco/fragments/_design_list.html" with object_list=object.eco_designs.all %}
     {% endif %}
 
+    {% if udf_content %}
+      {% include "udf/fragments/_udf_content.html" with object=udf_content %}
+    {% endif %}
+
   {% endif %}
 
 {% endblock %}

hawc/apps/study/views.py

@@ -1,5 +1,6 @@
 from django.apps import apps
-from django.core.exceptions import PermissionDenied
+from django.contrib.contenttypes.models import ContentType
+from django.core.exceptions import PermissionDenied, ObjectDoesNotExist
 from django.db import transaction
 from django.http import HttpResponseRedirect
 from django.shortcuts import get_object_or_404, redirect
@@ -128,6 +129,12 @@ def get_context_data(self, **kwargs):
             "attachments": self.object.get_attachments_dict() if attachments_viewable else None,
         }
         context["internal_communications"] = self.object.get_communications()
+        content_type = ContentType.objects.get_for_model(self.model)
+        try:
+            udf_binding = self.assessment.udf_bindings.get(content_type=content_type)
+            context["udf_content"] = udf_binding.saved_contents.get(object_id=self.object.pk)
+        except ObjectDoesNotExist:
+            context["udf_content"] = None
         return context
 
 

hawc/apps/udf/admin.py

@@ -18,6 +18,12 @@ class TagBindingInline(admin.TabularInline):
     extra = 0
 
 
+class ModelUDFContentInline(admin.TabularInline):
+    model = models.ModelUDFContent
+    extra = 0
+
+
 admin.site.register(models.UserDefinedForm)
 admin.site.register(models.ModelBinding)
 admin.site.register(models.TagBinding)
+admin.site.register(models.ModelUDFContent)

hawc/apps/udf/migrations/0003_modeludfcontent.py

@@ -0,0 +1,43 @@
+# Generated by Django 4.2.4 on 2023-09-27 20:58
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("contenttypes", "0002_remove_content_type_name"),
+        ("udf", "0002_tagbinding_modelbinding"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="ModelUDFContent",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True, primary_key=True, serialize=False, verbose_name="ID"
+                    ),
+                ),
+                ("object_id", models.PositiveIntegerField(null=True)),
+                ("content", models.JSONField(blank=True, default=dict)),
+                ("created", models.DateTimeField(auto_now_add=True)),
+                ("last_updated", models.DateTimeField(auto_now=True)),
+                (
+                    "content_type",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE, to="contenttypes.contenttype"
+                    ),
+                ),
+                (
+                    "model_binding",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="saved_contents",
+                        to="udf.modelbinding",
+                    ),
+                ),
+            ],
+        ),
+    ]

hawc/apps/udf/models.py

@@ -1,12 +1,14 @@
 import reversion
 from django.conf import settings
+from django.contrib.contenttypes.fields import GenericForeignKey
 from django.contrib.contenttypes.models import ContentType
 from django.db import models
-from django.forms import Form
+from django.forms import JSONField
 from django.urls import reverse
 
 from ..assessment.models import Assessment
 from ..common import dynamic_forms
+from ..common.forms import DynamicFormField
 from ..lit.models import ReferenceFilterTag
 
 
@@ -33,6 +35,9 @@ class Meta:
         unique_together = (("creator", "name"),)
         ordering = ("-last_updated",)
 
+    def __str__(self):
+        return f"{self.name}"
+
     def get_absolute_url(self):
         return reverse("udf:udf_detail", args=(self.pk,))
 
@@ -58,8 +63,15 @@ class Meta:
         indexes = (models.Index(fields=["assessment", "content_type"]),)
         unique_together = (("assessment", "content_type"),)
 
-    def form_instance(self) -> Form:
-        return dynamic_forms.Schema.parse_obj(self.form.schema).to_form()
+    def __str__(self):
+        return f"{self.assessment}/{self.content_type.model} form"
+
+    def form_instance(self, *args, **kwargs) -> JSONField | DynamicFormField:
+        prefix = kwargs.pop("prefix", "udf")
+        form_kwargs = kwargs.pop("form_kwargs", None)
+        return dynamic_forms.Schema.parse_obj(self.form.schema).to_form_field(
+            prefix, form_kwargs, *args, **kwargs
+        )
 
     def get_assessment(self):
         return self.assessment
@@ -86,8 +98,12 @@ class Meta:
         indexes = (models.Index(fields=["assessment", "tag"]),)
         unique_together = (("assessment", "tag"),)
 
-    def form_instance(self) -> Form:
-        return dynamic_forms.Schema.parse_obj(self.form.schema).to_form()
+    def form_instance(
+        self, prefix="", form_kwargs=None, *args, **kwargs
+    ) -> JSONField | DynamicFormField:
+        return dynamic_forms.Schema.parse_obj(self.form.schema).to_form_field(
+            prefix, form_kwargs, *args, **kwargs
+        )
 
     def get_assessment(self):
         return self.assessment
@@ -96,6 +112,43 @@ def get_absolute_url(self):
         return reverse("udf:tag_detail", args=(self.id,))
 
 
+class ModelUDFContent(models.Model):
+    model_binding = models.ForeignKey(
+        ModelBinding, on_delete=models.CASCADE, related_name="saved_contents"
+    )
+    content_type = models.ForeignKey(ContentType, on_delete=models.CASCADE)
+    object_id = models.PositiveIntegerField(null=True)
+    content_object = GenericForeignKey(
+        "content_type",
+        "object_id",
+    )
+    content = models.JSONField(blank=True, default=dict)
+    created = models.DateTimeField(auto_now_add=True)
+    last_updated = models.DateTimeField(auto_now=True)
+
+    def get_content_as_list(self):
+        schema = dynamic_forms.Schema.parse_obj(self.model_binding.form.schema)
+
+        items = []
+        for field in schema.fields:
+            field_value = self.content.get(field.name)
+            field_kwargs = field.get_form_field_kwargs()
+            if "choices" in field_kwargs and field_value is not None:
+                choice_map = dict(field_kwargs["choices"])
+                if field.type == "multiple_choice":
+                    value = [choice_map[i] for i in field_value]
+                else:
+                    value = choice_map[field_value]
+            else:
+                value = field_value
+            if value:
+                label = field.get_verbose_name()
+                if isinstance(value, list) and field.type != "multiple_choice":
+                    value = "|".join(map(str, value))
+                items.append((label, value))
+        return items
+
+
 reversion.register(TagBinding)
 reversion.register(ModelBinding)
 reversion.register(UserDefinedForm)

hawc/apps/udf/templates/udf/fragments/_udf_content.html

@@ -0,0 +1,21 @@
+<h3>User defined fields</h3>
+<table class="table table-sm m-0 noborder">
+    <colgroup>
+        <col width="30%" />
+        <col width="70%" />
+    </colgroup>
+    <thead>
+        <tr class="tr-light list-border">
+            <th>Field</th>
+            <th>Value</th>
+        </tr>
+    </thead>
+    <tbody>
+        {% for key, value in object.get_content_as_list %}
+        <tr class="tr-light">
+            <td>{{key}}</td>
+            <td>{{value}}</td>
+        </tr>
+        {% endfor %}
+    </tbody>
+</table>

hawc/apps/udf/views.py

@@ -1,4 +1,5 @@
-from django.core.exceptions import PermissionDenied
+from django.contrib.contenttypes.models import ContentType
+from django.core.exceptions import ObjectDoesNotExist, PermissionDenied
 from django.urls import reverse_lazy
 from django.utils.decorators import method_decorator
 from django.views.generic import DetailView, ListView
@@ -200,3 +201,17 @@ class DeleteTagBindingView(BaseDelete):
 
     def get_success_url(self):
         return self.assessment.get_udf_list_url()
+
+
+class UDFDetailMixin:
+    """Mixin to add saved UDF contents to the context of a BaseDetail view."""
+
+    def get_context_data(self, **kwargs):
+        context = super().get_context_data(**kwargs)
+        content_type = ContentType.objects.get_for_model(self.model)
+        try:
+            udf_binding = self.assessment.udf_bindings.get(content_type=content_type)
+            context["udf_content"] = udf_binding.saved_contents.get(object_id=self.object.pk)
+        except ObjectDoesNotExist:
+            context["udf_content"] = None
+        return context