Feat: Pagination improved in the UI

Signed-off-by: Rishi Garg <rishigarg2503@gmail.com>

Author: Rishi-garg03

vulnerabilities/pagination.py

@@ -1,6 +1,143 @@
+import logging
+import re
+
+from django.core.paginator import Paginator
+from django.db.models.query import QuerySet
 from rest_framework.pagination import PageNumberPagination
 
+logger = logging.getLogger(__name__)
+
 
 class SmallResultSetPagination(PageNumberPagination):
     page_size_query_param = "page_size"
     max_page_size = 100
+
+
+class PaginatedListViewMixin:
+    """
+    A mixin that adds pagination functionality to ListView-based views.
+    """
+
+    paginate_by = 20
+    max_page_size = 100
+    PAGE_SIZE_CHOICES = [
+        {"value": 20, "label": "20 per page"},
+        {"value": 50, "label": "50 per page"},
+        {"value": 100, "label": "100 per page"},
+    ]
+
+    def get_queryset(self):
+        """
+        Ensure a queryset is always available
+        """
+        try:
+            queryset = super().get_queryset()
+            if not queryset:
+                queryset = self.model.objects.all()
+            if not isinstance(queryset, QuerySet):
+                queryset = self.model.objects.all()
+            return queryset
+        except Exception as e:
+            logger.error(f"Error in get_queryset: {e}")
+            return self.model.objects.all()
+
+    def sanitize_page_size(self, raw_page_size):
+        """
+        Sanitize page size input to prevent XSS and injection attempts.
+        """
+        if not raw_page_size:
+            return self.paginate_by
+        clean_page_size = re.sub(r"\D", "", str(raw_page_size))
+        try:
+            page_size = int(clean_page_size) if clean_page_size else self.paginate_by
+            valid_sizes = {choice["value"] for choice in self.PAGE_SIZE_CHOICES}
+            if page_size not in valid_sizes:
+                logger.warning(f"Attempted to use unauthorized page size: {page_size}")
+                return self.paginate_by
+            return page_size
+        except (ValueError, TypeError):
+            logger.info("Empty or invalid page_size input attempted")
+            return self.paginate_by
+
+    def get_paginate_by(self, queryset=None):
+        """
+        Get the number of items to paginate by from the request.
+        """
+        raw_page_size = self.request.GET.get("page_size")
+        return self.sanitize_page_size(raw_page_size)
+
+    def get_page_range(self, paginator, page_obj):
+        """
+        Generate a list of page numbers for navigation
+        """
+        num_pages = paginator.num_pages
+        current_page = page_obj.number
+        if num_pages <= 7:
+            return list(range(1, num_pages + 1))
+        pages = []
+        pages.append(1)
+        if current_page > 4:
+            pages.append("...")
+        start = max(2, current_page - 2)
+        end = min(num_pages - 1, current_page + 2)
+        pages.extend(range(start, end + 1))
+        if current_page < num_pages - 3:
+            pages.append("...")
+        if num_pages > 1:
+            pages.append(num_pages)
+        return [str(p) for p in pages]
+
+    def paginate_queryset(self, queryset, page_size):
+        try:
+            if not queryset or queryset.count() == 0:
+                queryset = self.model.objects.all()
+            paginator = Paginator(queryset, page_size)
+            page_params = self.request.GET.getlist("page")
+            page_number = page_params[-1] if page_params else "1"
+            try:
+                page_number = int(re.sub(r"\D", "", str(page_number)))
+                if not page_number:
+                    page_number = 1
+            except (ValueError, TypeError):
+                page_number = 1
+            page_number = max(1, min(page_number, paginator.num_pages))
+            page = paginator.page(page_number)
+            return (paginator, page, page.object_list, page.has_other_pages())
+        except Exception as e:
+            logger.error(f"Pagination error: {e}")
+            queryset = self.model.objects.all()
+            paginator = Paginator(queryset, page_size)
+            page = paginator.page(1)
+            return (paginator, page, page.object_list, page.has_other_pages())
+
+    def get_context_data(self, **kwargs):
+        """
+        Return a mapping of pagination-related context data, preserving filters.
+        """
+        queryset = self.get_queryset()
+        page_size = self.get_paginate_by()
+        paginator, page, object_list, is_paginated = self.paginate_queryset(queryset, page_size)
+        page_range = self.get_page_range(paginator, page)
+
+        search = self.request.GET.get("search", "")
+
+        context = super().get_context_data(
+            object_list=object_list,
+            page_obj=page,
+            paginator=paginator,
+            is_paginated=is_paginated,
+            **kwargs,
+        )
+
+        context.update(
+            {
+                "current_page_size": page_size,
+                "page_size_choices": self.PAGE_SIZE_CHOICES,
+                "total_count": paginator.count,
+                "page_range": page_range,
+                "search": search,
+                "previous_page_url": page.previous_page_number() if page.has_previous() else None,
+                "next_page_url": page.next_page_number() if page.has_next() else None,
+            }
+        )
+        return context

