Merge branch 'master' of git://github.com/cicuz/django-pagination
[django-pagination.git] / linaro_django_pagination / templatetags / pagination_tags.py
old mode 100644 (file)
new mode 100755 (executable)
index ab87ed4..af1be0f
@@ -4,6 +4,7 @@ except NameError:
     from sets import Set as set
 
 from django import template
+from django.template import TOKEN_BLOCK
 from django.http import Http404
 from django.core.paginator import Paginator, InvalidPage
 from django.conf import settings
@@ -15,6 +16,11 @@ 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):
     """
@@ -24,6 +30,11 @@ def do_autopaginate(parser, token):
 
         autopaginate SOMETHING [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 +70,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 +90,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 +106,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 context.has_key('paginator'):
+            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 +126,7 @@ class AutoPaginateNode(template.Node):
             orphans = self.orphans.resolve(context)
         paginator = Paginator(value, paginate_by, 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 ' +
@@ -122,10 +140,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, hashtag=''):
+def paginate(context, window=DEFAULT_WINDOW):
     """
     Renders the ``pagination/pagination.html`` template, resulting in a
     Digg-like display of the available pages, given the current page.  If there
@@ -149,11 +168,18 @@ def paginate(context, window=DEFAULT_WINDOW, hashtag=''):
         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
@@ -225,18 +251,22 @@ def paginate(context, window=DEFAULT_WINDOW, hashtag=''):
             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:
@@ -245,6 +275,8 @@ def paginate(context, window=DEFAULT_WINDOW, hashtag=''):
     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)