Merge pull request #646 from floemker/paginator

Use an own paginator

src/wiki/core/paginator.py

@@ -0,0 +1,31 @@
+from django.core.paginator import Paginator
+
+class WikiPaginator(Paginator):
+
+    def __init__(self, *args, **kwargs):
+        """
+        :param side_pages: How many pages should be shown before and after the current page
+        """
+        self.side_pages = kwargs.pop('side_pages', 4)
+        super(WikiPaginator, self).__init__(*args, **kwargs)
+
+    def page(self, number):
+        # Save last accessed page number for context-based lookup in page_range
+        self.last_accessed_page_number = number
+        return super(WikiPaginator, self).page(number)
+
+    @property
+    def page_range(self):
+        left = max(self.last_accessed_page_number - self.side_pages, 2)
+        right = min(self.last_accessed_page_number + self.side_pages+1, self.num_pages)
+        pages = []
+        if self.num_pages > 0:
+            pages = [1]
+        if left > 2:
+            pages += [0]
+        pages += range(left, right)
+        if right < self.num_pages:
+            pages += [0]
+        if self.num_pages > 1:
+            pages += [self.num_pages]
+        return pages

src/wiki/plugins/attachments/views.py

@@ -12,6 +12,7 @@
 from django.views.generic.edit import FormView
 from django.views.generic.list import ListView
 from wiki.core.http import send_file
+from wiki.core.paginator import WikiPaginator
 from wiki.decorators import get_article, response_forbidden
 from wiki.plugins.attachments import forms, models, settings
 from wiki.views.mixins import ArticleMixin
@@ -440,6 +441,7 @@ class AttachmentSearchView(ArticleMixin, ListView):
     template_name = "wiki/plugins/attachments/search.html"
     allow_empty = True
     context_object_name = 'attachments'
+    paginator_class = WikiPaginator
     paginate_by = 10
 
     @method_decorator(get_article(can_write=True))

src/wiki/plugins/globalhistory/views.py

@@ -1,15 +1,17 @@
 from __future__ import absolute_import, unicode_literals
 
-from django.db.models import F
 from django.contrib.auth.decorators import login_required
+from django.db.models import F
 from django.utils.decorators import method_decorator
 from django.views.generic import ListView
 from wiki import models
+from wiki.core.paginator import WikiPaginator
 
 
 class GlobalHistory(ListView):
 
     template_name = 'wiki/plugins/globalhistory/globalhistory.html'
+    paginator_class = WikiPaginator
     paginate_by = 30
     model = models.ArticleRevision
     context_object_name = 'revisions'

src/wiki/plugins/images/views.py

@@ -11,6 +11,7 @@
 from django.views.generic.edit import FormView
 from django.views.generic.list import ListView
 from wiki.conf import settings as wiki_settings
+from wiki.core.paginator import WikiPaginator
 from wiki.decorators import get_article
 from wiki.models.pluginbase import RevisionPluginRevision
 from wiki.plugins.images import forms, models
@@ -24,6 +25,7 @@ class ImageView(ArticleMixin, ListView):
     template_name = 'wiki/plugins/images/index.html'
     allow_empty = True
     context_object_name = 'images'
+    paginator_class = WikiPaginator
     paginate_by = 10
 
     @method_decorator(get_article(can_read=True, not_locked=True))

src/wiki/templates/wiki/includes/pagination.html

@@ -1,8 +1,24 @@
 {% load i18n %}
 {% if is_paginated %}
 <ul class="pagination">
+    {% if page_obj.has_previous %}
+        <li><a class="prev btn btn-info" href="?{% if search_query %}q={{ search_query  }}&{% endif %}page={{ page_obj.previous_page_number }}{% if appended_key %}&{{ appended_key }}={{ appended_value }}{% endif %}">&laquo;</a></li>
+    {% else %}
+        <li class="disabled"><span>&laquo;</span></li>
+    {% endif %}
+
     {% for pc in paginator.page_range %}
