adding middleware that handles custom pages

[osqa.git] / forum / utils / pagination.py

diff --git a/forum/utils/pagination.py b/forum/utils/pagination.py
index 684992ca3cb595cdab385912bd59a4a0a33cb7a3..d605d5f0788b4a43f67537a0414c45d8d8e8f3c5 100644 (file)
--- a/forum/utils/pagination.py
+++ b/forum/utils/pagination.py
@@ -3,20 +3,42 @@ from django.utils.datastructures import SortedDict
 from django import template
 from django.core.paginator import Paginator, EmptyPage
 from django.utils.translation import ugettext as _
 from django import template
 from django.core.paginator import Paginator, EmptyPage
 from django.utils.translation import ugettext as _

+from django.utils.html import escape

 from django.http import Http404
 from django.http import Http404

-from django.utils.safestring import mark_safe
+from django.utils.encoding import smart_unicode

 from django.utils.http import urlquote
 from django.utils.http import urlquote

+from django.utils.safestring import mark_safe
+from django.utils.html import strip_tags, escape
+from forum.utils.html import sanitize_html

 import logging
 
 import logging
 

-class SimpleSort(object):
-    def __init__(self, label, order_by, description=''):
+def generate_uri(querydict, exclude=None):
+    all = []
+
+    for k, l in querydict.iterlists():
+        if (not exclude) or (not k in exclude):
+            all += ["%s=%s" % (k, escape(strip_tags(v))) for v in l]
+        
+    return "&".join(all)
+
+class SortBase(object):
+    def __init__(self, label, description=''):

         self.label = label
         self.description = description
         self.label = label
         self.description = description

+
+class SimpleSort(SortBase):
+    def __init__(self, label, order_by, description=''):
+        super(SimpleSort, self) .__init__(label, description)

         self.order_by = order_by
 
         self.order_by = order_by
 

+    def _get_order_by(self):
+        return isinstance(self.order_by, (list, tuple)) and self.order_by or [self.order_by]
+

     def apply(self, objects):
     def apply(self, objects):

-        return objects.order_by(self.order_by)
+        if self.order_by:
+            return objects.order_by(*self._get_order_by())

 
 

+        return objects

 
 class PaginatorContext(object):
     visible_page_range = 5
 
 class PaginatorContext(object):
     visible_page_range = 5


@@ -24,7 +46,8 @@ class PaginatorContext(object):
 
     base_path = None
 
 
     base_path = None
 

-    def __init__(self, id, sort_methods=None, default_sort=None, pagesizes=None, default_pagesize=None):
+    def __init__(self, id, sort_methods=None, default_sort=None, force_sort = None,
+                 pagesizes=None, default_pagesize=None, prefix=''):

         self.id = id
         if sort_methods:
             self.has_sort = True
         self.id = id
         if sort_methods:
             self.has_sort = True


@@ -49,65 +72,123 @@ class PaginatorContext(object):
         else:
             self.has_pagesize = False
 
         else:
             self.has_pagesize = False
 

+        self.force_sort = force_sort
+        self.prefix = prefix

 
 

+    def preferences(self, request):
+        if request.user.is_authenticated():
+            if request.user.prop.pagination:
+                preferences = request.user.prop.pagination.get(self.id, {})
+            else:
+                preferences = {}
+        else:
+            preferences = request.session.get('paginator_%s%s' % (self.prefix, self.id), {})

 
 

-class labels(object):
-    PAGESIZE = _('pagesize')
-    PAGE = _('page')
-    SORT = _('sort')
+        return preferences
+
+    def set_preferences(self, request, preferences):
+        if request.user.is_authenticated():
+            all_preferences = request.user.prop.pagination or {}
+            all_preferences[self.id] = preferences
+            request.user.prop.pagination = all_preferences
+        else:
+            request.session['paginator_%s%s' % (self.prefix, self.id)] = preferences
+
+    def pagesize(self, request, session_prefs=None):
+        if not session_prefs:
+            session_prefs = self.preferences(request)

 
 

