Add 3.2 fix for pagination

mhindery · mhindery · commit 1ae3701df780 · 2021-04-28T12:44:10.000+02:00
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -4,6 +4,11 @@ Changelog
 Only important changes are mentioned below. See `commit log <https://github.com/darklow/django-suit/commits/develop>`_, `closed issues <https://github.com/darklow/django-suit/issues?direction=desc&sort=updated&state=closed>`_ and `closed pull
 requests <https://github.com/darklow/django-suit/pulls?q=sort%3Aupdated-desc+is%3Apr+is%3Aclosed>`_ for full changes.
 
+v.0.2.29 (2021-04-28)
+--------------------
+* This is a 'maintenance fork' which contains some fixes for compatibility with the latest Django releases.
+
+
 v0.2.28 (2019-10-02)
 --------------------
 
diff --git a/docs/conf.py b/docs/conf.py
@@ -56,7 +56,7 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.2.28'
+version = '0.2.29'
 # The full version, including alpha/beta/rc tags.
 release = version
 
diff --git a/suit/__init__.py b/suit/__init__.py
@@ -1 +1 @@
-VERSION = '0.2.28'
+VERSION = '0.2.29'
diff --git a/suit/static/suit/css/suit.css b/suit/static/suit/css/suit.css
diff --git a/suit/static/suit/less/ui/pagination.less b/suit/static/suit/less/ui/pagination.less
@@ -9,6 +9,9 @@
     ul {
         margin: 0;
     }
+
+    // Up until Django 3.2
+
     ul li.active a, ul li.active span {
         color: #fff;
         font-weight: bold;
@@ -29,6 +32,70 @@
         line-height: 26px;
         padding: 0 10px;
     }