-    <li class="{% if pc == page_obj.number %} active{% endif %}"><a href="?{% if search_query %}q={{ search_query  }}&{% endif %}page={{ pc }}{% if appended_key %}&{{ appended_key }}={{ appended_value }}{% endif %}">{{ pc }}</a></li>
+        {% if pc == 0 %}
+            <li class="disabled"><span>...</span></li>
+        {% else %}
+            <li class="{% if pc == page_obj.number %} active{% endif %}"><a href="?{% if search_query %}q={{ search_query  }}&{% endif %}page={{ pc }}{% if appended_key %}&{{ appended_key }}={{ appended_value }}{% endif %}">{{ pc }}</a></li>
+        {% endif %}
     {% endfor %}
+
+    {% if page_obj.has_next %}
+        <li><a class="next btn btn-info" href="?{% if search_query %}q={{ search_query  }}&{% endif %}page={{ page_obj.next_page_number }}{% if appended_key %}&{{ appended_key }}={{ appended_value }}{% endif %}">&raquo;</a></li>
+    {% else %}
+        <li class="disabled"><span>&raquo;</span></li>
+    {% endif %}
 </ul>
 {% endif %}

src/wiki/views/article.py

@@ -22,12 +22,12 @@
 from wiki.core.compat import atomic, transaction_commit_on_success, urljoin
 from wiki.core.diff import simple_merge
 from wiki.core.exceptions import NoRootURL
+from wiki.core.paginator import WikiPaginator
 from wiki.core.plugins import registry as plugin_registry
 from wiki.core.utils import object_to_json_response
 from wiki.decorators import get_article
 from wiki.views.mixins import ArticleMixin
 
-
 log = logging.getLogger(__name__)
 
 
@@ -608,6 +608,7 @@ class History(ListView, ArticleMixin):
     template_name = "wiki/history.html"
     allow_empty = True
     context_object_name = 'revisions'
+    paginator_class = WikiPaginator
     paginate_by = 10
 
     def get_queryset(self):
@@ -634,6 +635,7 @@ class Dir(ListView, ArticleMixin):
     allow_empty = True
     context_object_name = 'directory'
     model = models.URLPath
+    paginator_class = WikiPaginator
     paginate_by = 30
 
     @method_decorator(get_article(can_read=True))
@@ -678,6 +680,7 @@ def get_context_data(self, **kwargs):
 class SearchView(ListView):
 
     template_name = "wiki/search.html"
+    paginator_class = WikiPaginator
     paginate_by = 25
     context_object_name = "articles"
 

tests/core/test_paginator.py

@@ -0,0 +1,39 @@
+from django.test import TestCase
+from wiki.core.paginator import WikiPaginator
+
+
+class PaginatorTest(TestCase):
+    """
+    Test the WikiPaginator and it's page_range() function
+    """
+
+    def test_paginator(self):
+        objects = [1]
+        p = WikiPaginator(objects, 2, side_pages=2)
+        self.assertEqual(p.num_pages, 1)
+
+        p.page(1)
+        self.assertEqual(p.page_range, [1])
+
+        objects = [1, 2, 3, 4, 5, 6, 7, 8, 9]
+        p = WikiPaginator(objects, 2, side_pages=2)
+        self.assertEqual(p.num_pages, 5)
+
+        p.page(1)
+        self.assertEqual(p.page_range, [1, 2, 3, 0, 5])
+
+        p.page(3)
+        self.assertEqual(p.page_range, [1, 2, 3, 4, 5])
+
+        objects = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17]
+        p = WikiPaginator(objects, 2, side_pages=2)
+        self.assertEqual(p.num_pages, 9)
+
+        p.page(1)
+        self.assertEqual(p.page_range, [1, 2, 3, 0, 9])
+
+        p.page(5)
+        self.assertEqual(p.page_range, [1, 0, 3, 4, 5, 6, 7, 0, 9])
+
+        p.page(8)
+        self.assertEqual(p.page_range, [1, 0, 6, 7, 8, 9])