Django field for Quill input

frontend/animal/EditEndpoint.js

@@ -23,10 +23,6 @@ class EditEndpoint {
         // reorganize forms
         $("#endpointGroups").insertBefore($("div.form-actions"));
 
-        // html5 enabled form
-        $("#id_results_notes").quillify();
-        $("#id_endpoint_notes").quillify();
-
         //update values in doses table
         $("#doses_title").html(`Dose<br>(${firstDoses.name})`);
         $(".doses").each(function(i, v) {

frontend/epiv2/form.js

@@ -5,10 +5,7 @@ import {EXPOSURE_BIOMONITORING} from "./constants";
 
 const designFormStartup = function(form) {
         $(form)
-            .find(".html5text")
-            .quillify();
-        $(form)
-            .find("#id_study_design")
+            .find("#id_summary")
             .focus();
     },
     exposureFormStartup = function(form) {

frontend/shared/utils/Quillify.js

@@ -61,10 +61,11 @@ const toolbarOptions = {
     };
 
 export default function() {
-    let modal = $("#smartTagModal"),
+    let focusedItem = $(":focus"),
+        modal = $("#smartTagModal"),
         showHawcTools = modal.length === 1;
 
-    return this.each(function() {
+    this.each(function() {
         let editor = document.createElement("div"),
             textarea = $(this),
             q;
@@ -98,4 +99,7 @@ export default function() {
             q.stc.enableModals();
         }
     });
+
+    // restore original focus
+    $(focusedItem).focus();
 }

hawc/apps/animal/forms.py

@@ -12,7 +12,12 @@
 from ..assessment.lookups import DssToxIdLookup, EffectTagLookup, SpeciesLookup, StrainLookup
 from ..assessment.models import DoseUnits
 from ..common import selectable
-from ..common.forms import BaseFormHelper, CopyAsNewSelectorForm, form_actions_apply_filters
+from ..common.forms import (
+    BaseFormHelper,
+    CopyAsNewSelectorForm,
+    QuillField,
+    form_actions_apply_filters,
+)
 from ..study.lookups import AnimalStudyLookup
 from ..vocab.constants import VocabularyNamespace
 from . import constants, lookups, models
@@ -22,6 +27,7 @@ class ExperimentForm(ModelForm):
     class Meta:
         model = models.Experiment
         exclude = ("study",)
+        field_classes = {"description": QuillField}
 
     def __init__(self, *args, **kwargs):
         parent = kwargs.pop("parent", None)
@@ -63,8 +69,6 @@ def helper(self):
             if type(widget) != forms.CheckboxInput:
                 widget.attrs["class"] = "form-control"
 
-        self.fields["description"].widget.attrs["rows"] = 4
-
         if self.instance.id:
             inputs = {
                 "legend_text": f"Update {self.instance}",
@@ -135,6 +139,7 @@ class Meta:
         model = models.AnimalGroup
         exclude = ("experiment", "dosing_regime", "generation", "parents")
         labels = {"lifestage_assessed": "Lifestage at assessment"}
+        field_classes = {"comments": QuillField}
 
     def __init__(self, *args, **kwargs):
         parent = kwargs.pop("parent", None)
@@ -166,8 +171,6 @@ def __init__(self, *args, **kwargs):
             experiment=self.instance.experiment
         )
 
-        self.fields["comments"].widget.attrs["rows"] = 4
-
     @property
     def helper(self):
         for fld in list(self.fields.keys()):
@@ -252,14 +255,13 @@ class DosingRegimeForm(ModelForm):
     class Meta:
         model = models.DosingRegime
         exclude = ("dosed_animals",)
+        field_classes = {"description": QuillField}
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
 
     @property
     def helper(self):
-
-        self.fields["description"].widget.attrs["rows"] = 4
         for fld in list(self.fields.keys()):
             self.fields[fld].widget.attrs["class"] = "form-control"
 
@@ -414,6 +416,7 @@ class Meta:
             "effect_term": forms.HiddenInput,
             "effect_subtype_term": forms.HiddenInput,
         }
+        field_classes = {"results_notes": QuillField, "endpoint_notes": QuillField}
 
     def __init__(self, *args, **kwargs):
         animal_group = kwargs.pop("parent", None)

hawc/apps/animal/templates/animal/animalgroup_copy_selector.html

@@ -15,7 +15,6 @@
 {% endblock content %}
 
 {% block extrajs %}
-  {{ form.media }}
   <script type="text/javascript">
     $(document).ready(function(){
 

hawc/apps/animal/templates/animal/animalgroup_form.html

@@ -40,7 +40,6 @@
 {% endblock %}
 
 {% block extrajs %}
-{{form.media}}
 <script type="text/javascript">
 $(document).ready(function() {
     var printf = window.app.HAWCUtils.printf,
@@ -68,8 +67,6 @@
                 );
             };
 
-            $('#id_comments').quillify();
-            $('#id_description').quillify();
             $('#id_species')
                 .change(onSpeciesChange)
                 .trigger('change');

hawc/apps/animal/templates/animal/dosingregime_form.html

@@ -25,8 +25,6 @@
 
 {% block extrajs %}
   <script type="text/javascript">
-      $('#id_description').quillify();
-
       // reorganize forms
       var actions = $('.form-actions');
       $('#doseGroupsDiv').insertBefore($('.form-actions'))

hawc/apps/animal/templates/animal/endpoint_copy_selector.html

@@ -50,7 +50,6 @@
 {% endblock content %}
 
 {% block extrajs %}
-  {{ form.media }}
   <script type="text/javascript">
     let rerunSearch = function() {
         // rerun whenever settings change and an item isn't selected

hawc/apps/animal/templates/animal/endpoint_form.html

@@ -98,7 +98,6 @@
 {% endblock %}
 
 {% block extrajs %}
-  {{ form.media }}
   <script type="text/json" id="config">
     {
       "vocabulary": {{vocabulary|safe}},

hawc/apps/animal/templates/animal/endpoint_list.html

@@ -22,7 +22,6 @@ <h2>Assessment endpoints ({{page_obj.paginator.count}} found)</h2>
 {% endblock content %}
 
 {% block extrajs %}
-    {{ form.media }}
     {{ config|json_script:"config" }}
     <script type="text/javascript">
         window.app.startup("animalStartup", function(animal){

hawc/apps/animal/templates/animal/experiment_copy_selector.html

@@ -14,7 +14,6 @@
 {% endblock content %}
 
 {% block extrajs %}
-  {{ form.media }}
   <script type="text/javascript">
     $(document).ready(function(){
 

hawc/apps/animal/templates/animal/experiment_form.html

@@ -8,10 +8,8 @@
 {% endblock %}
 
 {% block extrajs %}
-  {{ form.media }}
   <script type="text/javascript">
     $(document).ready(function(){
-      $('#id_description').quillify();
       $('#id_name').focus();
       var pa = $('#id_purity_available'),
           addBlankOption = function(setAsBlank){

hawc/apps/assessment/forms.py

@@ -14,7 +14,12 @@
 
 from hawc.services.epa.dsstox import DssSubstance
 
-from ..common.forms import BaseFormHelper, form_actions_apply_filters, form_actions_create_or_close
+from ..common.forms import (
+    BaseFormHelper,
+    QuillField,
+    form_actions_apply_filters,
+    form_actions_create_or_close,
+)
 from ..common.helper import new_window_a, tryParseInt
 from ..common.selectable import AutoCompleteSelectMultipleWidget, AutoCompleteWidget
 from ..common.widgets import DateCheckboxInput
@@ -25,10 +30,9 @@
 
 class AssessmentForm(forms.ModelForm):
 
-    internal_communications = forms.CharField(
+    internal_communications = QuillField(
         required=False,
         help_text="Internal communications regarding this assessment; this field is only displayed to assessment team members.",
-        widget=forms.Textarea,
     )
 
     class Meta:
@@ -46,6 +50,12 @@ class Meta:
         widgets = {
             "public_on": DateCheckboxInput,
         }
+        field_classes = {
+            "assessment_objective": QuillField,
+            "authors": QuillField,
+            "conflicts_of_interest": QuillField,
+            "funding_source": QuillField,
+        }
 
     def __init__(self, *args, **kwargs):
         self.user = kwargs.pop("user", None)
@@ -85,13 +95,6 @@ def save(self, commit=True):
 
     @property
     def helper(self):
-        # by default take-up the whole row
-        for fld in list(self.fields.keys()):
-            widget = self.fields[fld].widget
-            if type(widget) == forms.Textarea:
-                widget.attrs["rows"] = 3
-                widget.attrs["class"] = widget.attrs.get("class", "") + " html5text"
-
         if self.instance.id:
             inputs = {
                 "legend_text": f"Update {self.instance}",
@@ -223,6 +226,7 @@ class AttachmentForm(forms.ModelForm):
     class Meta:
         model = models.Attachment
         exclude = ("content_type", "object_id", "content_object")
+        field_classes = {"description": QuillField}
 
     def __init__(self, *args, **kwargs):
         obj = kwargs.pop("parent", None)
@@ -234,7 +238,6 @@ def __init__(self, *args, **kwargs):
 
     @property
     def helper(self):
-        self.fields["description"].widget.attrs["class"] = "html5text"
         helper = BaseFormHelper(self)
         helper.form_tag = False
         helper.add_row("title", 2, "col-md-6")
@@ -441,13 +444,6 @@ def __init__(self, *args, **kwargs):
 
     @property
     def helper(self):
-        # by default take-up the whole row
-        for fld in self.fields.keys():
-            widget = self.fields[fld].widget
-            if type(widget) == forms.Textarea:
-                widget.attrs["rows"] = 3
-                widget.attrs["class"] = widget.attrs.get("class", "") + " html5text"
-
         if self.instance.id:
             inputs = {
                 "legend_text": f"Update {self.instance}",
@@ -537,6 +533,7 @@ def save(self, commit=True):
     class Meta:
         model = models.Dataset
         fields = ("name", "description", "published")
+        field_classes = {"description": QuillField}
 
 
 class LogFilterForm(forms.Form):

hawc/apps/assessment/templates/assessment/_assessment_form_js.html

@@ -17,7 +17,6 @@
         $('#id_vocabulary').on('change', toggleCuration)
         toggleCuration();
 
-        $('.html5text').quillify();
         $('#id_name').focus();
     });
 </script>

hawc/apps/assessment/templates/assessment/assessment_create_form.html

@@ -12,6 +12,5 @@
 {% endblock %}
 
 {% block extrajs %}
-  {{ form.media }}
   {% include 'assessment/_assessment_form_js.html' %}
 {% endblock extrajs %}

hawc/apps/assessment/templates/assessment/assessment_detail.html

@@ -248,7 +248,6 @@ <h3>Assessment details for team members*</h3>
     // attachment-form events
     const form = $(target).find('.attachment-form');
     if (form) {
-      form.find('.html5text').quillify();
       form.find("#id_title").focus();
     }
   });

hawc/apps/assessment/templates/assessment/assessment_form.html

@@ -12,6 +12,5 @@
 {% endblock %}
 
 {% block extrajs %}
-  {{ form.media }}
   {% include 'assessment/_assessment_form_js.html' %}
 {% endblock extrajs %}

hawc/apps/assessment/templates/assessment/assessment_log_list.html

@@ -87,7 +87,3 @@ <h2>{{assessment}} Logs</h2>
 {% include "includes/paginator.html" %}
 {% include 'assessment/_logs_note.html' %}
 {% endblock content %}
-
-{% block extrajs %}
-    {{ form.media }}
-{% endblock extrajs %}

hawc/apps/assessment/templates/assessment/dataset_form.html

@@ -9,7 +9,6 @@
 {% block extrajs %}
 <script type="text/javascript">
     $(document).ready(function () {
-        $('.html5text').quillify();
         $('#id_name').focus();
 
         // show/hide excel worksheet name depending on what was file was selected

hawc/apps/assessment/templates/assessment/doseunits_form.html

@@ -6,7 +6,3 @@
 {% block content %}
   {% crispy form %}
 {% endblock content %}
-
-{% block extrajs %}
-  {{ form.media }}
-{% endblock extrajs %}

hawc/apps/assessment/templates/assessment/effecttag_form.html

@@ -12,7 +12,6 @@
 {% endblock content %}
 
 {% block extrajs %}
-  {{ form.media }}
   <script type="text/javascript">
     $(document).ready(function(){
       $('#id_name').on('keyup', function(){

hawc/apps/common/forms.py

@@ -7,7 +7,7 @@
 from django import forms
 from django.template.loader import render_to_string
 
-from . import selectable, validators
+from . import selectable, validators, widgets
 
 ASSESSMENT_UNIQUE_MESSAGE = "Must be unique for assessment (current value already exists)."
 
@@ -32,6 +32,7 @@ class BaseFormHelper(cf.FormHelper):
 
     error_text_inline = False
     use_custom_control = True
+    include_media = False
 
     def __init__(self, form=None, **kwargs):
         self.attrs = {}
@@ -222,3 +223,26 @@ def format_value(self, value) -> List[str]:
         if value is None:
             return []
         return value.split(",")
+
+
+class QuillField(forms.CharField):
+    """
+    Quill text editor input.
+    Cleans HTML and validates urls.
+    """
+
+    widget = widgets.QuillWidget
+
+    def __init__(self, *args, **kwargs):
+        # Force use of Quill widget
+        kwargs["widget"] = self.widget
+        super().__init__(*args, **kwargs)
+
+    def to_python(self, value):
+        value = super().to_python(value)
+        return validators.clean_html(value) if value else value
+
+    def validate(self, value):
+        super().validate(value)
+        if value:
+            validators.validate_hyperlinks(value)