vulnerabilities/tests/test_pagination.py

@@ -0,0 +1,121 @@
+from django.test import TestCase
+from django.urls import reverse
+
+from vulnerabilities.models import Package
+
+
+class PaginationFunctionalityTests(TestCase):
+    @classmethod
+    def setUpTestData(cls):
+        for i in range(150):
+            Package.objects.create(
+                type="test",
+                namespace="test",
+                name=f"package{i}",
+                version=str(i),
+                qualifiers={},
+                subpath="",
+            )
+
+    def test_default_pagination(self):
+        response = self.client.get(reverse("package_search"))
+        self.assertEqual(response.status_code, 200)
+        page_obj = response.context["page_obj"]
+        self.assertIsNotNone(page_obj)
+        self.assertEqual(len(page_obj.object_list), 20)
+        self.assertEqual(response.context["total_count"], 150)
+        self.assertEqual(response.context["current_page_size"], 20)
+
+    def test_page_size_variations(self):
+        valid_page_sizes = [20, 50, 100]
+        for size in valid_page_sizes:
+            url = f"{reverse('package_search')}?page_size={size}"
+            response = self.client.get(url)
+            self.assertEqual(response.status_code, 200)
+            self.assertIn(response.context["current_page_size"], [20, size])
+
+    def test_page_navigation(self):
+        response = self.client.get(reverse("package_search"))
+        first_page = response.context["page_obj"]
+        self.assertEqual(first_page.number, 1)
+        self.assertTrue(first_page.has_next())
+        self.assertFalse(first_page.has_previous())
+        self.assertGreater(first_page.paginator.num_pages, 1)
+
+
+class PaginationSecurityTests(TestCase):
+    @classmethod
+    def setUpTestData(cls):
+        for i in range(50):
+            Package.objects.create(
+                type="test",
+                namespace="test",
+                name=f"package{i}",
+                version=str(i),
+                qualifiers={},
+                subpath="",
+            )
+
+    def test_invalid_page_size_inputs(self):
+        malicious_inputs = [
+            "abc",
+            "-10",
+            "0",
+            "9999999999",
+            "11",
+            "<script>",
+            "../../etc/passwd",
+            "' OR 1=1 --",
+            "",
+        ]
+        for input_value in malicious_inputs:
+            url = f"{reverse('package_search')}?page_size={input_value}"
+            response = self.client.get(url)
+            self.assertEqual(response.status_code, 200)
+            self.assertEqual(response.context["current_page_size"], 20)
+
+    def test_sql_injection_prevention(self):
+        sql_injection_payloads = [
+            "1' OR '1'='1",
+            "1; DROP TABLE packages;",
+            "' UNION SELECT * FROM auth_user--",
+            "1 OR 1=1",
+        ]
+        initial_package_count = Package.objects.count()
+        for payload in sql_injection_payloads:
+            urls = [
+                f"{reverse('package_search')}?page={payload}",
+                f"{reverse('package_search')}?page_size={payload}",
+            ]
+            for url in urls:
+                response = self.client.get(url)
+                self.assertEqual(response.status_code, 200)
+            self.assertEqual(Package.objects.count(), initial_package_count)
+
+
+class PaginationEdgeCaseTests(TestCase):
+    @classmethod
+    def setUpTestData(cls):
+        for i in range(5):
+            Package.objects.create(
+                type="test",
+                namespace="test",
+                name=f"package{i}",
+                version=str(i),
+            )
+
+    def test_small_dataset_pagination(self):
+        response = self.client.get(reverse("package_search"))
+        self.assertEqual(response.status_code, 200)
+        self.assertLessEqual(len(response.context["page_obj"].object_list), 20)
+
+    def test_out_of_range_page_number(self):
+        out_of_range_urls = [
+            f"{reverse('package_search')}?page=9999",
+            f"{reverse('package_search')}?page=-5",
+            f"{reverse('package_search')}?page=abc",
+        ]
+        for url in out_of_range_urls:
+            response = self.client.get(url)
+            self.assertEqual(response.status_code, 200)
+            self.assertEqual(response.context["page_obj"].number, 1)

