X-Git-Url: https://git.mdrn.pl/django-pagination.git/blobdiff_plain/465fb3a7654c3a1900b2692a55fa3fe64a73ddad..c8a9f4983b1e6247bbb17d69257f144fafb4e646:/linaro_django_pagination/templatetags/pagination_tags.py diff --git a/linaro_django_pagination/templatetags/pagination_tags.py b/linaro_django_pagination/templatetags/pagination_tags.py index aec6405..1da25f4 100644 --- a/linaro_django_pagination/templatetags/pagination_tags.py +++ b/linaro_django_pagination/templatetags/pagination_tags.py @@ -1,20 +1,44 @@ -try: - set -except NameError: - from sets import Set as set +# Copyright (c) 2008, Eric Florenzano +# Copyright (c) 2010, 2011 Linaro Limited +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions are +# met: +# +# * Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# * Redistributions in binary form must reproduce the above +# copyright notice, this list of conditions and the following +# disclaimer in the documentation and/or other materials provided +# with the distribution. +# * Neither the name of the author nor the names of other +# contributors may be used to endorse or promote products derived +# from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + from django import template -from django.http import Http404 -from django.core.paginator import Paginator, InvalidPage from django.conf import settings +from django.core.exceptions import ImproperlyConfigured +from django.core.paginator import Paginator, InvalidPage +from django.http import Http404 +from django.template import TOKEN_BLOCK -register = template.Library() +# TODO, import this normally later on +from linaro_django_pagination.settings import * -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) def do_autopaginate(parser, token): """ @@ -22,8 +46,13 @@ def do_autopaginate(parser, token): Syntax is: - autopaginate SOMETHING [PAGINATE_BY] [ORPHANS] [as NAME] + autopaginate QUERYSET [PAGINATE_BY] [ORPHANS] [as NAME] """ + # 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 + i = iter(token.split_contents()) paginate_by = None queryset_var = None @@ -59,7 +88,8 @@ def do_autopaginate(parser, token): "{%% autopaginate QUERYSET [PAGINATE_BY] [ORPHANS]" " [as CONTEXT_VAR_NAME] %%}" ) - return AutoPaginateNode(queryset_var, paginate_by, orphans, context_var) + return AutoPaginateNode(queryset_var, multiple_paginations, paginate_by, orphans, context_var) + class AutoPaginateNode(template.Node): """ @@ -78,8 +108,8 @@ 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=None, - orphans=None, context_var=None): + def __init__(self, queryset_var, multiple_paginations, paginate_by=None, + orphans=None, context_var=None): if paginate_by is None: paginate_by = DEFAULT_PAGINATION if orphans is None: @@ -94,8 +124,14 @@ class AutoPaginateNode(template.Node): else: self.orphans = template.Variable(orphans) self.context_var = context_var + self.multiple_paginations = multiple_paginations def render(self, context): + if self.multiple_paginations or "paginator" in context: + page_suffix = '_%s' % self.queryset_var + else: + page_suffix = '' + key = self.queryset_var.var value = self.queryset_var.resolve(context) if isinstance(self.paginate_by, int): @@ -108,7 +144,13 @@ class AutoPaginateNode(template.Node): orphans = self.orphans.resolve(context) paginator = Paginator(value, paginate_by, orphans) try: - page_obj = paginator.page(context['request'].page) + request = context['request'] + except KeyError: + raise ImproperlyConfigured( + "You need to enable 'django.core.context_processors.request'." + " See linaro-django-pagination/README file for TEMPLATE_CONTEXT_PROCESSORS details") + try: + page_obj = paginator.page(request.page(page_suffix)) except InvalidPage: if INVALID_PAGE_RAISES_404: raise Http404('Invalid page requested. If DEBUG were set to ' + @@ -122,9 +164,11 @@ class AutoPaginateNode(template.Node): 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, margin=DEFAULT_MARGIN): """ Renders the ``pagination/pagination.html`` template, resulting in a Digg-like display of the available pages, given the current page. If there @@ -148,101 +192,105 @@ def paginate(context, window=DEFAULT_WINDOW): 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/default.html`` + contents. + + Argument ``window`` is number to pages before/after current page. If window + exceeds pagination border (1 and end), window is moved to left or right. + + Argument ``margin``` is number of pages on start/end of pagination. + Example: + window=2, margin=1, current=6 1 ... 4 5 [6] 7 8 ... 11 + window=2, margin=0, current=1 [1] 2 3 4 5 ... + window=2, margin=0, current=5 ... 3 4 [5] 6 7 ... + window=2, margin=0, current=11 ... 7 8 9 10 [11] """ + + if window < 0: + raise ValueError('Parameter "window" cannot be less than zero') + if margin < 0: + raise ValueError('Parameter "margin" cannot be less than zero') 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]) - last = set(page_range[-window:]) - # Now we look around our current page, making sure that we don't wrap - # around. - current_start = page_obj.number-1-window - if current_start < 0: - current_start = 0 - current_end = page_obj.number-1+window - if current_end < 0: - current_end = 0 - current = set(page_range[current_start:current_end]) - pages = [] - # 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 = 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 - # set and the first page of the current set, then we're missing a - # page. - if diff == 2: - pages.append(second_list[0] - 1) - # If the difference is just one, then there's nothing to be done, - # as the pages need no elusion and are correct. - elif diff == 1: - pass - # Otherwise, there's a bigger gap which needs to be signaled for - # elusion, by pushing a None value to the page list. - else: - pages.append(None) - pages.extend(second_list) + + # figure window + window_start = page_obj.number - window - 1 + window_end = page_obj.number + window + + # solve if window exceeded page range + if window_start < 0: + window_end = window_end - window_start + window_start = 0 + if window_end > paginator.num_pages: + window_start = window_start - (window_end - paginator.num_pages) + window_end = paginator.num_pages + pages = page_range[window_start:window_end] + + # figure margin and add elipses + if margin > 0: + # figure margin + tmp_pages = set(pages) + tmp_pages = tmp_pages.union(page_range[:margin]) + tmp_pages = tmp_pages.union(page_range[-margin:]) + tmp_pages = list(tmp_pages) + tmp_pages.sort() + pages = [] + pages.append(tmp_pages[0]) + for i in range(1, len(tmp_pages)): + # figure gap size => add elipses or fill in gap + gap = tmp_pages[i] - tmp_pages[i - 1] + if gap >= 3: + pages.append(None) + elif gap == 2: + pages.append(tmp_pages[i] - 1) + pages.append(tmp_pages[i]) else: - 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 = 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 - # page. - if diff == 2: - pages.append(second_list[0] - 1) - # If the difference is just one, then there's nothing to be done, - # as the pages need no elusion and are correct. - elif diff == 1: - pass - # Otherwise, there's a bigger gap which needs to be signaled for - # elusion, by pushing a None value to the page list. - else: + if pages[0] != 1: + pages.insert(0, None) + if pages[-1] != paginator.num_pages: pages.append(None) - pages.extend(second_list) - else: - differenced = list(last.difference(current)) - differenced.sort() - pages.extend(differenced) + to_return = { 'MEDIA_URL': settings.MEDIA_URL, - 'pages': pages, - 'records': records, + 'STATIC_URL': getattr(settings, "STATIC_URL", None), + 'display_disabled_next_link': DISPLAY_DISABLED_NEXT_LINK, + 'display_disabled_previous_link': DISPLAY_DISABLED_PREVIOUS_LINK, + 'display_page_links': DISPLAY_PAGE_LINKS, + 'is_paginated': paginator.count > paginator.per_page, + 'next_link_decorator': NEXT_LINK_DECORATOR, 'page_obj': page_obj, + 'page_suffix': page_suffix, + 'pages': pages, + 'pagination_template': pagination_template, 'paginator': paginator, - 'is_paginated': paginator.count > paginator.per_page, + 'previous_link_decorator': PREVIOUS_LINK_DECORATOR, + 'records': records, } 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, AttributeError: + except (KeyError, AttributeError): return {} -register.inclusion_tag('pagination/pagination.html', takes_context=True)( - paginate) + +register = template.Library() +register.inclusion_tag( + 'pagination/pagination.html', takes_context=True)(paginate) register.tag('autopaginate', do_autopaginate)