New settings for basic pagination customization, backwards compatible:

[django-pagination.git] / pagination / templatetags / pagination_tags.py

diff --git a/pagination/templatetags/pagination_tags.py b/pagination/templatetags/pagination_tags.py
index aa5297a..f7de347 100644 (file)
--- a/pagination/templatetags/pagination_tags.py
+++ b/pagination/templatetags/pagination_tags.py
@@ -2,8 +2,9 @@ try:
     set
 except NameError:
     from sets import Set as set
+
 from django import template
-from django.db.models.query import QuerySet
+from django.http import Http404
 from django.core.paginator import Paginator, InvalidPage
 from django.conf import settings
 
@@ -12,6 +13,13 @@ register = template.Library()
 DEFAULT_PAGINATION = getattr(settings, 'PAGINATION_DEFAULT_PAGINATION', 20)
 DEFAULT_WINDOW = getattr(settings, 'PAGINATION_DEFAULT_WINDOW', 4)
 DEFAULT_ORPHANS = getattr(settings, 'PAGINATION_DEFAULT_ORPHANS', 0)
+INVALID_PAGE_RAISES_404 = getattr(settings,
+    'PAGINATION_INVALID_PAGE_RAISES_404', False)
+DISPLAY_PAGE_LINKS = getattr(settings, 'PAGINATION_DISPLAY_PAGE_LINKS', True)
+PREVIOUS_LINK_DECORATOR = getattr(settings, 'PAGINATION_PREVIOUS_LINK_DECORATOR', "‹‹ ")
+NEXT_LINK_DECORATOR = getattr(settings, 'PAGINATION_NEXT_LINK_DECORATOR', " ››")
+DISPLAY_DISABLED_PREVIOUS_LINK = getattr(settings, 'PAGINATION_DISPLAY_DISABLED_PREVIOUS_LINK', True)
+DISPLAY_DISABLED_NEXT_LINK = getattr(settings, 'PAGINATION_DISPLAY_DISABLED_NEXT_LINK', True)
 
 def do_autopaginate(parser, token):
     """
@@ -28,8 +36,8 @@ def do_autopaginate(parser, token):
         try:
             context_var = split[as_index + 1]
         except IndexError:
-            raise template.TemplateSyntaxError("Context variable assignment " +\
-                "must take the form of {%% %r object.example_set.all ... as " +\
+            raise template.TemplateSyntaxError("Context variable assignment " +
+                "must take the form of {%% %r object.example_set.all ... as " +
                 "context_var_name %%}" % split[0])
         del split[as_index:as_index + 2]
     if len(split) == 2:
@@ -41,11 +49,12 @@ def do_autopaginate(parser, token):
         try:
             orphans = int(split[3])
         except ValueError:
-            raise template.TemplateSyntaxError(u'Got %s, but expected integer.' % split[3])
+            raise template.TemplateSyntaxError(u'Got %s, but expected integer.'
+                % split[3])
         return AutoPaginateNode(split[1], paginate_by=split[2], orphans=orphans,
             context_var=context_var)
     else:
-        raise template.TemplateSyntaxError('%r tag takes one required ' + \
+        raise template.TemplateSyntaxError('%r tag takes one required ' +
             'argument and one optional argument' % split[0])
 
 class AutoPaginateNode(template.Node):
@@ -86,6 +95,9 @@ class AutoPaginateNode(template.Node):
         try:
             page_obj = paginator.page(context['request'].page)
         except InvalidPage:
+            if INVALID_PAGE_RAISES_404:
+                raise Http404('Invalid page requested.  If DEBUG were set to ' +
+                    'False, an HTTP 404 page would have been shown instead.')
             context[key] = []
             context['invalid_page'] = True
             return u''
@@ -97,7 +109,8 @@ class AutoPaginateNode(template.Node):
         context['page_obj'] = page_obj
         return u''
 
-def paginate(context, window=DEFAULT_WINDOW):
+
+def paginate(context, window=DEFAULT_WINDOW, hashtag=''):
     """
     Renders the ``pagination/pagination.html`` template, resulting in a
     Digg-like display of the available pages, given the current page.  If there
@@ -126,6 +139,11 @@ def paginate(context, window=DEFAULT_WINDOW):
         paginator = context['paginator']
         page_obj = context['page_obj']
         page_range = paginator.page_range
+        # Calculate the record range in the current page for display.
+        records = {'first': 1 + (page_obj.number - 1) * paginator.per_page}
+        records['last'] = records['first'] + paginator.per_page - 1
+        if records['last'] + paginator.orphans >= paginator.count:
+            records['last'] = paginator.count
         # First and last are simply the first *n* pages and the last *n* pages,
         # where *n* is the current window size.
         first = set(page_range[:window])
@@ -145,7 +163,7 @@ def paginate(context, window=DEFAULT_WINDOW):
         if len(first.intersection(current)) == 0:
             first_list = list(first)
             first_list.sort()
-            second_list = list(second)
+            second_list = list(current)
             second_list.sort()
             pages.extend(first_list)
             diff = second_list[0] - first_list[-1]
@@ -192,10 +210,18 @@ def paginate(context, window=DEFAULT_WINDOW):
             differenced.sort()
             pages.extend(differenced)
         to_return = {
+            'MEDIA_URL': settings.MEDIA_URL,
             'pages': pages,
+            'records': records,
             'page_obj': page_obj,
             'paginator': paginator,
+            'hashtag': hashtag,
             'is_paginated': paginator.count > paginator.per_page,
+            'display_page_links': DISPLAY_PAGE_LINKS,
+            'display_disabled_previous_link': DISPLAY_DISABLED_PREVIOUS_LINK,
+            'display_disabled_next_link': DISPLAY_DISABLED_NEXT_LINK,
+            'previous_link_decorator': PREVIOUS_LINK_DECORATOR,
+            'next_link_decorator': NEXT_LINK_DECORATOR,
         }
         if 'request' in context:
             getvars = context['request'].GET.copy()
@@ -208,5 +234,7 @@ def paginate(context, window=DEFAULT_WINDOW):
         return to_return
     except KeyError, AttributeError:
         return {}
-register.inclusion_tag('pagination/pagination.html', takes_context=True)(paginate)
+
+register.inclusion_tag('pagination/pagination.html', takes_context=True)(
+    paginate)
 register.tag('autopaginate', do_autopaginate)