From e54a5ff87b8fb5275ab6fa51f9bfbfa767752020 Mon Sep 17 00:00:00 2001
From: allholy <pennyan19@gmail.com>
Date: Wed, 15 Jan 2025 21:40:54 +0100
Subject: [PATCH] Implement frontend layout for BST category field

---
 .../src/pages/editDescribeSounds.js           |   4 +-
 sounds/forms.py                               |  11 +-
 sounds/templatetags/bst_category.py           |  11 ++
 sounds/views.py                               |   3 +-
 .../molecules/bst_category_form_field.html    | 124 ++++++++++++++++++
 templates/sounds/edit_and_describe.html       |   4 +-
 6 files changed, 150 insertions(+), 7 deletions(-)
 create mode 100644 sounds/templatetags/bst_category.py
 create mode 100644 templates/molecules/bst_category_form_field.html

diff --git a/freesound/static/bw-frontend/src/pages/editDescribeSounds.js b/freesound/static/bw-frontend/src/pages/editDescribeSounds.js
index 747313cf3..94922d16d 100644
--- a/freesound/static/bw-frontend/src/pages/editDescribeSounds.js
+++ b/freesound/static/bw-frontend/src/pages/editDescribeSounds.js
@@ -28,4 +28,6 @@ inputTypeSubmitElements.forEach(button => {
             }
         });
     });
-});
\ No newline at end of file
+});
+
+// Move json for BST category field in description form here
diff --git a/sounds/forms.py b/sounds/forms.py
index cd23d441b..82a66486e 100644
--- a/sounds/forms.py
+++ b/sounds/forms.py
@@ -23,7 +23,7 @@
 
 from captcha.fields import ReCaptchaField
 from django import forms
-from django.core.exceptions import PermissionDenied
+from django.core.exceptions import PermissionDenied, ValidationError
 from django.db.models import Q
 from django.forms import ModelForm, Textarea, TextInput
 from django.core.signing import BadSignature, SignatureExpired
@@ -247,7 +247,8 @@ class SoundEditAndDescribeForm(forms.Form):
                            widget=forms.TextInput(attrs={'size': 65, 'class': 'inputText'}))
     bst_category = forms.ChoiceField(
         choices=Sound.BST_CATEGORY_CHOICES,
-        required=False
+        help_text="Choose the most appropriate catgeory and subcatgoery (you can only choose one). This category will be displayed as a filtering option in the Freesound side bar.",
+        required=True,
     )
     tags = TagField(
         widget=forms.Textarea(attrs={'cols': 80, 'rows': 3}),
@@ -348,6 +349,12 @@ def clean_sources(self):
 
     def clean_pack(self):
         return _pack_form_clean_pack_helper(self.cleaned_data)
+    
+    def clean_bst_category(self):
+        value = self.cleaned_data['bst_category']
+        if not '-' in value:
+            raise ValidationError("Please choose a subcategory.")
+        return value
 
 
 class SoundCSVDescriptionForm(SoundEditAndDescribeForm):
diff --git a/sounds/templatetags/bst_category.py b/sounds/templatetags/bst_category.py
new file mode 100644
index 000000000..530ce30a7
--- /dev/null
+++ b/sounds/templatetags/bst_category.py
@@ -0,0 +1,11 @@
+from django import template
+
+register = template.Library()
+
+@register.filter
+def get_top_level_bst_category(value):
+    """
+    Extract the top level category from the given value.
+    The top level category is the part before the '-' in value.
+    """
+    return value.split('-')[0] if '-' in value else value
diff --git a/sounds/views.py b/sounds/views.py
index f09214b6b..1d56869dc 100644
--- a/sounds/views.py
+++ b/sounds/views.py
@@ -661,7 +661,8 @@ def update_edited_sound(sound, data):
         'sounds_per_round': forms_per_round,
         'last_latlong': request.user.profile.get_last_latlong(),
         'total_sounds_to_describe': len_original_describe_edit_sounds,
-        'next': request.GET.get('next', '')
+        'next': request.GET.get('next', ''),
+        'bst_taxonomy': settings.BROAD_SOUND_TAXONOMY
     }
     
     if request.method == "POST" and all_forms_validated_ok:
