set
except NameError:
from sets import Set as set
+
from django import template
-from django.db.models.query import QuerySet
+from django.template import TOKEN_BLOCK
+from django.http import Http404
from django.core.paginator import Paginator, InvalidPage
from django.conf import settings
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', False)
+DISPLAY_DISABLED_NEXT_LINK = getattr(settings, 'PAGINATION_DISPLAY_DISABLED_NEXT_LINK', False)
def do_autopaginate(parser, token):
"""
Splits the arguments to the autopaginate tag and formats them correctly.
"""
+
+ # Check whether there are any other autopaginations are later in this template
+ expr = lambda obj: (obj.token_type == TOKEN_BLOCK and \
+ len(obj.split_contents()) > 0 and obj.split_contents()[0] == "autopaginate")
+ multiple_paginations = len(filter(expr, parser.tokens)) > 0
+
split = token.split_contents()
+ as_index = None
+ context_var = None
+ for i, bit in enumerate(split):
+ if bit == 'as':
+ as_index = i
+ break
+ if as_index is not None:
+ 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 " +
+ "context_var_name %%}" % split[0])
+ del split[as_index:as_index + 2]
if len(split) == 2:
- return AutoPaginateNode(split[1])
+ return AutoPaginateNode(split[1], multiple_paginations=multiple_paginations)
elif len(split) == 3:
- try:
- paginate_by = int(split[2])
- except ValueError:
- raise template.TemplateSyntaxError(u'Got %s, but expected integer.' % split[2])
- return AutoPaginateNode(split[1], paginate_by=paginate_by)
+ return AutoPaginateNode(split[1], paginate_by=split[2],
+ context_var=context_var, multiple_paginations=multiple_paginations)
elif len(split) == 4:
- try:
- paginate_by = int(split[2])
- except ValueError:
- raise template.TemplateSyntaxError(u'Got %s, but expected integer.' % split[2])
try:
orphans = int(split[3])
except ValueError:
- raise template.TemplateSyntaxError(u'Got %s, but expected integer.' % split[3])
- return AutoPaginateNode(split[1], paginate_by=paginate_by, orphans=orphans)
+ 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, multiple_paginations=multiple_paginations)
else:
- raise template.TemplateSyntaxError('%r tag takes one required argument and one optional argument' % split[0])
+ raise template.TemplateSyntaxError('%r tag takes one required ' +
+ 'argument and one optional argument' % split[0])
class AutoPaginateNode(template.Node):
"""
tag. If you choose not to use *{% paginate %}*, make sure to display the
list of available pages, or else the application may seem to be buggy.
"""
- def __init__(self, queryset_var, paginate_by=DEFAULT_PAGINATION, orphans=DEFAULT_ORPHANS):
+ def __init__(self, queryset_var, multiple_paginations, paginate_by=DEFAULT_PAGINATION,
+ orphans=DEFAULT_ORPHANS, context_var=None):
self.queryset_var = template.Variable(queryset_var)
- self.paginate_by = paginate_by
+ if isinstance(paginate_by, int):
+ self.paginate_by = paginate_by
+ else:
+ self.paginate_by = template.Variable(paginate_by)
self.orphans = orphans
+ self.context_var = context_var
+ self.multiple_paginations = multiple_paginations
def render(self, context):
+ if self.multiple_paginations or context.has_key('paginator'):
+ page_suffix = '_%s' % self.queryset_var
+ else:
+ page_suffix = ''
+
key = self.queryset_var.var
value = self.queryset_var.resolve(context)
- paginator = Paginator(value, self.paginate_by, self.orphans)
+ if isinstance(self.paginate_by, int):
+ paginate_by = self.paginate_by
+ else:
+ paginate_by = self.paginate_by.resolve(context)
+ paginator = Paginator(value, paginate_by, self.orphans)
try:
- page_obj = paginator.page(context['request'].page)
+ page_obj = paginator.page(context['request'].page(page_suffix))
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''
- context[key] = page_obj.object_list
+ if self.context_var is not None:
+ context[self.context_var] = page_obj.object_list
+ else:
+ context[key] = page_obj.object_list
context['paginator'] = paginator
context['page_obj'] = page_obj
+ context['page_suffix'] = page_suffix
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
A dictionary of all of the **GET** parameters in the current request.
This is useful to maintain certain types of state, even when requesting
a different page.
- """
+
+ ``pagination_template``
+ A custom template to include in place of the default ``pagination.html``
+ contents.
+
+ """
try:
paginator = context['paginator']
page_obj = context['page_obj']
+ page_suffix = context.get('page_suffix', '')
page_range = paginator.page_range
+ pagination_template = context.get('pagination_template', 'pagination/default.html')
+ # 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])
# If there's no overlap between the first set of pages and the current
# set of pages, then there's a possible need for elusion.
if len(first.intersection(current)) == 0:
- first_list = sorted(first)
- second_list = sorted(current)
+ first_list = list(first)
+ first_list.sort()
+ second_list = list(current)
+ second_list.sort()
pages.extend(first_list)
diff = second_list[0] - first_list[-1]
# If there is a gap of two, between the last page of the first
pages.append(None)
pages.extend(second_list)
else:
- pages.extend(sorted(first.union(current)))
+ unioned = list(first.union(current))
+ unioned.sort()
+ pages.extend(unioned)
# If there's no overlap between the current set of pages and the last
# set of pages, then there's a possible need for elusion.
if len(current.intersection(last)) == 0:
- second_list = sorted(last)
+ second_list = list(last)
+ second_list.sort()
diff = second_list[0] - pages[-1]
# If there is a gap of two, between the last page of the current
# set and the first page of the last set, then we're missing a
pages.append(None)
pages.extend(second_list)
else:
- pages.extend(sorted(last.difference(current)))
+ differenced = list(last.difference(current))
+ 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,
+ 'page_suffix': page_suffix,
+ '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,
+ 'pagination_template': pagination_template,
}
if 'request' in context:
getvars = context['request'].GET.copy()
- if 'page' in getvars:
- del getvars['page']
+ if 'page%s' % page_suffix in getvars:
+ del getvars['page%s' % page_suffix]
if len(getvars.keys()) > 0:
to_return['getvars'] = "&%s" % getvars.urlencode()
else:
to_return['getvars'] = ''
return to_return
- except KeyError:
+ 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)
fnp / django-pagination.git / blobdiff