+
+
+    // Starting with Django 3.2
+
+    // Pages
+    ul a {
+        display: inline;
+        line-height: 26px;
+        padding: 0 10px;
+
+        float: left;
+
+        // padding: 4px 12px;
+        // line-height: 18px;
+        text-decoration: none;
+        background-color: #ffffff;
+        border: 1px solid #dddddd;
+        border-left-width: 0;
+
+        color: #0088cc;
+    }
+
+    // Ellipsis
+    ul span.disabled {
+        display: inline;
+        line-height: 26px;
+        padding: 0 10px;
+
+        float: left;
+
+        // padding: 4px 12px;
+        // line-height: 18px;
+        text-decoration: none;
+        background-color: transparent;
+        border: 1px solid #dddddd;
+        border-left-width: 0;
+
+        color: #999999;
+    }
+    
+    // Active page
+    ul span.this-page {
+        display: inline;
+        line-height: 26px;
+        padding: 0 10px;
+
+        float: left;
+
+        text-decoration: none;
+        background-color: #2f96b4;
+        border: 1px solid #cccccc;
+        border-left-width: 0;
+
+        color: #ffffff;
+
+        // Border
+        border-left-width: 1px;
+        -webkit-border-top-left-radius: 4px;
+        -moz-border-radius-topleft: 4px;
+        border-top-left-radius: 4px;
+        -webkit-border-bottom-left-radius: 4px;
+        -moz-border-radius-bottomleft: 4px;
+        border-bottom-left-radius: 4px;
+    }
 }
 
 .pagination-info {
diff --git a/suit/templatetags/suit_list.py b/suit/templatetags/suit_list.py
@@ -1,13 +1,23 @@
 from copy import copy
 from inspect import getargspec
+
+import django
+
 from django import template
 from django.template.loader import get_template
 from django.utils.safestring import mark_safe
 from django.contrib.admin.templatetags.admin_list import result_list
 from django.contrib.admin.views.main import ALL_VAR, PAGE_VAR
 from django.utils.html import escape
+from django.utils.html import format_html
 from suit.compat import tpl_context_class
 
+# Starting with Django 3.2, the pagination is 1-based instead of 0-based.
+# I've taken the implementations (latest at the time of release 3.2) from https://github.com/django/django/blob/main/django/contrib/admin/templatetags/admin_list.py
+# to use in the implementations below. Older versions of django will use the old implementation and will keep working.
+# There are corresponding CSS changes in suit/static/suit/less/ui/pagination.less to fix the pagination, as the code below generates different html objects.
+USE_NEW_DJANGO_ADMIN_PAGINATION = django.get_version() >= '3.2'
+
 try:
     # Python 3.
     from urllib.parse import parse_qs
@@ -24,39 +34,68 @@
 
 register = template.Library()
 
+
 DOT = '.'
 
 
 @register.simple_tag
 def paginator_number(cl, i):
     """
-    Generates an individual page index link in a paginated list.
+    Generate an individual page index link in a paginated list.
     """
-    if i == DOT:
-        return mark_safe(
-                '<li class="disabled"><a href="#" onclick="return false;">..'
-                '.</a></li>')
+    if not USE_NEW_DJANGO_ADMIN_PAGINATION:
+        if i == DOT:
+            return mark_safe(
+                    '<li class="disabled"><a href="#" onclick="return false;">..'
+                    '.</a></li>')
+        elif i == cl.page_num:
+            return mark_safe(
+                '<li class="active"><a href="">%d</a></li> ' % (i + 1))
+        else:
+            return mark_safe('<li><a href="%s"%s>%d</a></li> ' % (
+                escape(cl.get_query_string({PAGE_VAR: i})),
+                (i == cl.paginator.num_pages - 1 and ' class="end"' or ''),
+                i + 1))
+
+    if i == cl.paginator.ELLIPSIS:
+        return format_html('<span class="disabled">{}</span> ', cl.paginator.ELLIPSIS)
     elif i == cl.page_num:
-        return mark_safe(
-            '<li class="active"><a href="">%d</a></li> ' % (i + 1))
+        return format_html('<span class="this-page">{}</span> ', i)
     else:
-        return mark_safe('<li><a href="%s"%s>%d</a></li> ' % (
-            escape(cl.get_query_string({PAGE_VAR: i})),
-            (i == cl.paginator.num_pages - 1 and ' class="end"' or ''),
-            i + 1))
+        return format_html(
+            '<a href="{}"{}>{}</a> ',
+            cl.get_query_string({PAGE_VAR: i}),
+            mark_safe(' class="end"' if i == cl.paginator.num_pages else ''),
+            i,
+        )
 
 
 @register.simple_tag
 def paginator_info(cl):
+    if not USE_NEW_DJANGO_ADMIN_PAGINATION:
+        paginator = cl.paginator
+
+        # If we show all rows of list (without pagination)
+        if cl.show_all and cl.can_show_all:
+            entries_from = 1 if paginator.count > 0 else 0
+            entries_to = paginator.count
+        else:
+            entries_from = (
+                (paginator.per_page * cl.page_num) + 1) if paginator.count > 0 else 0
+            entries_to = entries_from - 1 + paginator.per_page
+            if paginator.count < entries_to:
+                entries_to = paginator.count
+
+        return '%s - %s' % (entries_from, entries_to)
+
     paginator = cl.paginator
 
     # If we show all rows of list (without pagination)
     if cl.show_all and cl.can_show_all:
         entries_from = 1 if paginator.count > 0 else 0
         entries_to = paginator.count
     else:
-        entries_from = (
-            (paginator.per_page * cl.page_num) + 1) if paginator.count > 0 else 0
+        entries_from = ((paginator.per_page * (cl.page_num - 1)) + 1) if paginator.count > 0 else 0
         entries_to = entries_from - 1 + paginator.per_page
         if paginator.count < entries_to:
             entries_to = paginator.count
@@ -67,48 +106,61 @@ def paginator_info(cl):
 @register.inclusion_tag('admin/pagination.html')
 def pagination(cl):
     """
-    Generates the series of links to the pages in a paginated list.
+    Generate the series of links to the pages in a paginated list.
     """
-    paginator, page_num = cl.paginator, cl.page_num
+    if not USE_NEW_DJANGO_ADMIN_PAGINATION:
+        paginator, page_num = cl.paginator, cl.page_num
 
-    pagination_required = (not cl.show_all or not cl.can_show_all) \
-        and cl.multi_page
-    if not pagination_required:
-        page_range = []
-    else:
-        ON_EACH_SIDE = 3
-        ON_ENDS = 2
-
-        # If there are 10 or fewer pages, display links to every page.
-        # Otherwise, do some fancy
-        if paginator.num_pages <= 8:
-            page_range = range(paginator.num_pages)
-        else:
-            # Insert "smart" pagination links, so that there are always ON_ENDS
-            # links at either end of the list of pages, and there are always
-            # ON_EACH_SIDE links at either end of the "current page" link.
+        pagination_required = (not cl.show_all or not cl.can_show_all) \
+            and cl.multi_page
+        if not pagination_required:
             page_range = []
-            if page_num > (ON_EACH_SIDE + ON_ENDS):
-                page_range.extend(range(0, ON_EACH_SIDE - 1))
-                page_range.append(DOT)
-                page_range.extend(range(page_num - ON_EACH_SIDE, page_num + 1))
-            else:
-                page_range.extend(range(0, page_num + 1))
-            if page_num < (paginator.num_pages - ON_EACH_SIDE - ON_ENDS - 1):
-                page_range.extend(
-                    range(page_num + 1, page_num + ON_EACH_SIDE + 1))
-                page_range.append(DOT)
-                page_range.extend(
-                    range(paginator.num_pages - ON_ENDS, paginator.num_pages))
-            else:
-                page_range.extend(range(page_num + 1, paginator.num_pages))
+        else:
+            ON_EACH_SIDE = 3
+            ON_ENDS = 2
 
+            # If there are 10 or fewer pages, display links to every page.
+            # Otherwise, do some fancy
+            if paginator.num_pages <= 8:
+                page_range = range(paginator.num_pages)
+            else:
+                # Insert "smart" pagination links, so that there are always ON_ENDS
+                # links at either end of the list of pages, and there are always
+                # ON_EACH_SIDE links at either end of the "current page" link.
+                page_range = []
+                if page_num > (ON_EACH_SIDE + ON_ENDS):
+                    page_range.extend(range(0, ON_EACH_SIDE - 1))
+                    page_range.append(DOT)
+                    page_range.extend(range(page_num - ON_EACH_SIDE, page_num + 1))
+                else:
+                    page_range.extend(range(0, page_num + 1))
+                if page_num < (paginator.num_pages - ON_EACH_SIDE - ON_ENDS - 1):
+                    page_range.extend(
+                        range(page_num + 1, page_num + ON_EACH_SIDE + 1))
+                    page_range.append(DOT)
+                    page_range.extend(
+                        range(paginator.num_pages - ON_ENDS, paginator.num_pages))
+                else:
+                    page_range.extend(range(page_num + 1, paginator.num_pages))
+
+        need_show_all_link = cl.can_show_all and not cl.show_all and cl.multi_page
+        return {
+            'cl': cl,
+            'pagination_required': pagination_required,
+            'show_all_url': need_show_all_link and cl.get_query_string(
+                {ALL_VAR: ''}),
+            'page_range': page_range,
+            'ALL_VAR': ALL_VAR,
+            '1': 1,
+        }
+
+    pagination_required = (not cl.show_all or not cl.can_show_all) and cl.multi_page
+    page_range = cl.paginator.get_elided_page_range(cl.page_num) if pagination_required else []
     need_show_all_link = cl.can_show_all and not cl.show_all and cl.multi_page
     return {
         'cl': cl,
         'pagination_required': pagination_required,
-        'show_all_url': need_show_all_link and cl.get_query_string(
-            {ALL_VAR: ''}),
+        'show_all_url': need_show_all_link and cl.get_query_string({ALL_VAR: ''}),
         'page_range': page_range,
         'ALL_VAR': ALL_VAR,
         '1': 1,

Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@`
`56`	`56`	`# built documents.`
`57`	`57`	`#`
`58`	`58`	`# The short X.Y version.`
`59`		`-version = '0.2.28'`
	`59`	`+version = '0.2.29'`
`60`	`60`	`# The full version, including alpha/beta/rc tags.`
`61`	`61`	`release = version`
`62`	`62`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-VERSION = '0.2.28'`
	`1`	`+VERSION = '0.2.29'`