vulnerabilities/tests/test_view.py

@@ -26,6 +26,8 @@
 from vulnerabilities.utils import get_purl_version_class
 from vulnerabilities.views import PackageDetails
 from vulnerabilities.views import PackageSearch
+from vulnerabilities.views import get_purl_version_class
+from vulnerabilities.views import purl_sort_key
 
 BASE_DIR = os.path.dirname(os.path.abspath(__file__))
 TEST_DIR = os.path.join(BASE_DIR, "test_data/package_sort")
@@ -58,14 +60,17 @@ def setUp(self):
             Package.objects.create(**attrs)
 
     def test_packages_search_view_paginator(self):
-        response = self.client.get("/packages/search?type=deb&name=&page=1")
-        self.assertEqual(response.status_code, 200)
-        response = self.client.get("/packages/search?type=deb&name=&page=*")
-        self.assertEqual(response.status_code, 404)
-        response = self.client.get("/packages/search?type=deb&name=&page=")
-        self.assertEqual(response.status_code, 200)
-        response = self.client.get("/packages/search?type=&name=&page=")
-        self.assertEqual(response.status_code, 200)
+        test_cases = [
+            ("/packages/search?type=deb&name=&page=1", 200),
+            ("/packages/search?type=deb&name=&page=*", 200),
+            ("/packages/search?type=deb&name=&page=", 200),
+            ("/packages/search?type=&name=&page=", 200),
+        ]
+        for url, expected_status in test_cases:
+            response = self.client.get(url)
+            self.assertEqual(response.status_code, expected_status)
+            if "*" in url or "&page=" in url:
+                self.assertEqual(response.context["page_obj"].number, 1)
 
     def test_package_view(self):
         qs = PackageSearch().get_queryset(query="pkg:nginx/nginx@1.0.15?foo=bar")

vulnerabilities/views.py

@@ -35,10 +35,12 @@
 from vulnerablecode import __version__ as VULNERABLECODE_VERSION
 from vulnerablecode.settings import env
 
+from .pagination import PaginatedListViewMixin
+
 PAGE_SIZE = 20
 
 
-class PackageSearch(ListView):
+class PackageSearch(PaginatedListViewMixin, ListView):
     model = models.Package
     template_name = "packages.html"
     ordering = ["type", "namespace", "name", "version"]
@@ -66,7 +68,7 @@ def get_queryset(self, query=None):
         )
 
 
-class VulnerabilitySearch(ListView):
+class VulnerabilitySearch(PaginatedListViewMixin, ListView):
     model = models.Vulnerability
     template_name = "vulnerabilities.html"
     ordering = ["vulnerability_id"]