1 # Copyright (c) 2008, Eric Florenzano
2 # Copyright (c) 2010, 2011 Linaro Limited
5 # Redistribution and use in source and binary forms, with or without
6 # modification, are permitted provided that the following conditions are
9 # * Redistributions of source code must retain the above copyright
10 # notice, this list of conditions and the following disclaimer.
11 # * Redistributions in binary form must reproduce the above
12 # copyright notice, this list of conditions and the following
13 # disclaimer in the documentation and/or other materials provided
14 # with the distribution.
15 # * Neither the name of the author nor the names of other
16 # contributors may be used to endorse or promote products derived
17 # from this software without specific prior written permission.
19 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 from django.conf import settings
33 from django.core.exceptions import ImproperlyConfigured
34 from django.core.paginator import Paginator, InvalidPage
35 from django.http import Http404
36 from django.template import (
45 from django.template.base import TokenType
46 TOKEN_BLOCK = TokenType.BLOCK
48 from django.template.loader import select_template
49 from django.utils.text import unescape_string_literal
51 # TODO, import this normally later on
52 from fnp_django_pagination.settings import *
55 def do_autopaginate(parser, token):
57 Splits the arguments to the autopaginate tag and formats them correctly.
61 autopaginate QUERYSET [PAGINATE_BY] [ORPHANS] [as NAME]
63 # Check whether there are any other autopaginations are later in this template
64 expr = lambda obj: (obj.token_type == TOKEN_BLOCK and \
65 len(obj.split_contents()) > 0 and obj.split_contents()[0] == "autopaginate")
66 multiple_paginations = len([tok for tok in parser.tokens if expr(tok)]) > 0
68 i = iter(token.split_contents())
76 assert word == "autopaginate"
77 queryset_var = next(i)
82 paginate_by = int(paginate_by)
89 orphans = int(orphans)
97 if queryset_var is None:
98 raise TemplateSyntaxError(
99 "Invalid syntax. Proper usage of this tag is: "
100 "{% autopaginate QUERYSET [PAGINATE_BY] [ORPHANS]"
101 " [as CONTEXT_VAR_NAME] %}")
102 return AutoPaginateNode(queryset_var, multiple_paginations, paginate_by, orphans, context_var)
105 class AutoPaginateNode(Node):
107 Emits the required objects to allow for Digg-style pagination.
109 First, it looks in the current context for the variable specified, and using
110 that object, it emits a simple ``Paginator`` and the current page object
111 into the context names ``paginator`` and ``page_obj``, respectively.
113 It will then replace the variable specified with only the objects for the
118 It is recommended to use *{% paginate %}* after using the autopaginate
119 tag. If you choose not to use *{% paginate %}*, make sure to display the
120 list of available pages, or else the application may seem to be buggy.
122 def __init__(self, queryset_var, multiple_paginations, paginate_by=None,
123 orphans=None, context_var=None):
124 if paginate_by is None:
125 paginate_by = DEFAULT_PAGINATION
127 orphans = DEFAULT_ORPHANS
128 self.queryset_var = Variable(queryset_var)
129 if isinstance(paginate_by, int):
130 self.paginate_by = paginate_by
132 self.paginate_by = Variable(paginate_by)
133 if isinstance(orphans, int):
134 self.orphans = orphans
136 self.orphans = Variable(orphans)
137 self.context_var = context_var
138 self.multiple_paginations = multiple_paginations
140 def render(self, context):
141 # Save multiple_paginations state in context
142 if self.multiple_paginations and 'multiple_paginations' not in context:
143 context['multiple_paginations'] = True
145 if context.get('page_suffix'):
146 page_suffix = context['page_suffix']
147 elif context.get('multiple_paginations') or getattr(context, "paginator", None):
148 page_suffix = '_%s' % self.queryset_var
152 key = self.queryset_var.var
153 value = self.queryset_var.resolve(context)
154 if isinstance(self.paginate_by, int):
155 paginate_by = self.paginate_by
157 paginate_by = self.paginate_by.resolve(context)
158 if isinstance(self.orphans, int):
159 orphans = self.orphans
161 orphans = self.orphans.resolve(context)
162 paginator = Paginator(value, paginate_by, orphans)
164 request = context['request']
166 raise ImproperlyConfigured(
167 "You need to enable 'django.core.context_processors.request'."
168 " See linaro-django-pagination/README file for TEMPLATE_CONTEXT_PROCESSORS details")
170 page_obj = paginator.page(request.page(page_suffix))
172 if INVALID_PAGE_RAISES_404:
173 raise Http404('Invalid page requested. If DEBUG were set to ' +
174 'False, an HTTP 404 page would have been shown instead.')
176 context['invalid_page'] = True
178 if self.context_var is not None:
179 context[self.context_var] = page_obj.object_list
181 context[key] = page_obj.object_list
182 context['paginator'] = paginator
183 context['page_obj'] = page_obj
184 context['page_suffix'] = page_suffix
188 class PaginateNode(Node):
190 def __init__(self, template=None, window=None, margin=None):
191 self.template = template
195 def render(self, context):
196 template_list = ['pagination/pagination.html']
197 new_context = paginate(context, window=self.window, margin=self.margin)
199 template_list.insert(0, self.template)
200 return loader.render_to_string(template_list, new_context)
203 def do_paginate(parser, token):
205 Emits the pagination control for the most recent autopaginate list
209 paginate [using "TEMPLATE"] [window N] [margin N]
211 Where TEMPLATE is a quoted template name. If missing the default template
212 is used (paginate/pagination.html).
214 argv = token.split_contents()
217 window=DEFAULT_WINDOW
218 margin=DEFAULT_MARGIN
221 if argv[i] == 'using':
222 template = unescape_string_literal(argv[i + 1])
224 elif argv[i] == 'window':
227 elif argv[i] == 'margin':
231 raise TemplateSyntaxError(
232 "Invalid syntax. Proper usage of this tag is: "
233 "{% paginate [using \"TEMPLATE\"] %}")
234 return PaginateNode(template, window, margin)
237 def paginate(context, window=DEFAULT_WINDOW, margin=DEFAULT_MARGIN):
239 Renders the ``pagination/pagination.html`` template, resulting in a
240 Digg-like display of the available pages, given the current page. If there
241 are too many pages to be displayed before and after the current page, then
242 elipses will be used to indicate the undisplayed gap between page numbers.
244 Requires one argument, ``context``, which should be a dictionary-like data
245 structure and must contain the following keys:
248 A ``Paginator`` or ``QuerySetPaginator`` object.
251 This should be the result of calling the page method on the
252 aforementioned ``Paginator`` or ``QuerySetPaginator`` object, given
255 This same ``context`` dictionary-like data structure may also include:
258 A dictionary of all of the **GET** parameters in the current request.
259 This is useful to maintain certain types of state, even when requesting
262 Argument ``window`` is number to pages before/after current page. If window
263 exceeds pagination border (1 and end), window is moved to left or right.
265 Argument ``margin``` is number of pages on start/end of pagination.
267 window=2, margin=1, current=6 1 ... 4 5 [6] 7 8 ... 11
268 window=2, margin=0, current=1 [1] 2 3 4 5 ...
269 window=2, margin=0, current=5 ... 3 4 [5] 6 7 ...
270 window=2, margin=0, current=11 ... 7 8 9 10 [11]
276 window = Variable(window).resolve(context)
280 margin = Variable(margin).resolve(context)
283 raise ValueError('Parameter "window" cannot be less than zero')
285 raise ValueError('Parameter "margin" cannot be less than zero')
287 paginator = context['paginator']
288 page_obj = context['page_obj']
289 page_suffix = context.get('page_suffix', '')
290 page_range = list(paginator.page_range)
291 # Calculate the record range in the current page for display.
292 records = {'first': 1 + (page_obj.number - 1) * paginator.per_page}
293 records['last'] = records['first'] + paginator.per_page - 1
294 if records['last'] + paginator.orphans >= paginator.count:
295 records['last'] = paginator.count
298 window_start = page_obj.number - window - 1
299 window_end = page_obj.number + window
301 # solve if window exceeded page range
303 window_end = window_end - window_start
305 if window_end > paginator.num_pages:
306 window_start = max(0, window_start - (window_end - paginator.num_pages))
307 window_end = paginator.num_pages
308 pages = page_range[window_start:window_end]
310 # figure margin and add elipses
313 tmp_pages = set(pages)
314 tmp_pages = tmp_pages.union(page_range[:margin])
315 tmp_pages = tmp_pages.union(page_range[-margin:])
316 tmp_pages = list(tmp_pages)
319 pages.append(tmp_pages[0])
320 for i in range(1, len(tmp_pages)):
321 # figure gap size => add elipses or fill in gap
322 gap = tmp_pages[i] - tmp_pages[i - 1]
326 pages.append(tmp_pages[i] - 1)
327 pages.append(tmp_pages[i])
330 pages.insert(0, None)
331 if pages[-1] != paginator.num_pages:
335 'MEDIA_URL': settings.MEDIA_URL,
336 'STATIC_URL': getattr(settings, "STATIC_URL", None),
337 'disable_link_for_first_page': DISABLE_LINK_FOR_FIRST_PAGE,
338 'display_disabled_next_link': DISPLAY_DISABLED_NEXT_LINK,
339 'display_disabled_previous_link': DISPLAY_DISABLED_PREVIOUS_LINK,
340 'display_page_links': DISPLAY_PAGE_LINKS,
341 'is_paginated': paginator.count > paginator.per_page,
342 'next_link_decorator': NEXT_LINK_DECORATOR,
343 'page_obj': page_obj,
344 'page_suffix': page_suffix,
346 'paginator': paginator,
347 'previous_link_decorator': PREVIOUS_LINK_DECORATOR,
350 if 'request' in context:
351 getvars = context['request'].GET.copy()
352 if 'page%s' % page_suffix in getvars:
353 del getvars['page%s' % page_suffix]
354 if len(getvars.keys()) > 0:
355 new_context['getvars'] = "&%s" % getvars.urlencode()
357 new_context['getvars'] = ''
359 except (KeyError, AttributeError):
364 register.tag('paginate', do_paginate)
365 register.tag('autopaginate', do_autopaginate)