Added global required fields notice for WCAG H90 compliance (#14962)

* Added global required fields notice for WCAG H90 compliance

* display_tags.py add and removed blank line

* Added setting/env variable DD_SHOW_A11Y_REQUIRED_FIELDS_NOTICE

---------

Co-authored-by: symon.vezina <symon.vezina@hrsdc-rhdcc.gc.ca>

Author: sym9

dojo/context_processors.py

@@ -22,6 +22,7 @@ def globalize_vars(request):
         "SHOW_PLG_LINK": True,
         # V3 Feature Flags
         "V3_FEATURE_LOCATIONS": settings.V3_FEATURE_LOCATIONS,
+        "SHOW_A11Y_REQUIRED_FIELDS_NOTICE": settings.SHOW_A11Y_REQUIRED_FIELDS_NOTICE,
     }
 
     additional_banners = []

dojo/settings/settings.dist.py

@@ -127,7 +127,8 @@
     # Falls back to a plain queryset on any error (logged).
     DD_WATSON_INDEX_PREFETCH_ENABLED=(bool, True),
     DD_FOOTER_VERSION=(str, ""),
-    # models should be passed to celery by ID, default is False (for now)
+    # Toggle for the highly accessible notice at the top of forms ("Required fields are marked with an asterisk*")
+    DD_SHOW_A11Y_REQUIRED_FIELDS_NOTICE=(bool, True),
     DD_DATABASE_ENGINE=(str, "django.db.backends.postgresql"),
     DD_DATABASE_HOST=(str, "postgres"),
     DD_DATABASE_NAME=(str, "defectdojo"),
@@ -625,6 +626,9 @@ def generate_url(scheme, double_slashes, user, password, host, port, path, param
 # Used to configure a custom version in the footer of the base.html template.
 FOOTER_VERSION = env("DD_FOOTER_VERSION")
 
+# Toggle for the highly accessible notice at the top of forms ("Required fields are marked with an asterisk*")
+SHOW_A11Y_REQUIRED_FIELDS_NOTICE = env("DD_SHOW_A11Y_REQUIRED_FIELDS_NOTICE")
+
 # V3 Feature Flags
 V3_FEATURE_LOCATIONS = env("DD_V3_FEATURE_LOCATIONS")
 

dojo/templates/dojo/form_fields.html

@@ -1,4 +1,5 @@
 {% load event_tags %}
+{% load display_tags %}
 {% block css %}
     {{ form.media.css }}
 {% endblock %}
@@ -17,6 +18,16 @@
     {{ field }}
 {% endfor %}
 
+{% if form|has_required_field and SHOW_A11Y_REQUIRED_FIELDS_NOTICE %}
+    <div class="form-group">
+        <div class="col-sm-offset-2 col-sm-10">
+            <p class="help-block">
+                <em>Required fields are marked with an asterisk</em><sup>*</sup>
+            </p>
+        </div>
+    </div>
+{% endif %}
+
 {% for field in form.visible_fields %}
     <div class="form-group{% if field.errors %} has-error{% endif %}">
         {% if field|is_checkbox %}

dojo/templates_classic/dojo/form_fields.html

@@ -1,4 +1,5 @@
 {% load event_tags %}
+{% load display_tags %}
 {% block css %}
     {{ form.media.css }}
 {% endblock %}
@@ -16,6 +17,16 @@
     {{ field }}
 {% endfor %}
 
+{% if form|has_required_field and SHOW_A11Y_REQUIRED_FIELDS_NOTICE %}
+    <div class="form-group">
+        <div class="col-sm-offset-2 col-sm-10">
+            <p class="help-block">
+                <em>Required fields are marked with an asterisk</em><sup>*</sup>
+            </p>
+        </div>
+    </div>
+{% endif %}
+
 {% for field in form.visible_fields %}
     <div class="form-group{% if field.errors %} has-error{% endif %}">
         {% if field|is_checkbox %}

dojo/templatetags/display_tags.py

@@ -1167,3 +1167,11 @@ def import_history(finding, *, autoescape=True):
         list_of_status_changes += "<b>" + status_change.created.strftime("%b %d, %Y, %H:%M:%S") + "</b>: " + status_change.get_action_display() + "<br/>"
 
     return mark_safe(html % (list_of_status_changes))
+
+
+@register.filter
+def has_required_field(form):
+    """Returns True if the form has at least one required field"""
+    if not form:
+        return False
+    return any(field.field.required for field in form)