-page_numbers_template = template.loader.get_template('paginator/page_numbers.html')
-page_sizes_template = template.loader.get_template('paginator/page_sizes.html')
-sort_tabs_template = template.loader.get_template('paginator/sort_tabs.html')

 
 

-def paginated(request, list_name, context, tpl_context):
-    session_prefs = request.session.get('paginator_%s' % context.id, {})
-    objects = tpl_context[list_name]
-
-    if context.has_pagesize:
-        if request.GET.get(labels.PAGESIZE, None):
-            try:
-                pagesize = int(request.GET[labels.PAGESIZE])
-            except ValueError:
-                logging.error('Found invalid page size "%s", loading %s, refered by %s' % (
-                    request.GET.get(labels.PAGESIZE, ''), request.path, request.META.get('HTTP_REFERER', 'UNKNOWN')
-                ))
-                raise Http404()
-
-            session_prefs[labels.PAGESIZE] = pagesize
+        if self.has_pagesize:
+            if request.GET.get(self.PAGESIZE, None):
+                try:
+                    pagesize = int(request.GET[self.PAGESIZE])
+                except ValueError:
+                    logging.error('Found invalid page size "%s", loading %s, refered by %s' % (
+                        request.GET.get(self.PAGESIZE, ''), request.path, request.META.get('HTTP_REFERER', 'UNKNOWN')
+                    ))
+                    raise Http404()
+
+                session_prefs[self.PAGESIZE] = pagesize
+            else:
+                pagesize = session_prefs.get(self.PAGESIZE, self.default_pagesize)
+
+            if not pagesize in self.pagesizes:
+                pagesize = self.default_pagesize

         else:
         else:

-            pagesize = session_prefs.get(labels.PAGESIZE, context.default_pagesize)
+            pagesize = 30

 
 

-        if not pagesize in context.pagesizes:
-            pagesize = context.default_pagesize
-    else:
-        pagesize = 30
+        return pagesize

 
 

+    def page(self, request):
+        try:
+            return int(request.GET.get(self.PAGE, "1").strip())
+        except ValueError:
+            logging.error('Found invalid page number "%s", loading %s, refered by %s' % (
+                request.GET.get(self.PAGE, ''), request.path, request.META.get('HTTP_REFERER', 'UNKNOWN')
+            ))
+            raise Http404()

 
 

+    def sort(self, request, session_prefs=None):
+        if not session_prefs:
+            session_prefs = self.preferences(request)

 
 

+        sort = None
+        sticky = request.user.is_authenticated() and request.user.prop.preferences and request.user.prop.preferences.get('sticky_sorts', False)

 
 

+        if self.has_sort:
+            if request.GET.get(self.SORT, None):
+                sort = request.GET[self.SORT]

 
 

-    try:
-        page = int(request.GET.get(labels.PAGE, 1))
-    except ValueError:
-        logging.error('Found invalid page number "%s", loading %s, refered by %s' % (
-            request.GET.get(labels.PAGE, ''), request.path, request.META.get('HTTP_REFERER', 'UNKNOWN')
-        ))
-        raise Http404()
+                if sticky:
+                    session_prefs[self.SORT] = sort
+            else:
+                sort = self.force_sort or (sticky and session_prefs.get(self.SORT, None)) or self.default_sort

 
 

-    sort = None
-    if context.has_sort:
-        if request.GET.get(labels.SORT, None):
-            sort = request.GET[labels.SORT]
-            if session_prefs.get('sticky_sort', False):
-                session_prefs[labels.SORT] = sort
-        else:
-            sort = session_prefs.get(labels.SORT, context.default_sort)
+            if not sort in self.sort_methods:
+                sort = self.default_sort
+
+        return sort
+
+    def sorted(self, objects, request, session_prefs=None):
+        sort = self.sort(request, session_prefs)
+
+        if sort:
+            objects = self.sort_methods[sort].apply(objects)
+
+        return sort, objects
+
+    @property
+    def PAGESIZE(self):
+        return self.prefix and "%s_%s" % (self.prefix, _('pagesize')) or _('pagesize')

 
 

