From ae85ed0f971147ce7cee9ce02b498f909d21ce79 Mon Sep 17 00:00:00 2001 From: Bernhard Keller Date: Wed, 18 May 2011 17:32:49 +0200 Subject: added Pagination class, usage description in Pagination,__call__ added pagination.html, object_gallery.html as templates --- mediagoblin/util.py | 86 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 86 insertions(+) (limited to 'mediagoblin/util.py') diff --git a/mediagoblin/util.py b/mediagoblin/util.py index a66e2ba5..0f28dd79 100644 --- a/mediagoblin/util.py +++ b/mediagoblin/util.py @@ -26,6 +26,10 @@ import translitcodec from mediagoblin import globals as mgoblin_globals +import urllib +from pymongo import ASCENDING, DESCENDING +from math import ceil + TESTS_ENABLED = False def _activate_testing(): @@ -290,3 +294,85 @@ def setup_gettext(locale): mgoblin_globals.setup_globals( translations=this_gettext) + + +class Pagination(object): + """ + Pagination class + """ + def __init__(self): + pass + + def __call__(self, args): + """ + input values: + {'page': ..., --- requested page + 'per_page': ..., --- objects per page + 'request': ..., --- webob request object for url generation + 'collection' ... --- db collection, thats to be queried + 'query': {'user': xxx}, query restrictions, db.collection.find(query) + } + + add: + option for sorting attribute + ascending, descending option + range based pagination + """ + self.per_page = args['per_page'] + self.request = args['request'] + + try: + self.page = abs(int(args['request'].str_GET['page'])) + # set default page, if page value is not set + except KeyError: + self.page = 1 + # return None(404 Error) if page is set, but has no value or has an invalid value + except ValueError: + return None + + ###################################################### + # + # db queries should be changed into range based pagination + # save count and current page in some user session data + # + ###################################################### + + collection = getattr(self.request.db, args['collection']) + + self.total_count = collection.find(args['query']).count() + + #check if requested page is valid, not larger than available number of pages + if self.page > self.pages: + return None + + return collection.find(args['query']).sort('created',DESCENDING) \ + .skip((self.page-1)*self.per_page).limit(self.per_page) + + @property + def pages(self): + return int(ceil(self.total_count / float(self.per_page))) + + @property + def has_prev(self): + return self.page > 1 + + @property + def has_next(self): + return self.page < self.pages + + def iter_pages(self, left_edge=2, left_current=2, + right_current=5, right_edge=2): + last = 0 + for num in xrange(1, self.pages + 1): + if num <= left_edge or \ + (num > self.page - left_current - 1 and \ + num < self.page + right_current) or \ + num > self.pages - right_edge: + if last + 1 != num: + yield None + yield num + last = num + + def url_generator(self, page): + return '%s?%s' % (self.request.path_info, \ + urllib.urlencode({'page':str(page)})) -- cgit v1.2.3 From ca3ca51c5a1fa4c10b88c851c9bd04ae7978cb41 Mon Sep 17 00:00:00 2001 From: Bernhard Keller Date: Thu, 19 May 2011 17:24:31 +0200 Subject: changed some coding styles and changed the interface for pagination from __call__ to the __init__, also getting a cursor as input, instead of the query details --- mediagoblin/util.py | 56 +++++++++++------------------------------------------ 1 file changed, 11 insertions(+), 45 deletions(-) (limited to 'mediagoblin/util.py') diff --git a/mediagoblin/util.py b/mediagoblin/util.py index 0f28dd79..b79d6b05 100644 --- a/mediagoblin/util.py +++ b/mediagoblin/util.py @@ -27,7 +27,6 @@ import translitcodec from mediagoblin import globals as mgoblin_globals import urllib -from pymongo import ASCENDING, DESCENDING from math import ceil @@ -300,53 +299,20 @@ class Pagination(object): """ Pagination class """ - def __init__(self): - pass - - def __call__(self, args): - """ - input values: - {'page': ..., --- requested page - 'per_page': ..., --- objects per page - 'request': ..., --- webob request object for url generation - 'collection' ... --- db collection, thats to be queried - 'query': {'user': xxx}, query restrictions, db.collection.find(query) - } - - add: - option for sorting attribute - ascending, descending option - range based pagination - """ - self.per_page = args['per_page'] - self.request = args['request'] - + def __init__(self, per_page, cursor, request): try: - self.page = abs(int(args['request'].str_GET['page'])) - # set default page, if page value is not set + self.page = int(request.str_GET['page']) except KeyError: self.page = 1 - # return None(404 Error) if page is set, but has no value or has an invalid value - except ValueError: - return None - - ###################################################### - # - # db queries should be changed into range based pagination - # save count and current page in some user session data - # - ###################################################### - - collection = getattr(self.request.db, args['collection']) - - self.total_count = collection.find(args['query']).count() - - #check if requested page is valid, not larger than available number of pages - if self.page > self.pages: - return None - - return collection.find(args['query']).sort('created',DESCENDING) \ - .skip((self.page-1)*self.per_page).limit(self.per_page) + + self.per_page = per_page + self.cursor = cursor + self.request = request + self.total_count = self.cursor.count() + + def __call__(self): + return self.cursor.skip((self.page-1)*self.per_page) \ + .limit(self.per_page) @property def pages(self): -- cgit v1.2.3 From 44e3e917fbfc89409bac08d500c5a9246e0dc5f4 Mon Sep 17 00:00:00 2001 From: Bernhard Keller Date: Thu, 19 May 2011 20:37:04 +0200 Subject: removed request arg from Pagination class added get_page_url() in Pagination class, to generate proper urls without losing other get arguments --- mediagoblin/util.py | 38 ++++++++++++++++++++++++++------------ 1 file changed, 26 insertions(+), 12 deletions(-) (limited to 'mediagoblin/util.py') diff --git a/mediagoblin/util.py b/mediagoblin/util.py index b79d6b05..9247ac19 100644 --- a/mediagoblin/util.py +++ b/mediagoblin/util.py @@ -28,7 +28,7 @@ from mediagoblin import globals as mgoblin_globals import urllib from math import ceil - +import copy TESTS_ENABLED = False def _activate_testing(): @@ -297,20 +297,27 @@ def setup_gettext(locale): class Pagination(object): """ - Pagination class + Pagination class, + initialization through __init__(self, page=1, per_page=2, cursor) + get actual data slice through __call__() """ - def __init__(self, per_page, cursor, request): - try: - self.page = int(request.str_GET['page']) - except KeyError: - self.page = 1 + def __init__(self, cursor, page=1, per_page=2): + """ + initializes Pagination + -- page, requested page + -- per_page, number of objects per page + -- cursor, db cursor + """ + self.page = page self.per_page = per_page self.cursor = cursor - self.request = request self.total_count = self.cursor.count() def __call__(self): + """ + returns slice of objects for the requested page + """ return self.cursor.skip((self.page-1)*self.per_page) \ .limit(self.per_page) @@ -338,7 +345,14 @@ class Pagination(object): yield None yield num last = num - - def url_generator(self, page): - return '%s?%s' % (self.request.path_info, \ - urllib.urlencode({'page':str(page)})) + + def get_page_url(self, path_info, page_no, get_params=None): + """ + Get a new page based of the path_info, the new page number, + and existing get parameters. + """ + new_get_params = copy.copy(get_params or {}) + new_get_params['page'] = page_no + return "%s?%s" % ( + path_info, urllib.urlencode(new_get_params)) + -- cgit v1.2.3 From 3eb6fc4f2f2b0a41677ab88bdd941b79e3e87b39 Mon Sep 17 00:00:00 2001 From: Bernhard Keller Date: Thu, 19 May 2011 22:52:18 +0200 Subject: moved check for correct page values into decorator for view function --- mediagoblin/util.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'mediagoblin/util.py') diff --git a/mediagoblin/util.py b/mediagoblin/util.py index 9247ac19..5f5c59fb 100644 --- a/mediagoblin/util.py +++ b/mediagoblin/util.py @@ -29,6 +29,8 @@ from mediagoblin import globals as mgoblin_globals import urllib from math import ceil import copy +import decorators +from webob import exc TESTS_ENABLED = False def _activate_testing(): @@ -298,11 +300,11 @@ def setup_gettext(locale): class Pagination(object): """ Pagination class, - initialization through __init__(self, page=1, per_page=2, cursor) + initialization through __init__(self, cursor, page=1, per_page=2): get actual data slice through __call__() """ - def __init__(self, cursor, page=1, per_page=2): + def __init__(self, page, cursor, per_page=2): """ initializes Pagination -- page, requested page -- cgit v1.2.3