diff --git a/templates/molecules/bst_category_form_field.html b/templates/molecules/bst_category_form_field.html
new file mode 100644
index 000000000..b9ca50975
--- /dev/null
+++ b/templates/molecules/bst_category_form_field.html
@@ -0,0 +1,124 @@
+{% load bst_category %}
+
+<div class="bst-category-field">
+
+    {{ form.bst_category.errors }}
+    <div><label>Category</label></div>
+    {{ form.bst_category.as_hidden }}
+
+    <div class="top-buttons v-spacing-top-2">
+        {% for value, label in form.fields.bst_category.choices %}
+            {% if "-" not in value %}
+                <button type="button" class="btn no-hover {% if value == form.bst_category.value|get_top_level_bst_category %}btn-primary{% else %}btn-inverse{% endif %} cell_tooltip_left" data_value="{{ value }}">
+                    {{ label }}
+                    {% for item in bst_taxonomy %}
+                        {% if item.category_code == value %}
+                            <span class="tooltiptext">{{ item.description }}</span>
+                        {% endif %}
+                    {% endfor %}
+                </button>
+            {% endif %}
+        {% endfor %}
+    </div>
+
+    <div class="subcategory-buttons v-spacing-top-2 display-none">
+        <div><label>Subcategory</label></div>
+        <div class="row v-spacing-top-2">
+            {% for value, label in form.fields.bst_category.choices %}
+                {% if "-" in value %}
+                    <button type="button" class="btn no-hover {% if value == form.bst_category.value %}btn-secondary{% else %}btn-inverse{% endif %} btn-subcategory cell_tooltip_left" top_level="{{ value|get_top_level_bst_category }}" data_value="{{ value }}">
+                        {{ label }}
+                        {% for item in bst_taxonomy %}
+                            {% if item.category_code == value %}
+                                <span class="tooltiptext">{{ item.description }}</span>
+                            {% endif %}
+                        {% endfor %}
+                    </button>
+                {% endif %}
+            {% endfor %}
+        </div>
+    </div>
+    <div class="v-spacing-top-4">
+        <span class="helptext">{{ form.bst_category.help_text|safe }}</span>
+    </div>
+</div>
+
+<script>
+    document.addEventListener("DOMContentLoaded", function () {
+
+        const categoryFieldContainers = document.querySelectorAll(".bst-category-field");
+        categoryFieldContainers.forEach(container => {
+            const hiddenField = container.querySelectorAll("input[type=hidden]")[0];
+            const topButtons = container.querySelectorAll(".top-buttons .btn");
+            const subcategoryButtons = container.querySelectorAll(".btn-subcategory");
+            const subcategoryContainer = container.querySelector(".subcategory-buttons");
+
+            const updateSubcategoriesList = () => {
+                if (hiddenField.value === "") {
+                    subcategoryContainer.classList.add("display-none");
+                    return;
+                } else {
+                    // Display subcategories that match the selected top-level category
+                    // Triggered when a selection is made or updated.
+                    const correspondingTopLevelValue = hiddenField.value.split("-")[0]; // Extract top-level value, if not already.
+                    console.log(correspondingTopLevelValue);
+                    if(correspondingTopLevelValue) {
+                        subcategoryContainer.classList.remove("display-none");
+                 
+                        subcategoryButtons.forEach(subBtn => {
+                            const topLevelValue = subBtn.getAttribute("top_level");
+                            const isTrue = topLevelValue === correspondingTopLevelValue;
+                            // console.log("Is condition true?", isTrue);
+                            subBtn.style.display = topLevelValue === correspondingTopLevelValue ? "inline-block" : "none";
+                        });
+                    }
+                }
+            }
+
+            // Event listener for top-level category buttons
+            topButtons.forEach(topBtn => {
+                topBtn.addEventListener("click", function () {
+                    const selectedValue = this.getAttribute("data_value");
+    
+                    // Update hidden input value
+                    hiddenField.value = selectedValue;
+                    
+                    // Highlight the selected top-level category button
+                    topButtons.forEach(btn => {
+                        btn.classList.remove("btn-primary")
+                        btn.classList.add("btn-inverse")
+                        btn.setAttribute("aria-selected", "false")
+                    })       
+                    this.classList.remove("btn-inverse")
+                    this.classList.add("btn-primary")
+                    this.setAttribute("aria-selected", "true")
+    
+                    updateSubcategoriesList();
+                });
+            });
+    
+            // Event listener for subcategory buttons
+            subcategoryButtons.forEach(subBtn => {
+                subBtn.addEventListener("click", function () {
+                    const subcategoryValue = this.getAttribute("data_value");
+    
+                    // Update hidden input value if subcategory is clicked
+                    hiddenField.value = subcategoryValue;
+    
+                    // Highlight the selected subcategory button
+                    subcategoryButtons.forEach(btn => {
+                        btn.classList.remove("btn-secondary")
+                        btn.classList.add("btn-inverse")
+                        btn.setAttribute("aria-selected", "false")
+                    })
+                    this.classList.remove("btn-inverse")
+                    this.classList.add("btn-secondary")
+                    btn.setAttribute("aria-selected", "true");
+                });
+            });
+
+            updateSubcategoriesList();
+        });
+
+    });
+</script>
diff --git a/templates/sounds/edit_and_describe.html b/templates/sounds/edit_and_describe.html
index 6650dd683..f0b11e155 100644
--- a/templates/sounds/edit_and_describe.html
+++ b/templates/sounds/edit_and_describe.html
@@ -71,9 +71,7 @@ <h5 class="text-light-grey v-spacing-2">Basic information</h5>
                             {{ form.name }}
                         </div>
                         <div>
-                            {{ form.bst_category.errors }}
-                            {{ form.bst_category.label_tag }}
-                            {{ form.bst_category }}
+                            {% include "molecules/bst_category_form_field.html" %}
                         </div>
                         <div class="v-spacing-top-3">
                             {% include "molecules/tags_form_field.html" %}