create user defined forms app

hawc/apps/udf/admin.py

@@ -0,0 +1,11 @@
+from django.contrib import admin
+
+from . import models
+
+
+class CustomDataExtractionInline(admin.TabularInline):
+    model = models.UserDefinedForm
+    extra = 0
+
+
+admin.site.register(models.UserDefinedForm)

hawc/apps/udf/apps.py

@@ -0,0 +1,7 @@
+from django.apps import AppConfig
+
+
+class FormLibraryConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "hawc.apps.udf"
+    verbose_name = "User Defined Forms"

hawc/apps/udf/forms.py

@@ -0,0 +1,41 @@
+from django import forms
+from django.urls import reverse
+
+from hawc.apps.common.autocomplete.forms import AutocompleteSelectMultipleWidget
+from hawc.apps.common.dynamic_forms.schemas import Schema
+from hawc.apps.common.forms import BaseFormHelper, PydanticValidator
+from hawc.apps.myuser.autocomplete import UserAutocomplete
+
+from .models import UserDefinedForm
+
+
+class UDFForm(forms.ModelForm):
+    schema = forms.JSONField(
+        initial=Schema(fields=[]).dict(),
+        validators=[PydanticValidator(Schema)],
+    )
+
+    def __init__(self, *args, **kwargs):
+        user = kwargs.pop("user")
+        super().__init__(*args, **kwargs)
+        if self.instance.id is None:
+            self.instance.creator = user
+
+    class Meta:
+        model = UserDefinedForm
+        exclude = ("parent_form", "creator", "created", "last_updated")
+        widgets = {
+            "editors": AutocompleteSelectMultipleWidget(UserAutocomplete),
+        }
+
+    @property
+    def helper(self):
+        self.fields["description"].widget.attrs["rows"] = 3
+        cancel_url = reverse("portal")  # TODO: replace temp cancel url
+        helper = BaseFormHelper(
+            self,
+            legend_text="Create a custom data extraction form",
+            cancel_url=cancel_url,
+            submit_text="Create Form",
+        )
+        return helper

hawc/apps/udf/migrations/0001_initial.py

@@ -0,0 +1,59 @@
+import django.db.models.deletion
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    initial = True
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="UserDefinedForm",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True, primary_key=True, serialize=False, verbose_name="ID"
+                    ),
+                ),
+                ("name", models.CharField(max_length=128)),
+                ("description", models.TextField()),
+                ("schema", models.JSONField()),
+                ("deprecated", models.BooleanField(default=False)),
+                ("created", models.DateTimeField(auto_now_add=True)),
+                ("last_updated", models.DateTimeField(auto_now=True)),
+                (
+                    "creator",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.PROTECT,
+                        related_name="udf_forms_creator",
+                        to=settings.AUTH_USER_MODEL,
+                    ),
+                ),
+                (
+                    "editors",
+                    models.ManyToManyField(
+                        blank=True, related_name="udf_forms", to=settings.AUTH_USER_MODEL
+                    ),
+                ),
+                (
+                    "parent",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        related_name="children",
+                        to="udf.userdefinedform",
+                    ),
+                ),
+            ],
+            options={
+                "ordering": ("-last_updated",),
+                "unique_together": {("creator", "name")},
+            },
+        ),
+    ]

hawc/apps/udf/models.py

@@ -0,0 +1,30 @@
+import reversion
+from django.conf import settings
+from django.db import models
+
+
+class UserDefinedForm(models.Model):
+    name = models.CharField(max_length=128)
+    description = models.TextField()
+    schema = models.JSONField()
+    creator = models.ForeignKey(
+        settings.AUTH_USER_MODEL, on_delete=models.PROTECT, related_name="udf_forms_creator"
+    )
+    editors = models.ManyToManyField(settings.AUTH_USER_MODEL, blank=True, related_name="udf_forms")
+    parent = models.ForeignKey(
+        "self",
+        blank=True,
+        null=True,
+        on_delete=models.SET_NULL,
+        related_name="children",
+    )
+    deprecated = models.BooleanField(default=False)
+    created = models.DateTimeField(auto_now_add=True)
+    last_updated = models.DateTimeField(auto_now=True)
+
+    class Meta:
+        unique_together = (("creator", "name"),)
+        ordering = ("-last_updated",)
+
+
+reversion.register(UserDefinedForm)

