Handle invalid values of nulls with 404 setting

Author: stephane

testproj/testproj/testapp/tests.py

@@ -1,8 +1,8 @@
 import django.template as django_template
 from django.template.engine import Engine
 from django.template.response import SimpleTemplateResponse
-from django.test import TestCase
 from django.urls import reverse
+from webstack_django_sorting import settings
 
 from . import models
 
@@ -99,3 +99,16 @@ def test_sorting_nulls_last(self):
             self.nulls_last_url, {"sort": "filename", "nulls": "last", "dir": "desc"}
         )
         self.assertQuerysetEqual(list(response.context["secret_files"]), values)
+
+    def test_check_values(self):
+        # Internal INVALID_FIELD_RAISES_404 is set at loading (no override_settings)
+        saved = settings.INVALID_FIELD_RAISES_404
+        try:
+            settings.INVALID_FIELD_RAISES_404 = True
+            response = self.client.get(
+                self.nulls_last_url, {"sort": "filename", "nulls": "foo", "dir": "asc"}
+            )
+        finally:
+            settings.INVALID_FIELD_RAISES_404 = saved
+
+        self.assertEqual(response.status_code, 404)

webstack_django_sorting/common.py

@@ -4,17 +4,18 @@
 from operator import attrgetter
 
 from django.db.models import F
+from django.http import Http404
 
-from .settings import SORT_DIRECTIONS
+from . import settings
 
 
 def render_sort_anchor(request, field_name, title):
     get_params = request.GET.copy()
     sort_by = get_params.get("sort", None)
     if sort_by == field_name:
         # Render anchor link to next direction
-        current_direction = SORT_DIRECTIONS.get(
-            get_params.get("dir", ""), SORT_DIRECTIONS[""]
+        current_direction = settings.SORT_DIRECTIONS.get(
+            get_params.get("dir", ""), settings.SORT_DIRECTIONS[""]
         )
         icon = current_direction["icon"]
         next_direction_code = current_direction["next"]
@@ -89,6 +90,13 @@ def get_null_ordering(request, default_template_ordering=None):
     # Prioritize changes in URL parameter over the default template variable
     nulls_value = request.GET.get("nulls", default_template_ordering)
     if nulls_value:
+        if nulls_value not in ("first", "last"):
+            if settings.INVALID_FIELD_RAISES_404:
+                raise Http404("The nulls query paramater should be 'first' or 'last'.")
+
+            # Else ignores invalid values
+            return {}
+
         return {f"nulls_{nulls_value}": True}
 
     return {}

webstack_django_sorting/templatetags/sorting_tags.py

@@ -2,8 +2,7 @@
 from django.http import Http404
 from django.utils.translation import gettext_lazy as _
 
-from .. import common
-from ..settings import INVALID_FIELD_RAISES_404
+from .. import common, settings
 
 register = template.Library()
 
@@ -81,17 +80,16 @@ def autosort(parser, token):
     if 2 > len(bits) > 7:
         raise template.TemplateSyntaxError(help_msg)
 
-
     context_var = None
     null_ordering = None
 
     for index, bit in enumerate(bits):
         if index > 1:
-            if bit == 'as' and index + 1 < len(bits):
+            if bit == "as" and index + 1 < len(bits):
                 context_var = bits[index + 1]
-                del bits[index:index + 1]
-            if bit.startswith('nulls'):
-                null_ordering = bit[len('nulls='):]
+                del bits[index : index + 1]
+            if bit.startswith("nulls"):
+                null_ordering = bit[len("nulls=") :]
 
     return SortedDataNode(bits[1], null_ordering, context_var=context_var)
 
@@ -114,14 +112,16 @@ def render(self, context):
 
         queryset = self.queryset_var.resolve(context)
         order_by = common.get_order_by_from_request(context["request"])
-        self.null_ordering = common.get_null_ordering(context["request"], self.null_ordering)
+        self.null_ordering = common.get_null_ordering(
+            context["request"], self.null_ordering
+        )
 
         try:
             context[key] = common.sort_queryset(queryset, order_by, self.null_ordering)
         except ValueError as e:
             raise template.TemplateSyntaxError from e
         except AttributeError:
-            if INVALID_FIELD_RAISES_404:
+            if settings.INVALID_FIELD_RAISES_404:
                 raise Http404(
                     "Invalid field sorting. If INVALID_FIELD_RAISES_404 were set to "
                     "False, the error would have been ignored."