-        if not sort in context.sort_methods:
-            sort = context.default_sort
+    @property
+    def PAGE(self):
+        return self.prefix and "%s_%s" % (self.prefix, _('page')) or _('page')

 
 

-        objects = context.sort_methods[sort].apply(objects)
+    @property
+    def SORT(self):
+        return self.prefix and "%s_%s" % (self.prefix, _('sort')) or _('sort')
+
+page_numbers_template = template.loader.get_template('paginator/page_numbers.html')
+page_sizes_template = template.loader.get_template('paginator/page_sizes.html')
+sort_tabs_template = template.loader.get_template('paginator/sort_tabs.html')
+
+def paginated(request, paginators, tpl_context):
+    if len(paginators) == 2 and isinstance(paginators[0], basestring):
+        paginators = (paginators,)
+
+    for list_name, context in paginators:
+        tpl_context[list_name] = _paginated(request, tpl_context[list_name], context)
+
+    return tpl_context
+
+def _paginated(request, objects, context):
+    session_prefs = context.preferences(request)
+
+    pagesize = context.pagesize(request, session_prefs)
+    page = context.page(request)
+    sort, objects = context.sorted(objects, request, session_prefs)

 
     paginator = Paginator(objects, pagesize)
 
 
     paginator = Paginator(objects, pagesize)
 


@@ -115,7 +196,7 @@ def paginated(request, list_name, context, tpl_context):
         page_obj = paginator.page(page)
     except EmptyPage:
         logging.error('Found invalid page number "%s", loading %s, refered by %s' % (
         page_obj = paginator.page(page)
     except EmptyPage:
         logging.error('Found invalid page number "%s", loading %s, refered by %s' % (

-            request.GET.get(labels.PAGE, ''), request.path, request.META.get('HTTP_REFERER', 'UNKNOWN')
+            request.GET.get(context.PAGE, ''), request.path, request.META.get('HTTP_REFERER', 'UNKNOWN')

         ))
         raise Http404()
 
         ))
         raise Http404()
 


@@ -123,21 +204,21 @@ def paginated(request, list_name, context, tpl_context):
         base_path = context.base_path
     else:
         base_path = request.path
         base_path = context.base_path
     else:
         base_path = request.path

-        get_params = ["%s=%s" % (k, v) for k, v in request.GET.items() if not k in (labels.PAGE, labels.PAGESIZE, labels.SORT)]
+        get_params = generate_uri(request.GET, (context.PAGE, context.PAGESIZE, context.SORT))

 
         if get_params:
 
         if get_params:

-            base_path += "?" + "&".join(get_params)
+            base_path += "?" + get_params

 
 

-    url_joiner = "?" in base_path and "&" or "?"
+    url_joiner = "?" in base_path and "&" or "?"

 
 
     def get_page():
         object_list = page_obj.object_list
 
 
 
     def get_page():
         object_list = page_obj.object_list
 

-        if hasattr(object_list, 'lazy'):
-            return object_list.lazy()
-        return page_obj.object_list
-    objects.page = get_page
+        #if hasattr(object_list, 'lazy'):
+        #    return object_list.lazy()
+        return object_list
+    paginator.page = get_page()

 
     total_pages = paginator.num_pages
 
 
     total_pages = paginator.num_pages
 


@@ -164,9 +245,9 @@ def paginated(request, list_name, context, tpl_context):
             page_numbers = []
 
             if sort:
             page_numbers = []
 
             if sort:

-                url_builder = lambda n: mark_safe("%s%s%s=%s&%s=%s" % (base_path, url_joiner, labels.SORT, sort, labels.PAGE, n))
+                url_builder = lambda n: mark_safe("%s%s%s=%s&%s=%s" % (escape(base_path), url_joiner, context.SORT, sort, context.PAGE, n))

             else:
             else:

-                url_builder = lambda n: mark_safe("%s%s%s=%s" % (base_path, url_joiner, labels.PAGE, n))
+                url_builder = lambda n: mark_safe("%s%s%s=%s" % (escape(base_path), url_joiner, context.PAGE, n))

 
             if range_start > (context.outside_page_range + 1):
                 page_numbers.append([(n, url_builder(n)) for n in range(1, context.outside_page_range + 1)])
 
             if range_start > (context.outside_page_range + 1):
                 page_numbers.append([(n, url_builder(n)) for n in range(1, context.outside_page_range + 1)])


@@ -190,16 +271,16 @@ def paginated(request, list_name, context, tpl_context):
                 'current': page,
                 'page_numbers': page_numbers
             }))
                 'current': page,
                 'page_numbers': page_numbers
             }))

-        objects.page_numbers = page_nums
+        paginator.page_numbers = page_nums

     else:
     else:

-        objects.page_numbers = ''
+        paginator.page_numbers = ''

 
     if pagesize:
         def page_sizes():
             if sort:
 
     if pagesize:
         def page_sizes():
             if sort:

-                url_builder = lambda s: mark_safe("%s%s%s=%s&%s=%s" % (base_path, url_joiner, labels.SORT, sort, labels.PAGESIZE, s))
+                url_builder = lambda s: mark_safe("%s%s%s=%s&%s=%s" % (escape(base_path), url_joiner, context.SORT, sort, context.PAGESIZE, s))

             else:
             else:

-                url_builder = lambda s: mark_safe("%s%s%s=%s" % (base_path, url_joiner, labels.PAGESIZE, s))
+                url_builder = lambda s: mark_safe("%s%s%s=%s" % (escape(base_path), url_joiner, context.PAGESIZE, s))

 
             sizes = [(s, url_builder(s)) for s in context.pagesizes]
 
 
             sizes = [(s, url_builder(s)) for s in context.pagesizes]
 


@@ -208,24 +289,30 @@ def paginated(request, list_name, context, tpl_context):
                 'sizes': sizes
             }))
 
                 'sizes': sizes
             }))
 

-        objects.page_sizes = page_sizes
+        paginator.page_sizes = page_sizes

     else:
     else:

-        objects.page_sizes = ''
+        paginator.page_sizes = ''

 
     if sort:
         def sort_tabs():
 
     if sort:
         def sort_tabs():

-            url_builder = lambda s: mark_safe("%s%s%s=%s" % (base_path, url_joiner, labels.SORT, s))
-            sorts = [(n, s.label, url_builder(n), s.description) for n, s in context.sort_methods.items()]
+            url_builder = lambda s: mark_safe("%s%s%s=%s" % (escape(base_path), url_joiner, context.SORT, s))
+            sorts = [(n, s.label, url_builder(n), strip_tags(s.description)) for n, s in context.sort_methods.items()]
+
+            for name, label, url, descr in sorts:
+                paginator.__dict__['%s_sort_link' % name] = smart_unicode(url)

 
             return sort_tabs_template.render(template.Context({
                 'current': sort,
                 'sorts': sorts,
                 'sticky': session_prefs.get('sticky_sort', False)
             }))
 
             return sort_tabs_template.render(template.Context({
                 'current': sort,
                 'sorts': sorts,
                 'sticky': session_prefs.get('sticky_sort', False)
             }))

-        objects.sort_tabs = sort_tabs()
+        paginator.sort_tabs = sort_tabs()
+        paginator.sort_description = mark_safe(context.sort_methods[sort].description)
+        paginator.current_sort = sort

     else:
     else:

-        objects.sort_tabs = ''
+        paginator.sort_tabs = paginator.sort_description = ''
+        paginator.current_sort = ''

 
 

-    request.session['paginator_%s' % context.id] = session_prefs
-    tpl_context[list_name] = objects
-    return tpl_context
\ No newline at end of file
+    context.set_preferences(request, session_prefs)
+    objects.paginator = paginator
+    return objects