Merge pull request #305 from RSE-Sheffield/feat/survey-pause

Joe-Heffer-Shef · web-flow · commit 63cb3a6296cd · 2025-07-02T10:43:12.000+01:00
Add survey pause/unpause feature
diff --git a/survey/exceptions.py b/survey/exceptions.py
@@ -0,0 +1,9 @@
+from django.core.exceptions import ValidationError
+
+
+class SurveyInactiveError(ValidationError):
+    """
+    A survey is paused so no data is being gathered.
+    """
+
+    pass
diff --git a/survey/migrations/0019_survey_is_active.py b/survey/migrations/0019_survey_is_active.py
@@ -0,0 +1,20 @@
+# Generated by Django 5.1.4 on 2025-07-01 09:19
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("survey", "0018_alter_surveyevidencesection_text"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="survey",
+            name="is_active",
+            field=models.BooleanField(
+                default=True, help_text="Are responses being collected?"
+            ),
+        ),
+    ]
diff --git a/survey/models.py b/survey/models.py
@@ -24,6 +24,11 @@ class Survey(models.Model):
     project = models.ForeignKey(Project, on_delete=models.CASCADE, null=True)
     created_at = models.DateTimeField(auto_now_add=True)
     survey_body_path = models.TextField(blank=True, null=True)
+    is_active = models.BooleanField(
+        default=True,
+        help_text="Are responses being collected?",
+        null=False,
+    )
 
     def __str__(self):
         return self.name
@@ -121,6 +126,13 @@ class SurveyResponse(models.Model):
     def get_absolute_url(self, token):
         return reverse("survey", kwargs={"pk": self.survey.pk})
 
+    def clean(self):
+        super().clean()
+
+        # Paused survey
+        if not self.survey.is_active:
+            raise ValueError("Cannot submit response to an inactive survey")
+
 
 class Invitation(models.Model):
     """
diff --git a/survey/services/survey.py b/survey/services/survey.py
@@ -122,17 +122,22 @@ def update_consent_demography_config(
 
     @requires_permission("edit", obj_param="survey")
     def duplicate_survey(self, user: User, survey: Survey):
-        new_survey = Survey.objects.create(project=survey.project,
-                                           name=f"Copy of {survey.name}",
-                                           description=survey.description)
-
-        self.update_consent_demography_config(user, new_survey,
-                                              consent_config=survey.consent_config,
-                                              demography_config=survey.demography_config, survey_body_path=survey.survey_body_path)
+        new_survey = Survey.objects.create(
+            project=survey.project,
+            name=f"Copy of {survey.name}",
+            description=survey.description,
+        )
+
+        self.update_consent_demography_config(
+            user,
+            new_survey,
+            consent_config=survey.consent_config,
+            demography_config=survey.demography_config,
+            survey_body_path=survey.survey_body_path,
+        )
 
         return new_survey
 
-
     def _create_survey_evidence_sections(
         self, survey: Survey, clear_existing_sections: bool = True
     ):
diff --git a/survey/templates/survey/deactivate_confirm.html b/survey/templates/survey/deactivate_confirm.html
@@ -0,0 +1,49 @@
+{% extends 'base_manager.html' %}
+{% block content %}
+    {% load project_filters %}
+    <div class="container mx-auto px-4 py-8 mt-4">
+        <nav aria-label="breadcrumb">
+            <ol class="breadcrumb">
+                <li class="breadcrumb-item" aria-current="page">
+                    <i class="bx bxs-buildings"></i> <a href="{% url 'myorganisation' %}">My Organisation</a>
+                </li>
+                <li class="breadcrumb-item" aria-current="page">
+                    <i class="bx bxs-folder-open"></i> <a
+                        href="{% url 'project' survey.project.id %}">Project: {{ survey.project.name }}</a>
+                </li>
+                <li class="breadcrumb-item" aria-current="page">
+                    <i class="bx bxs-chart"></i> Survey: {{ survey.name }}
+                </li>
+                <li class="breadcrumb-item active" aria-current="page">
+                    <i class="bx bx-pause-circle"></i>&nbsp;Deactivate survey
+                </li>
+            </ol>
+        </nav>
+    </div>
+    <div class="container px-4">
+        <h1>Deactivate survey</h1>
+        <p>
+            Please confirm that you would like to <strong>pause response gathering</strong> for survey "{{ survey }}".
+        </p>
+
+        <p>
+            After you have paused the survey, to resume response gathering please click the "Activate survey" button on
+            the survey management page.
+        </p>
+        <h2>Confirm deactivation</h2>
+        <p>
+            If the survey is deactivated then participants will not be able to submit survey data until it is activated
+            again.
+        </p>
+        <form action="{% url 'survey_deactivate' survey.id %}" method="post">
+            {% csrf_token %}
+            <button type="submit" name="deactivate" value="1" class="btn btn-warning">
+                <i class="bx bx-pause-circle"></i>&nbsp;Deactivate survey
+            </button>
+            <label for="confirm" class="m-3">
+                <input type="checkbox" required id="confirm" name="confirm" value="1"/>
+                I <strong>confirm</strong> that I want to pause response gathering
+            </label>
+        </form>
+    </div>
+{% endblock %}
diff --git a/survey/templates/survey/survey.html b/survey/templates/survey/survey.html
@@ -132,7 +132,7 @@ <h2>2. Invite Your Participants</h2>
                         <p>
                             Geneate an invitation link for your participants to fill in the survey:
                         </p>
-                        <form method="post" action="{% url 'suvey_create_invite' survey.id %}">
+                        <form method="post" action="{% url 'survey_create_invite' survey.id %}">
                             {% csrf_token %}
                             <button type="submit" class="btn btn-primary" name="generate_token"><i
                                     class='bx bx-mail-send'></i> Generate invitation
@@ -176,17 +176,37 @@ <h2>Generate mock responses</h2>
             <div class="card-header">
                 <h2>3. Survey responses</h2>
             </div>
+            {% if not survey.is_active %}
+            <p class="alert alert-warning">
+                <i class="bx bx-pause-circle"></i>
+                Data collection is <strong>paused</strong>.
+                Participants are unable to submit survey responses.
+            </p>
+            {% endif %}
             <div class="card-body">
+                <p>In this section one may view the collected data that has been submitted by participants, either in summary or individual responses.</p>
+                <p>You may also pause and resume data collection to prevent new data being gathered when the survey is complete by clicking the "Deactivate survey" or "Activate survey" button below.</p>
                 {% if survey.survey_config.sections %}
                     <div class="mb-3">
-                        <strong>Responses collected: {{ responses_count }}</strong>
+                        <strong>Responses collected:</strong>&nbsp;{{ responses_count }}
                     </div>
-
                     <div>
                         <a href="{% url 'survey_response_data' survey.id %}" class="btn btn-primary"><i
                                 class='bx bxs-data'></i> View collected responses</a>
                         <a href="{% url 'survey_export' survey.id %}" class="btn btn-primary" download><i
                                 class="bx bx-export"></i> Export survey data as CSV</a>
+                        {% if survey.is_active %}
+                        <a href="{% url 'survey_deactivate' survey.id %}" class="btn btn-warning"
+                           title="Stop collecting responses">
+                            <i class="bx bx-pause-circle"></i> Deactivate survey</a>
+                        {% else %}
+                        <form action="{% url 'survey_activate' survey.id %}" method="post" style="display: inline;">
+                            {% csrf_token %}
+                            <button type="submit" name="activate" value="1" class="btn btn-success">
+                                <i class="bx bx-play-circle"></i>&nbsp;Activate survey
+                            </button>
+                        </form>
+                        {% endif %}
                     </div>
                 {% else %}
                     <p>Survey must be configured before this section can be used.</p>
diff --git a/survey/templates/survey/survey_response_inactive.html b/survey/templates/survey/survey_response_inactive.html
@@ -0,0 +1,9 @@
+{% extends 'base_manager.html' %}
+{% block content %}
+<div class="container">
+    <h3>Survey inactive</h3>
+    <p>
+        Response gathering has been paused or stopped for this survey.
+    </p>
+</div>
+{% endblock %}
diff --git a/survey/urls.py b/survey/urls.py
@@ -22,7 +22,7 @@
     path(
         "survey/<int:pk>/create_invite",
         views.SurveyCreateInviteView.as_view(),
-        name="suvey_create_invite",
+        name="survey_create_invite",
     ),
     path(
         "survey/<int:pk>/duplicate_config",
@@ -92,6 +92,21 @@
         views.SurveyCreateView.as_view(),
         name="survey_create",
     ),
+    path(
+        "survey/<int:pk>/activate",
+        views.SurveyActivateView.as_view(),
+        name="survey_activate",
+    ),
+    path(
+        "survey/<int:pk>/deactivate",
+        views.SurveyDeactivateView.as_view(),
+        name="survey_deactivate",
+    ),
+    path(
+        "survey_response/inactive",
+        views.SurveyResponseInactiveView.as_view(),
+        name="survey_response_inactive",
+    ),
     path("completion/", views.CompletionView.as_view(), name="completion_page"),
     path(
         "survey_response/<str:token>",
diff --git a/survey/views.py b/survey/views.py
@@ -9,12 +9,18 @@
 from django.contrib.auth.mixins import LoginRequiredMixin
 from django.core.exceptions import PermissionDenied
 from django.core.files.uploadhandler import UploadFileException
-from django.http import HttpRequest, HttpResponse
+from django.http import HttpRequest, HttpResponse, HttpResponseNotAllowed
 from django.shortcuts import get_object_or_404, redirect, render
 from django.template.context_processors import csrf
 from django.urls import reverse, reverse_lazy
 from django.views import View
-from django.views.generic import DeleteView, FormView, UpdateView
+from django.views.generic import (
+    DeleteView,
+    FormView,
+    UpdateView,
+    DetailView,
+    TemplateView,
+)
 from django.views.generic.edit import CreateView
 
 from home.models import Project
@@ -29,6 +35,7 @@
     SurveyResponse,
 )
 from .services.survey import InvalidInviteTokenException
+from .exceptions import SurveyInactiveError
 
 logger = logging.getLogger(__name__)
 
@@ -169,6 +176,7 @@ def render_survey_config_view(self, request: HttpRequest, pk: int, is_post: bool
             context=context,
         )
 
+
 class SurveyDuplicateConfigView(LoginRequiredMixin, View):
     def get(self, request: HttpRequest, pk: int):
         survey = survey_service.get_survey(request.user, pk)
@@ -474,10 +482,12 @@ def render_survey_response_page(
     ):
 
         try:
-
             survey = survey_service.get_survey_from_token(token)
+            if not survey.is_active:
+                raise SurveyInactiveError("Survey is not active.")
+
             # Context for rendering
-            context = {}
+            context = dict()
 
             if is_post:
                 # Only process if it's a post request
@@ -501,6 +511,9 @@ def render_survey_response_page(
         except InvalidInviteTokenException:
             return redirect("survey_link_invalid")
 
+        except SurveyInactiveError:
+            return redirect("survey_response_inactive")
+
 
 class SurveyLinkInvalidView(View):
     """
@@ -559,3 +572,72 @@ def form_valid(self, form):
 
     def get_success_url(self):
         return reverse_lazy("invite", kwargs=dict(pk=self.kwargs["pk"]))
+
+
+class SurveyActivateView(LoginRequiredMixin, DetailView):
+    """
+    Activate response collection for this survey.
+    """
+
+    model = Survey
+
+    def get(self, request, *args, **kwargs):
+        """
+        We don't need to confirm activation, so no detail view template is used.
+        """
+        return HttpResponseNotAllowed(["POST"])
+
+    def activate(self):
+        """
+        Activate the survey.
+        """
+        self.object.is_active = True
+        self.object.save()
+
+    def post(self, request, *args, **kwargs):
+        """
+        Update the survey.
+        """
+        self.object = self.get_object()
+        self.activate()
+        messages.success(request, "Survey activated")
+        return redirect(self.object.get_absolute_url())
+
+
+class SurveyDeactivateView(LoginRequiredMixin, DetailView):
+    """
+    Deactivate response collection for this survey.
+
+    The user must confirm that they want to pause data collection.
+    """
+
+    model = Survey
+    context_object_name = "survey"
+    template_name = "survey/deactivate_confirm.html"
+
+    def deactivate(self):
+        self.object.is_active = False
+        self.object.save()
+
+    def post(self, request, *args, **kwargs):
+        self.object = self.get_object()
+        is_confirmed: bool = bool(int(request.POST.get("confirm", "0")))
+
+        # Confirmed
+        if is_confirmed:
+            self.deactivate()
+            messages.warning(request, "Survey deactivated")
+        # Unconfirmed
+        else:
+            messages.error(
+                request, "Please confirm that you want to pause this survey."
+            )
+        return redirect(self.object.get_absolute_url())
+
+
+class SurveyResponseInactiveView(TemplateView):
+    """
+    Show when a survey is inactive.
+    """
+
+    template_name = "survey/survey_response_inactive.html"