hawc/apps/udf/templates/udf/udf_form.html

@@ -0,0 +1,7 @@
+{% extends "crumbless.html" %}
+
+{% load crispy_forms_tags %}
+
+{% block content %}
+{% crispy form %}
+{% endblock %}

hawc/apps/udf/urls.py

@@ -0,0 +1,13 @@
+from django.conf import settings
+from django.urls import path
+
+from . import views
+
+app_name = "udf"
+urlpatterns = (
+    [
+        path("create/", views.CreateUDFView.as_view(), name="udf_create"),
+    ]
+    if settings.HAWC_FEATURES.ENABLE_UDF
+    else []
+)

hawc/apps/udf/views.py

@@ -0,0 +1,20 @@
+from django.urls import reverse
+from django.views.generic.edit import CreateView
+
+from hawc.apps.common.views import LoginRequiredMixin, MessageMixin
+
+from .forms import UDFForm
+
+
+class CreateUDFView(LoginRequiredMixin, MessageMixin, CreateView):
+    template_name = "udf/udf_form.html"
+    form_class = UDFForm
+    success_message = "Form created."
+
+    def get_form_kwargs(self):
+        kwargs = super().get_form_kwargs()
+        kwargs.update(user=self.request.user)
+        return kwargs
+
+    def get_success_url(self) -> str:
+        return reverse("portal")

hawc/constants.py

@@ -17,6 +17,7 @@ class FeatureFlags(BaseModel):
     ANONYMOUS_ACCOUNT_CREATION: bool = True
     ENABLE_BMDS_33 = False
     ENABLE_PLOTLY_VISUAL: bool = False
+    ENABLE_UDF: bool = False
 
     @classmethod
     def from_env(cls, variable) -> "FeatureFlags":

hawc/main/settings/base.py

@@ -125,6 +125,7 @@
     "hawc.apps.hawc_admin",
     "hawc.apps.materialized",
     "hawc.apps.epiv2",
+    "hawc.apps.udf",
 )
 # DB settings
 DATABASES = {

hawc/main/settings/unittest.py

@@ -10,6 +10,7 @@
 
 # enable feature flags for tests
 HAWC_FEATURES.ENABLE_BMDS_33 = True
+HAWC_FEATURES.ENABLE_UDF = True
 
 # remove toolbar for integration tests
 INSTALLED_APPS = [app for app in INSTALLED_APPS if app != "debug_toolbar"]

hawc/main/urls.py

@@ -17,6 +17,7 @@
 import hawc.apps.riskofbias.urls
 import hawc.apps.study.urls
 import hawc.apps.summary.urls
+import hawc.apps.udf.urls
 import hawc.apps.vocab.urls
 from hawc.apps.assessment import views
 from hawc.apps.common.autocomplete import get_autocomplete
@@ -43,6 +44,7 @@
     path("epidemiology/", include("hawc.apps.epiv2.urls")),
     path("epi-meta/", include("hawc.apps.epimeta.urls")),
     path("in-vitro/", include("hawc.apps.invitro.urls")),
+    path("udf/", include("hawc.apps.udf.urls")),
     path("bmd/", include("hawc.apps.bmd.urls")),
     path("lit/", include("hawc.apps.lit.urls")),
     path("summary/", include("hawc.apps.summary.urls")),

tests/data/fixtures/db.yaml

@@ -10247,6 +10247,25 @@
     due_date: null
     started: null
     completed: null
+- model: udf.UserDefinedForm
+  pk: 1
+  fields:
+    name: demo form
+    description: a demo form
+    schema: {
+      fields: [
+        {name: "field1", type: "char"},
+        {name: "field2", type: "integer"},
+      ]
+    }
+    creator:
+    - pm@hawcproject.org
+    editors:
+    - - team@hawcproject.org
+    parent: null
+    deprecated: false
+    created: 2023-09-17 04:10:29.880052+00:00
+    last_updated: 2023-09-17 04:15:33.309627+00:00
 - model: reversion.revision
   pk: 1
   fields: