Made the paginate tag a normal tag with an optional argument, template, to override...
[django-pagination.git] / pagination / templatetags / pagination_tags.py
index 3442fcd..d7f1884 100644 (file)
@@ -2,15 +2,21 @@ try:
     set
 except NameError:
     from sets import Set as set
+
 from django import template
+from django.http import Http404
 from django.core.paginator import Paginator, InvalidPage
 from django.conf import settings
+from django.template.loader import select_template
+from django.template import Context
 
 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)
 
 def do_autopaginate(parser, token):
     """
@@ -27,8 +33,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:
@@ -40,11 +46,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):
@@ -85,6 +92,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''
@@ -95,8 +105,49 @@ class AutoPaginateNode(template.Node):
         context['paginator'] = paginator
         context['page_obj'] = page_obj
         return u''
+        
+
+class PaginateNode(template.Node):
 
-def paginate(context, window=DEFAULT_WINDOW):
+    def __init__(self, template=None):
+        self.template = template
+        
+    def render(self, context):
+        template_list = ['pagination/pagination.html']
+        to_return = paginate(context)
+        
+        if self.template:
+            template_list.insert(0, self.template)
+            
+        t = select_template(template_list)
+        if not t: 
+            return None
+        context = Context(to_return)
+        return t.render(context)
+        
+
+def do_paginate(parser, token):
+    """
+    {% paginate [using] [template] %}
+    
+    {% paginate %}
+    {% paginate using paginations/custom_pagination.html %}
+    """
+    argv = token.contents.split()
+    argc = len(argv)
+    
+    if argc > 3:
+        raise template.TemplateSyntaxError, "Tag %s takes at most 2 argument." % argv[0]
+    
+    if argc == 1:
+        return PaginateNode()
+    if argc == 3 and argv[1] == 'using':
+        return PaginateNode(template=argv[2])
+        
+    raise template.TemplateSyntaxError, "Tag %s is invalid. Please check the syntax" % argv[0]
+    
+
+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
@@ -125,6 +176,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])
@@ -191,12 +247,16 @@ 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,
         }
         if 'request' in context:
+            to_return['request'] = context['request']
             getvars = context['request'].GET.copy()
             if 'page' in getvars:
                 del getvars['page']
@@ -205,7 +265,10 @@ def paginate(context, window=DEFAULT_WINDOW):
             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.inclusion_tag('pagination/pagination.html', takes_context=True)(
+#    paginate)
+register.tag('paginate', do_paginate)
 register.tag('autopaginate', do_autopaginate)